All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMIntegrationAccess Interface CATIAdpEnvironment

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

interface CATIAdpEnvironment

Interface representing PLM Environment.

Role: Components that implement this interface are PLM environment. You retrieves environment by using .

See also:

Method Index

o GetAlias(CATUnicodeString&): Gets the environment name as NLS name.
o GetAuthoringType(CATString&,CATPLMCoreType&,IID&,void**)
o GetUsableTypeFromTypeIdentification(CATString&,CATString&,CATString&,CATIAdpType**)
o GetUsableTypes(CATString&,CATPLMCoreType&,CATListPtrCATBaseUnknown&)

Methods

o GetAlias

public virtual GetAlias( oAlias)

Gets the environment name as NLS name.
Role: Allows the user to retrieve the environment NLS alias.

Parameters:

oAlias: [out] The environment alias.

Returns:

S_OK

an Alias was retrieved.

E_FAIL

Failure

o GetAuthoringType

public virtual GetAuthoringType(	const	`iModeler`,
	const	`iCoreType`,
	const	`iIID`,
		`oType`)

Deprecated:

R213 Use
Gets the PLMType which is being authorized to use in creation in this environment.
Role: Informs the user about the type of component that can be created in this environment.

Parameters:

iModeler: [in] The modeler in which the user wants to known the authorized kind of -PLMCoreType- to be create.
iCoreType: [in] The PLMCoreType required (PLM_Reference, PLM_Instance ...).
iIID: [in] The iid of the interface expected as result.
oType: [out, CATBaseUnknown#Release] The type of component that can be created in this environment. Release the returned object when useless.

Returns:

S_OK

A PLMType is an authoring type for the provided PLMCoreType in the provided modeler.

S_FALSE

No authoring type available for this PLMCoreType in the modeler.

E_FAIL

Failure

See also:

o GetUsableTypeFromTypeIdentification

public virtual GetUsableTypeFromTypeIdentification(	const	`iModelerName`,
	const	`iModelerTypeName`,
	const	`iCustoName`,
		`oType`)

Deprecated:

R213 Use
Returns a type inside Usable list from Customisation / Modeler inputs.
Role: Try to find a specific type from usable list.

Parameters:

iModelerName: [in] The modeler in which the user wants to get the Type to be examined.
iModelerTypeName: [in] The metadata name of the base type in the modeler from which the type will be found.
iCustoName: [in] The name of the customisation to search in. This string can be empty if iModelerTypeName is a concrete type (instantiable type).
oType: [out, CATBaseUnknown#Release] The type found.

Returns:

S_OK

A type is found.

E_FAIL

Failure

See also:

o GetUsableTypes

public virtual GetUsableTypes(	const	`iModeler`,
	const	`iCoreType`,
		`oTypes`)

Deprecated:

R213 Use
Gets the PLMTypes which can be examined by the user in this environment.
Role: Informs the user about the types of components that can be examined in this environment.

Parameters:

iModeler: [in] The modeler in which the user wants to known the authorized kind of -PLMCoreType- to be examined.
iCoreType: [in] The PLMCoreType required (PLM_Reference, PLM_Instance ...).
oTypes: [out, CATBaseUnknown#Release] The types of components that can be examined in this environment. Release the returned objects when useless.

Returns:

S_OK

At least one CATIPLMType is a usable type for the provided PLMCoreType in the provided modeler.

S_FALSE

No usable type available for this PLMCoreType in the modeler.

E_FAIL

Failure

See also:

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