All Frameworks  Class Hierarchy  This Framework  Indexes   

VPMInterfaces Interface CATIVpmGraphAdministrator

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


interface CATIVpmGraphAdministrator

Interface which provides means to read, create, navigate and write a graph instance.


Method Index


o CreatePredicat(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIVpmGraphPredicat_var&)
Create an Predicate.
o GetListOfCommands(CATLISTV(CATBaseUnknown_var)&)
Get all commands.
o GetListOfConditions(CATLISTV(CATBaseUnknown_var)&)
Get all conditions.
o GetListOfEnumPredicats(CATLISTV(CATBaseUnknown_var)&)
Get all EnumPredicats.
o GetListOfGraphInstances(CATLISTV(CATBaseUnknown_var)&)
Get all Graph Instances.
o GetListOfOperations(CATLISTV(CATBaseUnknown_var)&)
Get all operations.
o GetListOfPredicats(CATLISTV(CATBaseUnknown_var)&)
Get all Predicates.
o GetListOfTransitions(CATLISTV(CATBaseUnknown_var)&)
Get all transitions.

Methods


o CreatePredicat
public virtual CreatePredicat( const iPredicatName,
const iPathAttributeName,
const iOperatorName,
const iRelatedValue,
oGraphPredicat)
Create an Predicate.
Parameters:
iPredicatName
-
iPathAttributeName
-
iOperatorName
-
iRelatedValue
-
oGraphPredicat
-
Returns:

Legal values
S_OK
Creation is successfull
S_FALSE
The instance is already created. It returns the GraphPredicatHandler
E_FAIL
An error occurs during the process
o GetListOfCommands
public virtual GetListOfCommands( oCommandList)
Get all commands.
Parameters:
oCommandList
-
Returns:

Legal values
S_OK
Commands exist in datatabase
S_FALSE
No Command in datatabase
E_FAIL
An error occurs during the process
o GetListOfConditions
public virtual GetListOfConditions( oConditionList)
Get all conditions.
Parameters:
oConditionList
-
Returns:

Legal values
S_OK
Conditions exist in datatabase
S_FALSE
No Condition in datatabase
E_FAIL
An error occurs during the process
o GetListOfEnumPredicats
public virtual GetListOfEnumPredicats( oPredicatList)
Get all EnumPredicats.
Parameters:
oPredicatList
-
Returns:

Legal values
S_OK
EnumPredicats exist in datatabase
S_FALSE
No EnumPredicat in datatabase
E_FAIL
An error occurs during the process
o GetListOfGraphInstances
public virtual GetListOfGraphInstances( oGraphInstanceList)
Get all Graph Instances.
Parameters:
oGraphInstanceList
-
Returns:

Legal values
S_OK
Graph instances exist in datatabase
S_FALSE
No Graph instances in datatabase
E_FAIL
An error occurs during the process
o GetListOfOperations
public virtual GetListOfOperations( oOperationList)
Get all operations.
Parameters:
oOperationList
-
Returns:

Legal values
S_OK
Operations exist in datatabase
S_FALSE
No Operation in datatabase
E_FAIL
An error occurs during the process
o GetListOfPredicats
public virtual GetListOfPredicats( oPredicatList)
Get all Predicates.
Parameters:
oPredicatList
-
Returns:

Legal values
S_OK
Predicates exist in datatabase
S_FALSE
No Predicate in datatabase
E_FAIL
An error occurs during the process
o GetListOfTransitions
public virtual GetListOfTransitions( oTransistionList)
Get all transitions.
Parameters:
oTransistionList
-
Returns:

Legal values
S_OK
Transitions exist in datatabase
S_FALSE
No Transition in datatabase
E_FAIL
An error occurs during the process

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

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