All Frameworks  Class Hierarchy  This Framework  Indexes   

KnowledgeInterfaces Interface CATICkeExpression

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATICkeExpression

Interface dedicated to expressions management.
An expression is a feature that describes a function to be evaluated on a set of identified objects.

It is composed of a signature and a body.

The signature details the list of objects on which it is supposed to work on. example : "(x: #In Integer, y: #Out Real) : #Void " means that the expression works on 2 abstract objects x which is an Integer and will be used as an input; and y which is a Real and that will be used as output.

The body expresses the function: example : " y=3.2*x "

An expression is created from 2 strings (signature and body). It is able to tell if they are syntaxically correct.

Expressions also implement CATICkeFunction that is in charge of evaluation on specific objects.

See also:
CATICkeRelationFactory
See also:
CATICkeFunction
See also:
CATICkeSignature
See also:
CATICkeArg
See also:
CATICkeType


Method Index


o Body()
Returns the body of this expression.
o CanBeEdited()
Indicates if an expression can be edited (Is it syntaxically correct).
o CanBeEvaluated()
Indicates if an expression can be evaluated (syntaxically correct & operators available at runtime).
o Copy()
Copy the expression.
o Replace(CATICkeExpression_var&)
Replaces an expression by another.
o SetBody(CATUnicodeString&,CATUnicodeString&)
Replaces the expression content (parse of the expression is done).
o Signature()
Returns the signature of this expression.
o ViewBody(CATListOfCATUnicodeString&)
Produces a view of the body of the expression with a change in the variable names.

Methods


o Body
public virtual Body()
Returns the body of this expression. It Shouldn't be used to produce a view of the body, it returns only the body stored in the attribute.
Returns:
: body in a text format
o CanBeEdited
public virtual CanBeEdited()
Indicates if an expression can be edited (Is it syntaxically correct).
Returns:
CATCke::Boolean : True if can be edited
o CanBeEvaluated
public virtual CanBeEvaluated()
Indicates if an expression can be evaluated (syntaxically correct & operators available at runtime).
This method may raise syntax error (CATCkeParseException). No ability to catch them in CAA.
Returns:
CATCke::Boolean : True if can be evaluated
o Copy
public virtual Copy()
Copy the expression.
Returns:
: copied expression
o Replace
public virtual Replace( const iExpression)
Replaces an expression by another.
Parameters:
iExpression
: expression that replaces
o SetBody
public virtual SetBody( const iSignature,
const iBody)
Replaces the expression content (parse of the expression is done). This method may raise syntax error (CATCkeParseException). No ability to catch them in CAA.
Parameters:
iSignature
: signature in a text format
iBody
: body in a text format
o Signature
public virtual Signature()
Returns the signature of this expression. This will provoke a partial "parse" of the expression if not done already
Returns:
CATICkeSignature_var : signature pf the expression
o ViewBody
public virtual ViewBody( const iListNames)
Produces a view of the body of the expression with a change in the variable names.
Parameters:
iListNames
: list of the names to be used
Returns:
: body view

This object is included in the file: CATICkeExpression.h
If needed, your Imakefile.mk should include the module: KnowledgeItf

Copyright © 2003, Dassault Systèmes. All rights reserved.