CAT3DPhysicalRepInterfaces Interface CATIPsiRepresentationLoadMode

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

interface CATIPsiRepresentationLoadMode

Interface to change and compute the loading mode of a Representation Reference.

Role: This interface enables you to use the Selective Loading mechanism on the Representation Reference object.
The loading mode of a Representation Reference ( ) corresponds to the Stream Descriptor type attached to the Representation Reference.
This interface is implemented on the Representation Reference.

Method Index


o ChangeLoadingMode(LoadingMode)
Changes the loading mode.
o ComputeLoadingMode(LoadingMode&)
Computes the loading mode.

Enumerated Type Index


o LoadingMode
Loading modes values.

Methods


o ChangeLoadingMode
public virtual ChangeLoadingMode( iNewMode)
Changes the loading mode.
According to the Representation kind, the change of mode can succeed but the Representation can be in a different loading mode than the desired one. In this case, the loading mode can be retrieved with the method.
For more information, refer to the Product Model technical article in the documentation for explanations of the loading modes of the Representation Reference.
Parameters:
iNewMode
The new loading mode to be changed to.
Returns:
An HRESULT value.
Legal values:
S_OK
The loading mode of the Representation Reference has been successfully changed.
E_FAIL
The change of loading mode could not be performed.
Use to retrieve this error.
o ComputeLoadingMode
public virtual ComputeLoadingMode( oLoadingMode)
Computes the loading mode.
Parameters:
oLoadingMode
The loading mode of the Representation Reference.
Returns:
An HRESULT value.
Legal values:
S_OK
The loading mode of the Representation Reference has been successfully computed.
E_FAIL
An unexpected error occurred.

Enumerated Types


o LoadingMode 
enum LoadingMode {
  PLMMode,
  VisuMode,
  LinkableMode,
  EditMode,
  DMUMode,
  UVMode
}
Loading modes values.
Note: The 3D Representation status can be retrieved thanks to the method.
Parameters:
PLMMode:
The Representation Reference has no Stream Descriptor loaded.
VisuMode:
The Representation Reference meets the following conditions:
  • The Representation Reference is a 3D Representation
  • and
    • has its AuthoringVisu Stream Descriptor loaded (in this case the loaded document is a CGR document)
    • or has its Authoring Stream Descriptor loaded and the loaded document can neither be edited nor linked
LinkableMode:
The Representation Reference meets the following conditions:
  • The Representation Reference is a 3D Representation
  • and has its Authoring Stream Descriptor loaded and the loaded document can be linked but not edited.
EditMode:
The Representation Reference has its Authoring Stream Descriptor loaded and the loaded document can be edited.
DMUMode:
The Representation Reference must meet the following conditions :
  • The Representation Reference is a 3D Representation
  • and has its VisuRep Stream Descriptor loaded (in this case the loaded document is a CGR document)
The Representation Reference must be opened in a Browse mode session.
UVMode:
Internal Mode. Do not use it.
This object is included in the file: CATIPsiRepresentationLoadMode.h
If needed, your Imakefile.mk should include the module: CAT3DPhysicalRepItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.