All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATIVpmObjectOperation

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIVpmObjectOperation
 

Usage: you cannot implement this base interface directly. You must first derive it and then implement the derived interface.


interface CATIVpmObjectOperation

A Graph operation.
An operation is a transition from one state of the lifecycle graph to another.


Method Index


o RunUserCommand(CATUnicodeString&,CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&,CATUnicodeString&,CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&,CATBaseUnknown_var&,long&)
Runs the user command related to a terminal.
o RunUserCondition(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&,CATBaseUnknown_var&,long&)
Run the user Condition related to a terminal.

Methods


o RunUserCommand
public virtual HRESULT RunUserCommand( const CATUnicodeString& iOperationName,
const CATUnicodeString& iCommandName,
const CATLISTV(CATBaseUnknown_var)& iCommandPredicatList,
const CATUnicodeString& iCommandParameters,
const CATUnicodeString& iConditionName,
const CATLISTV(CATBaseUnknown_var)& iConditionPredicatList,
const CATBaseUnknown_var& iObject,
const long& iSimulateMode)const = 0
Runs the user command related to a terminal.
Parameters:
iOperationName
name of the operation to run.
iCommandName
name of the command to run.
iCommandPredicateList
list of command predicate
iCommandParameters
list of command parameters
iConditionName
name of the condition
iConditionPredicatList
list of predicate for the condition
iObject
the object whose lifecycle is controlled by the graph, the command evaluation will be done relative to this object
iConditionPredicatList
If a condition is related by the command, a list of associated predicats is given
iSimulateMode
iSimulateMode = 0 -> the system could be modify by the evaluating the condition iSimulateMode > 0 -> the simulate mode is activated the system will not be modified by evaluating the condition
Returns:
An HRESULT value.
Legal values:
S_OK
the condition is true
S_FALSE
the condition is false
E_FAIL
Unknown internal error
o RunUserCondition
public virtual HRESULT RunUserCondition( const CATUnicodeString& iConditionName,
const CATLISTV(CATBaseUnknown_var)& iGraphPredicatList,
const CATBaseUnknown_var& iObject,
const long& iSimulateMode)const = 0
Run the user Condition related to a terminal.
Parameters:
iConditionName
name of the condition to evaluate
iGraphPredicatList
list of graph predicate used to evaluate the condition
iObject
the object whose lifecycle is controlled by the graph, the condition evaluation will be done relative to this object
iSimulateMode
iSimulateMode = 0 -> the system could be modify by the evaluating the condition iSimulateMode > 0 -> the simulate mode is activated the system will not be modified by evaluating the condition
Returns:
An HRESULT value.
Legal values:
S_OK
the condition is true
S_FALSE
the condition is false
E_FAIL
Unknown internal error

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

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