All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATIVpmFactoryObject

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 CATIContainer_var GetContainer()=0
Get the receptacle container.
Returns:
The container.
o GetDomainName
public virtual CATUnicodeString GetDomainName()=0
Get the name of the domain.
Returns:
The name of the domain.
o GetEntityName
public virtual CATUnicodeString GetEntityName()=0
Get a logical name of the entity.
Returns:
The logical name.
o GetEnvironmentName
public virtual CATUnicodeString GetEnvironmentName()=0
Get the name of the environment.
Returns:
The name of the environment.
o GetFactoryObject
public virtual CATInterfaceObject_var GetFactoryObject()=0
Get the factory object by its interface.
Returns:
A handler on the factory object.
o GetInterfaceName
public virtual CATUnicodeString GetInterfaceName()=0
Get the name of the interface.
Returns:
The interface's name.
o GetNickName
public virtual CATUnicodeString GetNickName()=0
Get the nickname.
Returns:
The nickname.
o GetObjectInfo
public virtual HRESULT GetObjectInfo(ENOVIObjectInfo_var& oObjetType)= 0
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 void* GetRealObject()=0
Get the factory object.
Returns:
A pointer on the factory object.
o GetType
public virtual HRESULT GetType(CATUnicodeString& oType)=0
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 HRESULT IsAKindOf( const CATUnicodeString& iType)=0
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 void SetFactoryObject( const CATInterfaceObject_var& iObj)=0
Set the factory object by an interface.
Parameters:
iObj
The factory object.
Returns:
None.
o SetRealObject
public virtual void SetRealObject(void* iObj)=0
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

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