All Frameworks  Class Hierarchy  This Framework  Indexes   

VPMInterfaces Interface CATIVpmFactoryManager

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


interface CATIVpmFactoryManager

Interface to the VPM factory manager.
Role: This interface manages the environment, creates, runs queries, and retrieves a pool manager.


Method Index


o BindVPMObjectP(CATUnicodeString&,CATIContainer_var&,CATUnicodeString&,void*)
o BindVPMObjectP(ENOVIObjectInfo_var&,CATIContainer_var&,void*,CATIVpmFactoryObject_var&)
o CreateVPMObjectWithIdentifier(CATUnicodeString&,CATIContainer_var&,CATUnicodeString&,CORBAAny&)
VPMobject creation with identifier.
o CreateVPMObject(CATUnicodeString&,CATIContainer_var&,CATUnicodeString&)
VPMobject creation without identifier.
o GetFactoryObjectList(CATUnicodeString&)
o GetFactoryObject(CATInterfaceObject_var&)
o GetGraphManager(CATUnicodeString&,CATBaseUnknown_var&)
Get a Graph Manager.
o GetIdentifier(CATUnicodeString&,CATIVpmFactoryObject_var&)
o GetObjectIdentifierList(CATUnicodeString&,CATLISTV(_SEQUENCE_octet)&)
o GetPoolManager(CATIVpmObjectPool_var&)
Get a Pool Manager.
o GetRealObject(void*)
o GetVPMObject(CATIContainer_var&,CATUnicodeString&,CATUnicodeString&,CORBAAny&)
o LoadListOfInstances(CATLISTV(_SEQUENCE_octet)&)
Load objects from their sequence.
o LoadListOfLinkedObject(CATLISTV(CATBaseUnknown_var)*&,CATUnicodeString&)
Load a list of objects linked by reference attribute from a list of object.
o RunQuery(CATIVpmQuery_var&,CATUnicodeString&,CATIContainer_var&,CATLISTV(CATBaseUnknown_var)*&,int,int)
VPMobject Query.
o pop_Environment()
Pop the environment.
o push_Environment(CATUnicodeString&)
Push the environment.

Methods


