Represents the collection object for all component patterns. More...
Inheritance diagram for NXOpen::Assemblies::ComponentPatternCollection:
Classes | |
| class | iterator |
| Iterator for accessing the contents of the collection. More... | |
Public Member Functions | |
| iterator | begin () |
| Returns an iterator addressing the first element. | |
| iterator | end () |
| Returns an iterator addressing one past the last element. | |
| NXOpen::Assemblies::ComponentPattern * | FindObject (const NXString &journalIdentifier) |
| Finds the ComponentPattern with the given identifier as recorded in a journal. | |
| NXOpen::Assemblies::ComponentPattern * | FindObject (const char *journalIdentifier) |
| Finds the ComponentPattern with the given identifier as recorded in a journal. | |
| void | GetAllComponentPatterns (std::vector< NXOpen::Assemblies::ComponentPattern * > &componentPatterns) |
| Returns all the component patterns in an assembly. | |
| tag_t | Tag () const |
| Returns the tag of this object. | |
Detailed Description
Represents the collection object for all component patterns.
An instance of this class can be obtained from the @link ComponentAssembly ComponentAssembly@endlink . <br> To obtain an instance of this class, refer to @link Assemblies::ComponentAssembly Assemblies::ComponentAssembly @endlink <br>
Created in NX9.0.0.
Member Function Documentation
| iterator NXOpen::Assemblies::ComponentPatternCollection::begin | ( | ) |
Returns an iterator addressing the first element.
| iterator NXOpen::Assemblies::ComponentPatternCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
| NXOpen::Assemblies::ComponentPattern* NXOpen::Assemblies::ComponentPatternCollection::FindObject | ( | const NXString & | journalIdentifier | ) |
Finds the ComponentPattern with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of
the software. However newer versions of the software should find the same object when
FindObject is passed older versions of its journal identifier. In general, this method
should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
@return Component pattern with this identifier, or NULL if no such pattern exists
Created in NX9.0.0.
License requirements : None
- Parameters
-
journalIdentifier Name of the component pattern to be found
| NXOpen::Assemblies::ComponentPattern* NXOpen::Assemblies::ComponentPatternCollection::FindObject | ( | const char * | journalIdentifier | ) |
Finds the ComponentPattern with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of
the software. However newer versions of the software should find the same object when
FindObject is passed older versions of its journal identifier. In general, this method
should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
@return Component pattern with this identifier, or NULL if no such pattern exists
Created in NX9.0.0.
License requirements : None
- Parameters
-
journalIdentifier Name of the component pattern to be found
| void NXOpen::Assemblies::ComponentPatternCollection::GetAllComponentPatterns | ( | std::vector< NXOpen::Assemblies::ComponentPattern * > & | componentPatterns | ) |
Returns all the component patterns in an assembly.
Created in NX9.0.0.
License requirements : None
- Parameters
-
componentPatterns componentpatterns
| tag_t NXOpen::Assemblies::ComponentPatternCollection::Tag | ( | ) | const |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- Assemblies_ComponentPatternCollection.hxx