CATPLMIntegrationUse class CATAdpComponentData
Usage: you must use this class as is. You should never derive it.
public class CATAdpComponentData
Constructor and Destructor Index
- o
CATAdpComponentData()
- CATAdpComponentData default constructor.
- o
~CATAdpComponentData()
-
Method Index
- o
GetComponent(CATIAdpPLMIdentificator*,IID&,void**)
- Gets a component corresponding to AdpId passed as input.
- o
GetList(CATListPtrCATIPLMComponent&)
- Gets every components in a CATIPLMComponent list.
- o
Next(IID&,void**)
- Iterator on a chosen IID.
- o
Rewind()
- Resets the iterator in order to access to the first component
- o
Size()
- Returns the size of the list of opened components.
Constructor and Destructor
o CATAdpComponentData
| public CATAdpComponentData( | ) |
-
CATAdpComponentData default constructor.
o ~CATAdpComponentData
| public virtual ~CATAdpComponentData( | ) |
-
Methods
o GetComponent
-
Gets a component corresponding to AdpId passed as input.
To get the full set of components, use the iterator.
- Parameters:
-
- iId
- AdpIndentifier from which we want the corresponding component
- iIID
- IID to cast to
- oOpenedElement
- [out, CATBaseUnknown#Release] Element casted. Use : (void**)&oOpenedElement
- Returns:
- S_OK : element found
S_FALSE: element not found
E_FAIL : if failure
o GetList
| public HRESULT GetList( | CATListPtrCATIPLMComponent& | oOpenedComponents) |
-
Gets every components in a CATIPLMComponent list.
- Parameters:
-
- oOpenedComponents
- Element CATLISTP
- Returns:
- S_OK : no issue
E_FAIL : if failure
o Next
| public HRESULT Next( | const IID& | iIID, |
| void** | oComponent) |
-
Iterator on a chosen IID. Iterate until you get S_FALSE as return
use with : while (S_OK == MyObj.Next(...))
You will get every opened components.
- Parameters:
-
- iIID
- IID to cast to
- oComponent
- [out, CATBaseUnknown#Release] Element casted. Use : (void**)&oComponent
- Returns:
- S_OK : there are more elements to iterate through
S_FALSE : end of iteration, no more element
E_FAIL : if failure
o Rewind
-
Resets the iterator in order to access to the first component
o Size
-
Returns the size of the list of opened components.
This object is included in the file: CATAdpComponentData.h
If needed, your Imakefile.mk should include the module: CATPLMIntegrationUse
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.