CATPLMIntegrationUse CATAdpPLMComponentReferences
Usage: you must use this class as is. You should never derive it.
public class CATAdpPLMComponentReferences
Collection associating some informations to components of type instance.
Role: Provide a way to associate instance ( ) to information on its references : owner and aggregating reference.
Constructor and Destructor Index
- o
CATAdpPLMComponentReferences()
-
- o
CATAdpPLMComponentReferences(CATAdpPLMComponentReferences&)
-
- o
~CATAdpPLMComponentReferences()
-
Method Index
- o
GetIterator()
- Retrieve an Iterator on the collection.
- o
GetOwner(CATIAdpPLMIdentificator*,CATIAdpPLMIdentificator*&)
- Retrieve the owner reference associated with a given identifier.
- o
GetReference(CATIAdpPLMIdentificator*,CATIAdpPLMIdentificator*&)
- Retrieve the agreggating reference associated with a given identifier.
- o
Size()
- Number of components available in the Collection.
- o
operator=(CATAdpPLMComponentReferences&)
-
Constructor and Destructor
o CATAdpPLMComponentReferences
| public CATAdpPLMComponentReferences( | ) |
-
o CATAdpPLMComponentReferences
| public CATAdpPLMComponentReferences( | const | ) |
-
o ~CATAdpPLMComponentReferences
| public ~CATAdpPLMComponentReferences( | ) |
-
Methods
o GetIterator
-
Retrieve an Iterator on the collection.
Role: Retrieves an iterator enabling to parse the content of the Collection.
- Returns:
-
- An Iterator on the collection.
o GetOwner
| public GetOwner( | | iComponentIdentifier, |
| | oOwner) |
-
Retrieve the owner reference associated with a given identifier.
Role: Given a
, enables to retrieve the owner reference available in the set for this Component.
- Parameters:
-
- iComponentIdentifier
- [in] The identifier of the component of type instance.
- oOwner
- [out, CATBaseUnknown#Release] The owner reference for the given component.
- Returns:
-
S_OK if the informations are available for the component.E_FAIL if no infos are available for the given Component.
o GetReference
| public GetReference( | | iComponentIdentifier, |
| | oReference) |
-
Retrieve the agreggating reference associated with a given identifier.
Role: Given a
, enables to retrieve the agreggating reference available in the set for this Component.
- Parameters:
-
- iComponentIdentifier
- [in] The identifier of the component of type instance.
- oReference
- [out, CATBaseUnknown#Release] The aggregating reference for the given component.
- Returns:
-
S_OK if the informations are available for the component.E_FAIL if no infos are available for the given Component.
o Size
-
Number of components available in the Collection.
Role: Retrieves the number of Components available in the Collection.
- Returns:
-
- The number of PLM Components being part of the Components Set.
o operator=
| public operator=( | const | ) |
-
This object is included in the file: CATAdpPLMComponentReferences.h
If needed, your Imakefile.mk should include the module: CATPLMIntegrationUse
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.