All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMIdentificationAccess Interface CATIAdpType

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

interface CATIAdpType

Interface representing PLM Type.

Role: Components that implement this interface are PLM Type. You retrieves these objects using .

Method Index

o GetAlias(CATUnicodeString&): Gets the PLM Class type (name) as NLS name.
o GetPLMCoreType(CATPLMCoreType&): Gets the PLM Core Type.
o GetPLMModeler(CATUnicodeString&): Gets the modeler name.
o GetTypeIdentification(CATString&,CATString&,CATString&): Retrieves the PLM Class and modeler information defining the PLM type.
o IsEqual(CATIAdpType*): Compares two PLM types.

Methods

o GetAlias

public virtual GetAlias( oAlias)

Gets the PLM Class type (name) as NLS name.
Role: Allows the user to retrieve the PLM class type (name).as NLS name

Parameters:

oAlias: [out] The modeler name.

Returns:

S_OK

an Alias was retrieved.

S_FALSE

No alias retrieve.

E_FAIL

Failure

o GetPLMCoreType

public virtual GetPLMCoreType( oCoreType)

Gets the PLM Core Type.
Role: Allows the user to retrieve the PLM core type.

Parameters:

oCoreType: [out] The environment Core Type.

Returns:

S_OK

an Core Type was retrieved.

S_FALSE

No Core Type retrieve.

E_FAIL

Failure

o GetPLMModeler

public virtual GetPLMModeler( oModeler)

Gets the modeler name.
Role: Allows the user to retrieve the name of the modeler

Parameters:

oModeler: [out] The modeler.

Returns:

S_OK

a Modeler was retrieved.

E_FAIL

Failure

o GetTypeIdentification

public virtual GetTypeIdentification(		`oModelerName`,
		`oModelerPLMClassName`,
		`oCustoPLMModelerClassName`)

Retrieves the PLM Class and modeler information defining the PLM type.

Parameters:

oModelerName: [out] The modeler associated to the PLM type.
oModelerPLMClassName: [out] The PLM Modeler Class Name.
oCustoPLMModelerClassName: [out] The Name of the Customized PLM Modeler Class. This string is empty if oModelerPLMClassName is a concrete PLM type. If oCustoPLMModelerClassName is not empty, the PLM type inherits from oModelerPLMClassName .

Returns:

S_OK

The values are usable.

E_FAIL

Failure

o IsEqual

public virtual IsEqual( const iOtherType)

Compares two PLM types.

Parameters:

iOtherType: [in] The type to compare.

Returns:

TRUE if the types are identical and FALSE otherwise.

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