All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowledgeInterfaces Class CATCkeEvalContext

CATCkeEvalContext
 

Usage: you must use this class as is. You should never derive it.


public class CATCkeEvalContext

Class dedicated to evaluation context information management.
Role: When a relation is evaluated, it creates such an object that is known by all the evaluators of the expression tree.
Those evaluators can then use this context to know the container or relation for example.


Method Index


o Container()
Returns the current container.
o GetSourceKind()
Returns the source kind.
o Relation()
Returns the current relation.
o SendError(CATUnicodeString&,CATKWEErrorSeverity::Severity,CATBaseUnknown_var&)
Send Error.
o StoreAndUpdateTemporaryObject(CATISpecObject_var&)
Expressional relations allow datum geometry valuation (for example: point.

Enumerated Type Index


o SourceKind
Enumerated value that defines which kind of Knowledge object .

Methods


o Container
public virtual CATIContainer_var Container()const =0
Returns the current container.
o GetSourceKind
public virtual CATCkeEvalContext::SourceKind GetSourceKind()const =0
Returns the source kind.
Returns:
Source kind
o Relation
public virtual CATICkeRelation_var Relation()const =0
Returns the current relation.
o SendError
public virtual HRESULT SendError( const CATUnicodeString& iMessage= " ",
const CATKWEErrorSeverity::Severity iSeverity= CATKWEErrorSeverity::Information,
const CATBaseUnknown_var& iSource= NULL_var) const =0
Send Error.
Parameters:
iMessage
Message.
iSeverity
Severity.
iSource
Source
o StoreAndUpdateTemporaryObject
public virtual HRESULT StoreAndUpdateTemporaryObject( const CATISpecObject_var& iObject) = 0
Expressional relations allow datum geometry valuation (for example: point.1 = point(0mm, 10mm, 20mm)). To enable such a functionality, functions have to return temporary geometry whose geometrical result is to be copied into the datum. This temporary geometry life cycle can not be managed by function code because the returned object can be used several times in the expression, so it has to be valid until the end of the expression evaluation. This method allows to solve this problem: the relation stores the temporary geometry and manages itself its life cycle. It is mandatory to call this method for any returned geometry that is created inside a function. Note that if the function needs to create several geometrical features, it has either to delete them before returning result or to call StoreAndUpdateTemporaryObject for each of them. This method updates argument (and possibly raises an error), so caller should not do it himself
Parameters:
iObject
the temporary object whose life cycle has to be managed by the relation
Returns:
E_FAIL if object is NULL_var or is aggregated, S_OK otherwise

Enumerated Types


o SourceKind
enum SourceKind {
  Undefined,
  Formula,
  Law,
  Rule,
  Check,
  Reaction,
  SetOfEquations,
  Pattern,
  OptimizationConstraint,
  ConstraintSatisfaction,
  ExpertRule,
  ExpertCheck,
  UIEvent,
  Behavior,
  Method,
  BusinessRules,
  Expression
}
Enumerated value that defines which kind of Knowledge object .
Parameters:
Undefined
The source is undefined.
Formula
The source is a formula.
Law
The source is a Law.
Rule
The source is a Knowledge Advisor rule.
Check
The source is a Knowledge Advisor check.
Reaction
The source is a Knowledge Advisor reaction or an action.
SetOfEquations
The source is a Knowledge Advisor set of equation.
Pattern
The source is a Product Knowledge Template pattern.
OptimizationConstraint
The source is a Product Engineering optimizer optimization constraint.
ConstraintSatisfaction
The source is a Product Engineering optimizer constraint satisfaction.
ExpertRule
The source is a Knowledge Expert rule.
ExpertCheck
The source is a Knowledge Expert check.
UIEvent
The source is a UI Event (Knowledge Based Dialogs).
Behavior
The source is a Behavior(Engineering process automation).
Method
The source is a Method(Engineering process automation).
BusinessRules
The source is a business rules.
Expression
The source is a simple expression.

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

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