o BindVPMObjectP
public virtual BindVPMObjectP( const iDomainName,
const iContainer,
const iRealObjectName,
iRealObject)
Deprecated:
V5R14 VPMobject Bind.
Parameters:
iDomainName
The name of the domain.
iContainer
Container to parse.
iRealObjectName
Name of the object to bind
iRealObject
Object to bind
Returns:
The created VPMObject.
o BindVPMObjectP
public virtual BindVPMObjectP( const iObjectInfo,
const iCont,
iRealObject,
oVpmObject)
Deprecated:
V5R14 VPMobject Bind.
Parameters:
iObjectInfo
.
iCont
Container to parse.
iRealObject
Object to bind
oVpmObject
VPMObject found
Returns:
An HRESULT value.
Legal values:
S_OK
VPMObject found
E_FAIL
VPMObject not found or errors occured during process
o CreateVPMObjectWithIdentifier
public virtual CreateVPMObjectWithIdentifier( const iDomainName,
const iContainer,
const iLateEntityName,
const iIdentifier)
VPMobject creation with identifier.
Parameters:
iDomainName
Name of the domain.
iContainer
The receptacle container.
iLateEntityName
The late type of the entity.
iIdentifier
The Identifier.
Returns:
The created VPMObject.
o CreateVPMObject
public virtual CreateVPMObject( const iDomainName,
const iContainer,
const iLateEntityName)
VPMobject creation without identifier.
Parameters:
iDomainName
Name of the domain.
iContainer
The receptacle container.
iLateEntityName
The late type of the entity.
Returns:
The created VPMObject.
o GetFactoryObjectList
public virtual GetFactoryObjectList( const iName="")
Deprecated:
V5R14 Retrieve VPMobject by Name (Default= All).
Parameters:
iName
The name of the VPMObject (Default= All).
Returns:
The list of VPMObjects.
o GetFactoryObject
public virtual GetFactoryObject( const iRealObjectHandler)
Deprecated:
V5R14 Retrieve VPMobject related to a Real object.
Parameters:
iRealObjectHandler
A Handler on a real object).
Returns:
The VPMObject found.
o GetGraphManager
public virtual GetGraphManager( const iGraphName,
const iRules)
Get a Graph Manager.
Parameters:
iGraphName
The name of the graph.
iRules
.
Returns:
The graph manager.
o GetIdentifier
public virtual GetIdentifier( const iDomainName,
const iVPMObject)
Deprecated:
V5R14 Get VPMobject Identifier.
Parameters:
iDomainName
The name of the domain.
iVPMObject
The VPMObject.
Returns:
The Identifier.
o GetObjectIdentifierList
public virtual GetObjectIdentifierList( const iDomainName,
ListOfObjectId)
Deprecated:
V5R14 Retrieve object UUID by domain.
Parameters:
iDomainName
Name of the domain.
ListOfObjectId
The list of octet sequences found.
Returns:
An HRESULT value.
Legal values:
S_OK
Octet sequences found
S_FALSE
Empty domain
E_FAIL
An error occured during the process
o GetPoolManager
public virtual GetPoolManager( PoolManager)
Get a Pool Manager.
Parameters:
PoolManager
The pool manager found.
Returns:
An HRESULT value.
Legal values:
S_OK
.
o GetRealObject
public virtual GetRealObject( iRealObject)
Deprecated:
V5R14 Retrieve VPMobject related to a Real object.
Parameters:
iRealObject
A pointer on a real object).
Returns:
The VPMObject found.
o GetVPMObject
public virtual GetVPMObject( const iContainer,
const iDomainName,
const iLateEntityName,
const iIdentifier)
Deprecated:
V5R14 Seek a VPMobject by Identifier.
Parameters:
iContainer
Container to parse.
iDomainName
The name of the domain.
iLateEntityName
Entity late type.
iIdentifier
The Identifier.
Returns:
The VPMObject found.
o LoadListOfInstances
public virtual LoadListOfInstances( const ListOfObjectId)
Load objects from their sequence.
Parameters:
ListOfObjectId
The list of octet sequences.
Returns:
An HRESULT value.
Legal values:
S_OK
Load is OK (in the container of the first object)
E_FAIL
Load failed
o LoadListOfLinkedObject
public virtual LoadListOfLinkedObject( iListOfVPMobject,
const iAttributPath)
Load a list of objects linked by reference attribute from a list of object. example : object < attref1 --> object1 < attref2 --> object 2
Parameters:
iListOfVPMobject
The list of VPM objects.
iAttributePath
string defining attribute path ( name of attribute separated by dot ) example : attref1.attref2 current limitation : all input VPM object must have the same type maximum level of depth is 2 i.e : path = entity::att1.att2 works only for single reference attribute ( reference aggregate not allowed )
Returns:
An HRESULT value.
Legal values:
S_OK
Load is OK
E_FAIL
Load failed
o RunQuery
public virtual RunQuery( const iQuery,
const iDomainName,
const iContainer,
oList,
iResultLimit= 0,
iMemory= 0)
VPMobject Query.
Parameters:
iQuery
The query to run.
iDomainName
Name of the domain.
iContainer
The target container.
oList
The list of objects found.
iResultLimit
.
iMemory
.
Returns:
An HRESULT value.
Legal values:
S_OK
Query successful
E_FAIL
VPMObject not found or errors occured during process
o pop_Environment
public virtual pop_Environment()
Pop the environment.
Returns:
An HRESULT value.
Legal values:
S_OK
Pop successful
E_FAIL
No environment found
o push_Environment
public virtual push_Environment( const iEnvironment)
Push the environment.
Parameters:
iEnvironment
The name of the environment.
Returns:
An HRESULT value.
Legal values:
S_OK
Push successful
E_FAIL
Bad environment

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

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