All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowledgeInterfaces Interface CATICkeRelation

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---KnowledgeInterfaces.CATICkeNaming
        |
        +---CATICkeRelation
 

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


interface CATICkeRelation

Interface dedicated to relations management.
Role: A relation is an oriented link stored between parameters.
It manages the propagation of input modifications to outputs.
This interface is implemented on relations.

See also:
CATICkeParm


Method Index


o Add(CATICkeParm_var&,CATICkeArg::Mode)
Add a parameter in Input or Output.
o CanBeEvaluated()
Indicates if the relation can be evaluated.
o ClearParameters()
Clears the links to all parameters.
o Evaluate()
Evaluates the relation.
o InParameters()
Returns the list of parameters linked in input.
o IntegrateToUpdateProcess(int&)
Defines if the relation will be evaluated during the update process.
o IsBroken()
Indicates if the relation is Broken.
o IsConst()
Indicates if this relation is const or not.
o IsHidden()
Is this relation hidden or shown.
o IsIntegratedToUpdateProcess()
Indicates if the relation is evaluated during the update process.
o IsSynchronous()
Indicates if update will be synchronous or not.
o IsUpdated()
Indicates if the relation is updated.
o OutParameters()
Returns the list of parameters linked in output.
o Parameters()
Returns the list of all parameters linked.
o Replace(CATICkeParm_var&,CATICkeParm_var&)
Replaces a parameter by another.
o Root()
Returns the root of the relation.
o SetConst(CATCke::Boolean)
Sets Const facet.
o SetHidden(CATCke::Boolean)
Sets HideShow facet.
o SetSynchronous(CATCke::Boolean&)
Defines if update will be synchronous or not.
o Suppress(CATICkeParm_var&)
Suppresses a link to a given parameter in Input or Output.

Methods


o Add
public virtual void Add( const CATICkeParm_var& iParameter,
const CATICkeArg::Mode iMode) = 0
Add a parameter in Input or Output. (deactivates relation)
Parameters:
iParameter
parameter to add
iMode

Legal values: the mode can be either In when parameter will be used as an input. Out when parameter will be used as an output.
o CanBeEvaluated
public virtual CATCke::Boolean CanBeEvaluated()const = 0
Indicates if the relation can be evaluated.
This method may raise syntax error (CATCkeParseException). No ability to catch them in CAA.
Returns:

Legal values: the test can be either CATCke::True if it can be evaluated 0 if it can't.
o ClearParameters
public virtual void ClearParameters()= 0
Clears the links to all parameters.
o Evaluate
public virtual CATCke::Boolean Evaluate()= 0
Evaluates the relation. This method may raise evaluation error (CATLifEvaluationError). No ability to catch them in CAA.
Returns:

Legal values: CATCke::True if evaluation is Ok CATCke::False if evaluation is Ko.
o InParameters
public virtual CATCkeListOfParm InParameters()const = 0
Returns the list of parameters linked in input.
Returns:
list of parameters in input (not to be deallocated)
o IntegrateToUpdateProcess
public virtual HRESULT IntegrateToUpdateProcess( const int& iYesOrNo) const = 0
Defines if the relation will be evaluated during the update process. This can only be done if your relation is in a part document.
Parameters:
iYesOrNo

Legal values: S_OK The relation has been integrated to update. CATCke::False The relation has not been integrated to update.
Returns:

Legal values: 0 The relation will not be integrated to update. 1 The relation will be integrated to update.
o IsBroken
public virtual CATCke::Boolean IsBroken()const = 0
Indicates if the relation is Broken.
Broken means that it cannot be runned.
2 reasons for that: an operator doesn't exist anymore in our session b/c of licensing
or a parameter has been lost in multi-document context
Returns:
Legal values: the test can be either CATCke::True if it is broken CATCke::False if it isn't.
o IsConst
public virtual CATCke::Boolean IsConst()const = 0
Indicates if this relation is const or not. Default value is always not Const
Returns:
Legal values: CATCke::True if it is constant CATCke::False if it isn't.
o IsHidden
public virtual CATCke::Boolean IsHidden()const = 0
Is this relation hidden or shown. Default value is always Shown
Returns:

Legal values: CATCke::True if it is hidden CATCke::False if it isn't.
o IsIntegratedToUpdateProcess
public virtual int IsIntegratedToUpdateProcess()const = 0
Indicates if the relation is evaluated during the update process.
Returns:

Legal values: 1 The relation is integrated to update. 0 The relation is not integrated to update.
o IsSynchronous
public virtual CATCke::Boolean IsSynchronous()const = 0
Indicates if update will be synchronous or not.
Returns:

Legal values: the test can be either CATCke::True if is is synchronous CATCke::False if it isn't.
o IsUpdated
public virtual CATCke::Boolean IsUpdated()const = 0
Indicates if the relation is updated.
Returns:

Legal values: CATCke::True if it is already updated CATCke::False if it must be updated.
o OutParameters
public virtual CATCkeListOfParm OutParameters()const = 0
Returns the list of parameters linked in output.
Returns:
list of parameters in output (not to be deallocated)
o Parameters
public virtual CATCkeListOfParm Parameters()const = 0
Returns the list of all parameters linked.
Returns:
list of all parameters (not to be deallocated)
o Replace
public virtual void Replace(CATICkeParm_var& iParameterToReplace,
CATICkeParm_var& iReplacingParameter) =0
Replaces a parameter by another. (keep the order and mode)
Parameters:
iParameterToReplace
parameter that is replaced
iReplacingParameter
parameter that replaces the other
o Root
public virtual CATIParmPublisher_var Root()const = 0
Returns the root of the relation. A relation knows a root of object.
This root is the place in which the relation can find its parameters.
It corresponds in fact to the SpecObject where the relation is agregated.
(to be more precise, it corresponds to the owner of the relation set)
the root can be null
o SetConst
public virtual void SetConst( const CATCke::Boolean iConstant) = 0
Sets Const facet. Default value is always not Const
Parameters:
iConstant
Legal values: CATCke::True if it is constant CATCke::False if it isn't.
o SetHidden
public virtual void SetHidden( const CATCke::Boolean iHidden) = 0
Sets HideShow facet. Default value is always Shown
Parameters:
iHidden

Legal values: CATCke::True if it is hidden CATCke::False if it isn't.
o SetSynchronous
public virtual void SetSynchronous( const CATCke::Boolean& iSynchronous) = 0
Defines if update will be synchronous or not.
Parameters:
iSynchronous

Legal values: the test can be either CATCke::True if is is synchronous CATCke::False if it isn't.
o Suppress
public virtual void Suppress( const CATICkeParm_var& iParameter) = 0
Suppresses a link to a given parameter in Input or Output. (deactivates relation)
Parameters:
iParameter
parameter to suppress

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

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