CATPLMIntegrationUse CATAdpOpenParameters

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

public class CATAdpOpenParameters

Class defining open paramters
Role: provide a set of parameters used in open.

Constructor and Destructor Index

o CATAdpOpenParameters(CATAdpOpenParameters&): Copy constructs a query filter.
o CATAdpOpenParameters(CATAdpExpandParameters::ExpandMode): Build a OpenParameter with a mode of data completion for open services.
o ~CATAdpOpenParameters(void): Destructs an attribute set.

Method Index

o SetLoadingMode(LoadingMode): Role: Specifies the loading mode wanted for the representations that will be opened.
o SetMaterialLoadingMode(CATBoolean): Specifies the need to load the materials.
o SetRetrieveConfigConnectionsMode(CATBoolean): Specifies the need to load the Configuration connections.
o operator =(CATAdpOpenParameters&): Affectation operator.

o LoadingMode

Constructor and Destructor

o CATAdpOpenParameters

public CATAdpOpenParameters( const )

Copy constructs a query filter.

Returns:: The copy of the query filter .

o CATAdpOpenParameters

public CATAdpOpenParameters( iMode =CATAdpExpandParameters::Authoring)

Build a OpenParameter with a mode of data completion for open services. This is only used when a reference is given as input. Please refer to CATAdpExpandParameters for explananation of expand modes. Default value for expand mode is Authoring

o ~CATAdpOpenParameters

public virtual ~CATAdpOpenParameters( )

Destructs an attribute set.

Methods

o SetLoadingMode

public SetLoadingMode( const iLoadMode)

Role: Specifies the loading mode wanted for the representations that will be opened. Default is VisuMode

Parameters:

iLoadingMode: PLMMode : this is the minimal mode, no Stream Descriptor is loaded. VisuMode : this is the default mode. Only visualization Stream Descriptors are loaded. EditMode : this is an heaviest mode. All Stream Descriptors are loaded.

Returns:

S_OK Operation succeeded
E_FAIL An error was encountered. Nothing was done.

o SetMaterialLoadingMode

public SetMaterialLoadingMode( iMaterialLoadingMode)

Specifies the need to load the materials. This is only used for authoring mode.

FALSE: The default value.
TRUE: Materials willl be loaded

Returns E_UNEXPECTED if expandMode is not Authoring.

o SetRetrieveConfigConnectionsMode

public SetRetrieveConfigConnectionsMode( iRetrieveConfigConnections)

Specifies the need to load the Configuration connections.

FALSE: The default value.
TRUE: Configuration connections will be loaded

o operator =

public operator =( const )

Affectation operator.

Enumerated Types

o LoadingMode

enum LoadingMode {
  VisuMode,
  PLMMode,
  EditMode
}

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