All Frameworks Class Hierarchy This Framework Indexes Previous Next

KnowledgeInterfaces Interface CATICkeRelationExp

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

interface CATICkeRelationExp

Interface dedicated to Knowledge relations with textual body management (formulas/Checks/Rules).
Role: An expressional relation is a relation whose links between parameters is defined by a language contained in a text.
- Formulas valuate one parameter from several ones.
- Rules valuate several parameters from several ones.
- Checks use several parameters in input and produces a diagnosis.
- Set of equations use several parameters from several ones. This interface is implemented on those 3 objects
This interface is multi implemented.

See also:

Method Index

o Body(CATCke::Boolean&,CATIParmPublisher_var&): Get the relations body.
o CatchEvaluationError(int): Defines if the relation will catch evaluation error.
o CheckMagnitude(): Checks magnitude coherence.
o IsEvaluationErrorCatched(): Indicates if an evaluation error has been caught.
o Modify(CATCkeListOfParm,CATUnicodeString&,CATIParmPublisher_var&,CATCke::Boolean&): Modifies the body and the list of parameters.

Methods

o Body

public virtual Body(	const	`iReCompute`	`= 0`,
	const	`iRoot`	`= NULL_var`)

Get the relations body.

Parameters:

iReCompute: true if body is to be recomputed
iRoot: used to name parameters with RelativeName (root) method

Returns:

body

o CatchEvaluationError

public virtual CatchEvaluationError( yes)

Defines if the relation will catch evaluation error.

Parameters:

yes: equal true if you want to catch evaluation error

o CheckMagnitude

public virtual CheckMagnitude(

)

Checks magnitude coherence.
This method may raise syntax errors (CATCkeErrorMKS). No ability to catch them in CAA.

Returns:: Legal values: the test can be either CATCke::True if magnitude coherence is Ok CATCke::False if it isn't.

o IsEvaluationErrorCatched

public virtual IsEvaluationErrorCatched(

)

Indicates if an evaluation error has been caught.

Returns:: 1 if true , else 0

o Modify

public virtual Modify(	const	`iListParameters`,
	const	`iBody`,
	const	`iRoot`	`= NULL_var`,
	const	`iRealnames`	`= 1`)

Modifies the body and the list of parameters.
Watch out: to use this service, you need to have the Knowledge Advisor license at runtime for rules, check, set of equation edition.
This method may raise syntax error (CATCkeParseException). No ability to catch them in CAA.
This method may raise evaluation error (CATLifEvaluationError). No ability to catch them in CAA.

Parameters:

iListParameters: list of parameters that can be used in the body
iBody: string describing the body
iRoot: used to name parameters with RelativeName (root) method
and so to be able to recognize parameters by their name
Not used in realnames = false mode
iRealnames: = 2 possibilities to name a parameter in the body.
Legal values: CATCke::True names used are the one returned by RelativeName (root) and we try to recognize names used in the body with parameters of iListParameters.. CATCke::False names used are a1,a2,a3,etc...
a1 meaning the first parameter of iListParameters, a2, the second one, etc....
We advise you strongly to use this second method in your application to avoid NLS problems .

Returns:

true if parse OK, false instead.
if a syntax error occurs, a CATCkeParseException exception is raised in realname=true else a CATLifError is "raised" that you can catch with CATLifErrorManager services The parameters referenced must be in the same container as the relation. This rule will be enforced in future releases to allow the definition of only supported models

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