CATPLMComponentInterfaces CATPLMComponentInterfacesServices
Usage: you must use this class as is. You should never derive it.
public class CATPLMComponentInterfacesServices
Class to access services on PLM component in current session.
Role: this class provides an access to PLM components in current session.
Method Index
- o
GetEditedRootPLMComponents(CATFrmEditor*,CATListPtrCATIPLMComponent&)
- Retrieves the list of PLMComponents in a given Editor.
- o
GetPLMComponentOf(CATBaseUnknown*,CATIPLMComponent_var&)
- For an object inside a stream, retrieves the PLM Component agregrating that stream.
- o
GetPLMComponentsInSession(CATLISTV(CATIPLMComponent_var)&)
- Retrieves the list of PLM components in current session.
Methods
o GetEditedRootPLMComponents
| public static GetEditedRootPLMComponents( | | iEditor, |
| | oRoots) |
-
Retrieves the list of PLMComponents in a given Editor.
Role: Retrieves the enumeration of root PLMEntities of a given editor.
Use second signature with CATLISTV(CATIPLMComponent_var). The other is getting deprecated
- Parameters:
-
- iEditor
- The editor.
- oRoots
- The list of roots of the editor.
- Returns:
-
- S_OK the list is successfully retrieved.
- E_FAIL if unexpected error ocurred.
o GetPLMComponentOf
| public static GetPLMComponentOf( | | ipObject, |
| | oPLMComponent) |
-
For an object inside a stream, retrieves the PLM Component agregrating that stream.
- Parameters:
-
- ipObject
- An object inside the stream)
- oPLMComponent
- The corresponding PLM Component.
- Returns:
-
S_OK if the methods succeeds.
E_FAIL otherwise.
o GetPLMComponentsInSession
| public static GetPLMComponentsInSession( | | oList) |
-
Retrieves the list of PLM components in current session.
Role: Retrieves the enumeration of PLM entities in session of kind Representation or Reference (according
to the vocabulary of PLM abstract Model referential).
- Parameters:
-
- oList
- The list of PLM components.
- Returns:
-
- S_OK if the list is successfully retrieved and if it is not empty.
- S_FALSE if the list is empty.
- E_FAIL if unexpected errors.
This object is included in the file: CATPLMComponentInterfacesServices.h
If needed, your Imakefile.mk should include the module: CATPLMComponentInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.