CATPLMIntegrationUse CATAdpOpener

Usage: you must use this class as is. You should never derive it.

public class CATAdpOpener

Object managing the open of components in session.

Constructor and Destructor Index

o CATAdpOpener(CATOmbLifeCycleRootsBag&): Default open parameters.
o CATAdpOpener(CATOmbLifeCycleRootsBag&,CATAdpOpenParameters&): Opener with parameters.
o ~CATAdpOpener(void): Destructor

o CompleteAndOpen(CATIAdpPLMIdentificator*,IID&,void**,CATIAdpPLMErrorReviewer*): Opens the PLM object.
o CompleteAndOpen(CATListPtrCATIAdpPLMIdentificator&,CATAdpComponentData&,CATIAdpPLMErrorReviewer*): Opens the PLM objects.

o CATAdpOpener

public CATAdpOpener( iBag)

Default open parameters. Default values correspond to expand in authoring mode , without loading materials.

o CATAdpOpener

public CATAdpOpener(		`iBag`,
	const	`iParams`)

Opener with parameters.

o ~CATAdpOpener

public virtual ~CATAdpOpener( )

Destructor

o CompleteAndOpen

Opens the PLM object.

If RequireMaterials has been set to true, materials applied to this structure will also be opened.
The components will be opened in the current AUTHORING session.
If some representation references are in the set, they are opened in prefered mode.
Some of the components might already be opened. If so, it might not be the latest version of the component. The new version won’t be re-opened.

Parameters:

iIdentifier[in]: The identificator of a component which will be completed and opened. If the component is incorrect, return will be E_INVALIDARG.
iIID: [in] The iid of the interface expected as result.
oComponent: [out, CATBaseUnknown#Release] The opened reference in AUTHORING session which identificator is iRefIdentifier.
iopErrorReviewer: [inout] The ErrorReviewer dedicated to store and handle all PLM Errors raised during the execution of this service.

Returns:

S_OK: The data are opened in the AUTHORING session.
S_FALSE: Nothing was open during the operation
E_FAIL: A fatal error happened during the transaction. Nothing was done during the operation.
E_INVALIDARG: Either iRefIdentifier is NULL or it is not identified as a component which can be opened.

o CompleteAndOpen

Opens the PLM objects.

If RequireMaterials has been set to true, materials applied to this structure will also be opened.
The components will be opened in the current AUTHORING session.
If some representation references are in the set, they are opened in prefered mode.
Some of the components might already be opened. If so, it might not be the latest version of the component. The new version won’t be re-opened.

Parameters:

iIdentifiers[in]: The identificators of components which will be completed and opened. If one of the component is incorrect, return will be E_INVALIDARG and an error will be put into the error monitor if provided.
oOpenedComponents: CATAdpComponentData with list opened components. @see CATAdpComponentData
iopErrorReviewer: [inout] The ErrorReviewer dedicated to store and handle all PLM Errors raised during the execution of this service.

Returns:

S_OK: The data are opened in the AUTHORING session.
S_FALSE: Nothing was open during the operation
E_FAIL: A fatal error happened during the transaction. Nothing was done during the operation.
E_INVALIDARG: Either one of the components is NULL or it is not identified as a component which can be opened.

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