All Frameworks Class Hierarchy This Framework Indexes
VPMInterfaces Interface CATIVpmObjectPool
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIVpmObjectPool
This interface provides a set of methods to manage a list of
VPMObject Pools.
These pools will be used by the ENOVIA LCA applications
to share some information. A Pool could be considered as a kind of
base of facts by the Business Rules Manager.
Method Index
- o
ActivateSwitch(CATUnicodeString&,ActivateBase&)
-
Change the pool activation flag.
- o
EraseVPMObjectList(CATUnicodeString&,CATUnicodeString&)
-
Remove a list of typed VPMObjects from a pool.
- o
EraseVPMObject(CATUnicodeString&,CATUnicodeString&)
-
Remove a typed VPMObject from a pool.
- o
Flush(CATUnicodeString&)
-
Clean a set of variables included into the Pool.
- o
GetCurrentPool(CATUnicodeString&)
-
Get the name of a current pool.
- o
GetListOfVPMObject(CATUnicodeString&,CATListOfCATUnicodeString&)
-
Get the list of VPMObject names defined in a pool.
- o
GetVPMObjectList(CATUnicodeString&,CATUnicodeString&,CATLISTV(CATIVpmFactoryObject_var)&)
-
Retrieve typed VPMObjects from a pool.
- o
GetVPMObject(CATUnicodeString&,CATUnicodeString&,CATIVpmFactoryObject_var&)
-
Retrieve a typed VPMObject from a pool.
- o
IsActivated(CATUnicodeString&)
-
Query the pool activation status.
- o
SetCurrentPool(CATUnicodeString&)
-
Activate a pool as current.
- o
SetVPMObjectList(CATUnicodeString&,CATUnicodeString&,CATLISTV(CATIVpmFactoryObject_var)&,PoolSetMode&)
-
Add a list of typed VPMObjects.
- o
SetVPMObject(CATUnicodeString&,CATUnicodeString&,CATIVpmFactoryObject_var&,PoolSetMode&)
-
Add a typed VPMObject to the pool.
Methods
o ActivateSwitch
| public virtual ActivateSwitch( | const | iPoolName, |
| const | iActivateFlag) |
-
Change the pool activation flag.
- Parameters:
-
- iPoolName
- the name of the pool for which you want to change the flag value.
- iActivateFlag
- the desired value of the flag.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Activated
- E_FAIL
- Error raised during processing
o EraseVPMObjectList
| public virtual EraseVPMObjectList( | const | iPoolName, |
| const | iVPMObjectName) |
-
Remove a list of typed VPMObjects from a pool.
- Parameters:
-
- iPoolName
- the name of the pool on which to perform the operation.
- iVPMObjectName
- the type of the VPMObjects
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The list is removed
- S_FALSE
- The list does not exist
- E_FAIL
- Error raised during processing
o EraseVPMObject
| public virtual EraseVPMObject( | const | iPoolName, |
| const | iVPMObjectName) |
-
Remove a typed VPMObject from a pool.
- Parameters:
-
- iPoolName
- the name of the pool on which to perform the operation.
- iVPMObjectName
- the type of the VPMObject to remove
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- the VPMObject is removed from the pool
- S_FALSE
- the VPMObject does not exist
- E_FAIL
- Error raised during processing
o Flush
| public virtual Flush( | const | iPoolName) |
-
Clean a set of variables included into the Pool.
- Parameters:
-
- iPoolName
- the name of the pool on which to perform the operation.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Flush successful
- S_FALSE
- Pool is empty
- E_FAIL
- Error raised during processing
o GetCurrentPool
| public virtual GetCurrentPool( | | oPoolName) |
-
Get the name of a current pool.
- Parameters:
-
- oPoolName
- returns the name of the current pool.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Pool name returned
- E_FAIL
- Error raised during processing
o GetListOfVPMObject
| public virtual GetListOfVPMObject( | const | iPoolName, |
| | ioVPMObjectNameList) |
-
Get the list of VPMObject names defined in a pool.
- Parameters:
-
- iPoolName
- the name of the pool for which to query the list.
- ioVPMObjectNameList
- the list of VPMObject names.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Defined VPMObject names returned
- S_FALSE
- No VPMObject defined
- E_FAIL
- Error raised during processing
o GetVPMObjectList
| public virtual GetVPMObjectList( | const | iPoolName, |
| const | iVPMObjectName, |
| | oListOfVPMObject) |
-
Retrieve typed VPMObjects from a pool.
- Parameters:
-
- iPoolName
- the name of the pool on which to perform the operation.
- iVPMObjectName
- the type of the object
- oListOfVPMObject
- the list of VPMObjects retrieved
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- VPMObjects of given type exist
- S_FALSE
- No VPMObject of given type found
- E_FAIL
- Error raised during processing
o GetVPMObject
| public virtual GetVPMObject( | const | iPoolName, |
| const | iVPMObjectName, |
| | oVPMObject) |
-
Retrieve a typed VPMObject from a pool.
- Parameters:
-
- iPoolName
- the name of the pool on which to perform the operation.
- iVPMObjectName
- the type of the object
- oVPMObject
- the retrieved VPMObject
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The object exists
- S_FALSE
- The object does not exist
- E_FAIL
- Error raised during processing
o IsActivated
| public virtual IsActivated( | const | iPoolName) |
-
Query the pool activation status.
- Parameters:
-
- iPoolName
- the name of the pool for which you want to query the status.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Is activated
- S_FALSE
- Not activated
- E_FAIL
- Error raised during processing
o SetCurrentPool
| public virtual SetCurrentPool( | const | iPoolName) |
-
Activate a pool as current.
- Parameters:
-
- iPoolName
- the name of the pool that is to be activated.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Pool activated
- E_FAIL
- Error raised during processing
o SetVPMObjectList
| public virtual SetVPMObjectList( | const | iPoolName, |
| const | iVPMObjectName, |
| const | iListOfVPMObject, |
| const | iSetMode | = NOREPLACE ) |
-
Add a list of typed VPMObjects.
- Parameters:
-
- iPoolName
- the name of the pool on which to perform the operation.
- iVPMObjectName
- the type of the object
- iListOfVPMObject
- the VPMObjects to be added
- iSetMode
- indicates whether existing VPMObjects should be replaced or not. (NOREPLACE by default)
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The list of VPMObjects is created
- S_FALSE
- The list of VPMObjects already exist
- E_FAIL
- Error raised during processing
o SetVPMObject
| public virtual SetVPMObject( | const | iPoolName, |
| const | iVPMObjectName, |
| const | iVPMObject, |
| const | iSetMode | = NOREPLACE ) |
-
Add a typed VPMObject to the pool.
- Parameters:
-
- iPoolName
- the name of the pool on which to perform the operation.
- iVPMObjectName
- the type of the VPMObject
- iVPMObject
- the VPMObject to be added
- iSetMode
- indicates whether existing VPMObject should be replaced or not. (NOREPLACE by default)
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The VPMObject is created
- S_FALSE
- The VPMObject already exists
- E_FAIL
- Error raised during processing
This object is included in the file: CATIVpmObjectPool.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces