All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface CATIVpmGraphMng
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIVpmGraphMng
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIVpmGraphMng
role: This class enables to access to parameters of the graph manager.
- FactDatabase
: Name of the pool to scan by the rule engine: "ALL" means analyze all pools defined in memory
- Status
: State or the name of a specific rule
- Terminal
: Event to trigger the rules engine
- Transition
: Mechanism to change the status of the system
- Condition
: Mechanism to validate and allow the transition
- Operation
: Logical function to execute after the transition
- Command
: Associated program to execute through an operation
Method Index
- o
ExistTransition(CATUnicodeString&,CATUnicodeString&,long&)
- Get the number a transitions from a initial status to a terminal one.
- o
GetCommandDefinition(CATUnicodeString&,CATUnicodeString&)
- Get the command definition.
- o
GetCondition(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&)
- Get condition.
- o
GetCondition(CATUnicodeString&,CATUnicodeString&,long&,CATLISTV(CATBaseUnknown_var)&)
- Get list of predicates.
- o
GetCondition(CATUnicodeString&,CATUnicodeString&,long&,CATUnicodeString&)
- Get condition.
- o
GetDashBoard(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,long&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
-
- o
GetFactDatabase(CATUnicodeString&)
-
- o
GetGraphName(CATUnicodeString&)
- Get the GraphName.
- o
GetGraphType(CATUnicodeString&)
- Get the GraphType.
- o
GetListOfCommands(CATUnicodeString&,CATLISTV(CATUnicodeString)&)
- Get list of commands.
- o
GetListOfGraphName(CATLISTV(CATUnicodeString)&)
- Get list of graph names.
- o
GetListOfStatus(CATLISTV(CATUnicodeString)&)
- Get list of statuses.
- o
GetListOfTerminals(CATUnicodeString&,CATLISTV(CATUnicodeString)&)
- Get list of terminals of an initial status.
- o
GetOperation(CATUnicodeString&,CATUnicodeString&,long&,CATUnicodeString&)
- Get operation.
- o
GetStatusDefinition(CATUnicodeString&,CATIVpmGraphStatus_var&)
- Get status definition.
- o
GetStatusDefinition(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
- Get status definition.
- o
GetTransitionDefinition(CATUnicodeString&,CATUnicodeString&,long&,long&,CATUnicodeString&,CATUnicodeString&)
- Get transition definition.
- o
Init(CATUnicodeString&)
- Initialize the status and return the first status.
- o
PutGraphType(CATUnicodeString&)
- Put the GraphType.
- o
SetCurrentObject(CATBaseUnknown_var&)
- Set the current object.
- o
SetFactDatabase(CATUnicodeString&)
-
- o
SetScanMode(int)
-
- o
Simulate(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
- Simulation of a transition.
- o
StepForward(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
- Run a new step on the graph.
Methods
o ExistTransition
-
Get the number a transitions from a initial status to a terminal one.
- Parameters:
-
- iStatus
- - Name of initial status
- iTerminal
- - Name of terminal status
- oTerminalCounter
- - Number of transitions
- Returns:
-
Legal values
- S_OK
- At least one transition exists
- E_FAIL
- No transition found
o GetCommandDefinition
-
Get the command definition.
- Parameters:
-
- iCommandName
- - name of the command
- oParameters
- -
- Returns:
-
Legal values
- S_OK
- Command found in the database
- S_FALSE
- Command not found in the database
o GetCondition
-
Get condition.
- Parameters:
-
- iCommandName
- - name of the command
- oGraphPredicatList
- - list of predicates
- Returns:
-
Legal values
- S_OK
- Command found in the database
- S_FALSE
- Command not found in the database
o GetCondition
-
Get list of predicates.
- Parameters:
-
- iStatus
- - initial status
- iTerminal
- - name of terminal status
- iIndexOfTransition
- - index of transition
- oGraphPredicatList
- -
- Returns:
-
Legal values
- S_OK
- Predicates found in the database
- S_FALSE
- No predicate in the database
o GetCondition
-
Get condition.
- Parameters:
-
- iStatus
- - initial status
- iTerminal
- - name of terminal status
- iIndexOfTransition
- - index of transition
- oCondition
- - name of condition
- Returns:
-
Legal values
- S_OK
- One condition found in the database
- S_FALSE
- No condition in the database
- E_FAIL
- Multiple condition in the database
o GetDashBoard
-
- Deprecated:
- V5R14
Get all information of Graph manager.
- Parameters:
-
- oFactDatabaseName
- -
- oBeginStatus
- -
- oTerminal
- -
- oCondition
- -
- oTransition
- -
- oTransitionIndex
- -
- oOperation
- -
- oFinalStatus
- -
- oFinalSubStatus
- -
- Returns:
-
Legal values
- S_OK
o GetFactDatabase
-
- Deprecated:
- V5R14
Get the FactDatabase name.
- Parameters:
-
- oFactDatabase
- - name of the FactDatabase (ALL means all pool must be analyzed and flushed)
- Returns:
-
Legal values
- S_OK
o GetGraphName
-
Get the GraphName.
- Parameters:
-
- oValue
- -
- Returns:
-
Legal values
- S_OK
o GetGraphType
-
Get the GraphType.
- Parameters:
-
- oValue
- -
- Returns:
-
Legal values
- S_OK
o GetListOfCommands
public virtual HRESULT GetListOfCommands( | const CATUnicodeString& | iOperation, |
| CATLISTV(CATUnicodeString)& | oListOfCommands)const = 0 |
-
Get list of commands.
- Parameters:
-
- iOperation
- - name of the operation
- oListOfCommands
- -
- Returns:
-
Legal values
- S_OK
- Commands found in the database
- S_FALSE
- No command in the database
o GetListOfGraphName
public virtual HRESULT GetListOfGraphName( | CATLISTV(CATUnicodeString)& | oListOfGraph)const = 0 |
-
Get list of graph names.
- Parameters:
-
- oListOfGraph
- - list of names
- Returns:
-
Legal values
- S_OK
- At least one graph found
- S_FALSE
- No graph found
o GetListOfStatus
public virtual HRESULT GetListOfStatus( | CATLISTV(CATUnicodeString)& | oListOfStatus)const = 0 |
-
Get list of statuses.
- Parameters:
-
- oListOfStatus
- - list of statuses
- Returns:
-
Legal values
- S_OK
o GetListOfTerminals
public virtual HRESULT GetListOfTerminals( | const CATUnicodeString& | iStatus, |
| CATLISTV(CATUnicodeString)& | oListOfTerminals)const = 0 |
-
Get list of terminals of an initial status.
- Parameters:
-
- iStatus
- - initial status
- oListOfTerminals
- - list of terminals
- Returns:
-
Legal values
- S_OK
o GetOperation
-
Get operation.
- Parameters:
-
- iStatus
- - initial status
- iTerminal
- - name of terminal status
- iIndexOfTransition
- - index of transition
- oOperation
- - name of the operation
- Returns:
-
Legal values
- S_OK
- One operation found in the database
- S_FALSE
- No operation in the database
o GetStatusDefinition
public virtual HRESULT GetStatusDefinition( | const CATUnicodeString& | iStatusName, |
| CATIVpmGraphStatus_var& | oGraphStatus)const = 0 |
-
Get status definition.
- Parameters:
-
- iStatusName
- - Name of the status
- oGraphStatus
- -
- Returns:
-
Legal values
- S_OK
- Unique status in the database
- S_FALSE
- No status in the datatbase
- E_FAIL
- Multiple statuses in the datatbase
o GetStatusDefinition
-
Get status definition.
- Parameters:
-
- iStatusName
- - Name of the status
- oGraphType
- - Type of graph
- oSubState
- - Name of SubStatus
- Returns:
-
Legal values
- S_OK
- Unique status in the database
- S_FALSE
- No status in the datatbase
- E_FAIL
- Multiple status in the datatbase
o GetTransitionDefinition
-
Get transition definition.
- Parameters:
-
- iStatusName
- - initial status
- iTerminal
- - name of terminal status
- iTransitionIndex
- - index of transition
- oScanMode
- -
- oNextState
- -
- oNextTermnal
- -
- Returns:
-
Legal values
- S_OK
- One transition found in the database
- S_FALSE
- No transition in the database
- E_FAIL
- Multiple transitions in the database
o Init
-
Initialize the status and return the first status.
- Parameters:
-
- oValue
- - Initial status found
- Returns:
-
Legal values
- S_OK
- Only one status exists
- E_FAIL
- Less or more than one have been found
o PutGraphType
-
Put the GraphType.
- Parameters:
-
- iValue
- -
- Returns:
-
Legal values
- S_OK
o SetCurrentObject
-
Set the current object.
- Parameters:
-
- iObject
- -
- Returns:
-
Legal values
- S_OK
o SetFactDatabase
-
- Deprecated:
- V5R14
Set the FactDatabase name.
- Parameters:
-
- iFactDatabase
- - name of the FactDatabase
- Returns:
-
Legal values
- S_OK
o SetScanMode
public virtual HRESULT SetScanMode( | int | iScanMode | = 0 )= 0 |
-
- Deprecated:
- V5R14
Set the scan mode.
- Parameters:
-
- iScanMode
- -
- Returns:
-
Legal values
- S_OK
o Simulate
-
Simulation of a transition.
- Parameters:
-
- iStatus
- - initial status of the transition
- iTerminal
- - terminal status of the transition
- oNextOperation
- -
- Returns:
-
Legal values
- S_OK
- Transition exists
- E_FAIL
- Transition does not exist
o StepForward
-
Run a new step on the graph.
- Parameters:
-
- iStatus
- - initial status of the transition
- iTerminal
- - terminal status of the transition
- oStatus
- - new status on the graph
- Returns:
-
Legal values
- S_OK
- Transition runs correctly
- E_FAIL
- Transition fails
This object is included in the file: CATIVpmGraphMng.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces