All Frameworks Class Hierarchy This Framework Previous Indexes
ProductStructure Class CATPrsWorkModeServices
CATPrsWorkModeServices
Usage: you must use this class as is. You should never derive it.
public class CATPrsWorkModeServices
Class to retrieve and assign a work mode of/on a Product.
Role: The work mode is a loading mode which can vary according to the
selective loading context.
Method Index
- o
GetWorkMode(CATIProduct_var&,WorkMode&)
- Retrieves the work mode of the Product.
- o
SetWorkMode(CATIProduct_var&,WorkMode)
- Defines the work mode of the Product.
Enumerated Type Index
- o
WorkMode
- Role of this enumeration type.
Methods
o GetWorkMode
public static HRESULT GetWorkMode( | const CATIProduct_var& | iProduct, |
| WorkMode& | oCurrentMode) |
-
Retrieves the work mode of the Product.
- Parameters:
-
- iProduct
- [in] The current Product.
- oCurrentMode
- [out] The returned mode.
- Returns:
-
S_OK
the work mode is successfully retrieved.
E_FAIL
no suitable work mode was retrieved on iProduct.
o SetWorkMode
public static HRESULT SetWorkMode( | const CATIProduct_var& | iProduct, |
| WorkMode | iNewMode) |
-
Defines the work mode of the Product.
- Parameters:
-
- iProduct
- [in] The current Product.
- iNewMode
- [in] The desired mode.
- Returns:
-
S_OK
the work mode is successfully affected.
E_FAIL
the work mode is not successfully affected.
Enumerated Types
o WorkMode
-
enum WorkMode {
WM_VISUALIZATION,
WM_PRODUCT,
WM_BREP,
WM_DESIGN
}
Role of this enumeration type.
- Parameters:
-
- WM_VISUALIZATION
- The Visualization work mode, also named AuthoringVisu mode.
- WM_PRODUCT
- The Product work mode.
- WM_BREP
- The BRep mode, also named Linkable bmode.
- WM_DESIGN
- The Design mode, also named Edit mode.
This object is included in the file: CATPrsWorkModeServices.h
If needed, your Imakefile.mk should include the module: CATProductStructure1