All Frameworks Class Hierarchy This Framework Indexes
VPMInterfaces Interface CATIVpmFactoryObject
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIVpmFactoryObject
This interface is the base interface implemented by all persistent ENOVIA objects.
Method Index
- o
GetContainer()
- Get the receptacle container.
- o
GetDomainName()
- Get the name of the domain.
- o
GetEntityName()
- Get a logical name of the entity.
- o
GetEnvironmentName()
- Get the name of the environment.
- o
GetFactoryObject()
- Get the factory object by its interface.
- o
GetInterfaceName()
- Get the name of the interface.
- o
GetNickName()
- Get the nickname.
- o
GetObjectInfo(ENOVIObjectInfo_var&)
- Get the type.
- o
GetRealObject()
- Get the factory object.
- o
GetType(CATUnicodeString&)
- Get the type by name.
- o
IsAKindOf(CATUnicodeString&)
- IsAKindOf.
- o
SetFactoryObject(CATInterfaceObject_var&)
- Set the factory object by an interface.
- o
SetRealObject(void*)
- Set the factory object.
Methods
o GetContainer
| public virtual GetContainer( | ) |
-
Get the receptacle container.
- Returns:
- The container.
o GetDomainName
| public virtual GetDomainName( | ) |
-
Get the name of the domain.
- Returns:
- The name of the domain.
o GetEntityName
| public virtual GetEntityName( | ) |
-
Get a logical name of the entity.
- Returns:
- The logical name.
o GetEnvironmentName
| public virtual GetEnvironmentName( | ) |
-
Get the name of the environment.
- Returns:
- The name of the environment.
o GetFactoryObject
| public virtual GetFactoryObject( | ) |
-
Get the factory object by its interface.
- Returns:
- A handler on the factory object.
o GetInterfaceName
| public virtual GetInterfaceName( | ) |
-
Get the name of the interface.
- Returns:
- The interface's name.
o GetNickName
| public virtual GetNickName( | ) |
-
Get the nickname.
- Returns:
- The nickname.
o GetObjectInfo
| public virtual GetObjectInfo( | | oObjetType) |
-
Get the type.
- Parameters:
-
- oObjetType
- The corresponding ENOVIObjectInfo.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Lock Owner is valuated
- S_FALSE
- Lock Owner is not assign
o GetRealObject
| public virtual GetRealObject( | ) |
-
Get the factory object.
- Returns:
- A pointer on the factory object.
o GetType
| public virtual GetType( | | oType) |
-
Get the type by name.
- Parameters:
-
- oType
- The type of the object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Type is retrieved
- E_FAIL
- An error occured during the process
o IsAKindOf
| public virtual IsAKindOf( | const | iType) |
-
IsAKindOf.
- Parameters:
-
- iType
- The type to test.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- IsAKindOf is TRUE
- S_FALSE
- IsAKindOf is FALSE
- E_FAIL
- An error occured during the process
o SetFactoryObject
| public virtual SetFactoryObject( | const | iObj) |
-
Set the factory object by an interface.
- Parameters:
-
- iObj
- The factory object.
- Returns:
- None.
o SetRealObject
| public virtual SetRealObject( | | iObj) |
-
Set the factory object.
- Parameters:
-
- iObj
- The factory object.
- Returns:
- None.
This object is included in the file: CATIVpmFactoryObject.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces