a collection of arrangements
To obtain an instance of this class, refer to Assemblies::ComponentAssembly
Created in NX3.0.0.
More...
Classes | |
| class | iterator |
| Iterator for accessing the contents of the collection. More... | |
Public Member Functions | |
| iterator | begin () |
| Returns an iterator addressing the first element. | |
| NXOpen::Assemblies::Arrangement * | Create (NXOpen::Assemblies::Arrangement *templateArrangement, const NXString &name) |
| Creates an arrangement, based on an existing arrangement. | |
| NXOpen::Assemblies::Arrangement * | Create (NXOpen::Assemblies::Arrangement *templateArrangement, const char *name) |
| Creates an arrangement, based on an existing arrangement. | |
| iterator | end () |
| Returns an iterator addressing one past the last element. | |
| NXOpen::Assemblies::Arrangement * | FindObject (const NXString &journalIdentifier) |
| Finds the Arrangement with the given identifier as recorded in a journal. | |
| NXOpen::Assemblies::Arrangement * | FindObject (const char *journalIdentifier) |
| Finds the Arrangement with the given identifier as recorded in a journal. | |
| tag_t | Tag () const |
| Returns the tag of this object. | |
Detailed Description
a collection of arrangements
To obtain an instance of this class, refer to Assemblies::ComponentAssembly
Created in NX3.0.0.
Member Function Documentation
| iterator NXOpen::Assemblies::ArrangementCollection::begin | ( | ) |
Returns an iterator addressing the first element.
| NXOpen::Assemblies::Arrangement* NXOpen::Assemblies::ArrangementCollection::Create | ( | NXOpen::Assemblies::Arrangement * | templateArrangement, |
| const NXString & | name | ||
| ) |
Creates an arrangement, based on an existing arrangement.
Note that any ComponentAssembly that contains components will have at least one arrangement. See Assemblies::ComponentAssembly::ActiveArrangement .
- Returns
- the new arrangement
Created in NX3.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
- Parameters
-
templateArrangement The original arranegment. The new arrangement will be copied from this. name The name of the new arrangement
NOTE: The full Unicode character set is not supported for this parameter.
| NXOpen::Assemblies::Arrangement* NXOpen::Assemblies::ArrangementCollection::Create | ( | NXOpen::Assemblies::Arrangement * | templateArrangement, |
| const char * | name | ||
| ) |
Creates an arrangement, based on an existing arrangement.
Note that any ComponentAssembly that contains components will have at least one arrangement. See Assemblies::ComponentAssembly::ActiveArrangement .
- Returns
- the new arrangement
Created in NX3.0.0.
License requirements : assemblies ("ASSEMBLIES MODULE")
- Parameters
-
templateArrangement The original arranegment. The new arrangement will be copied from this. name The name of the new arrangement
NOTE: The full Unicode character set is not supported for this parameter.
| iterator NXOpen::Assemblies::ArrangementCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
| NXOpen::Assemblies::Arrangement* NXOpen::Assemblies::ArrangementCollection::FindObject | ( | const NXString & | journalIdentifier | ) |
Finds the Arrangement 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.
- Returns
- Arrangement found, or null if no such arrangement exists.
Created in NX3.0.0.
License requirements : None
- Parameters
-
journalIdentifier Name of the arrangement to be found
| NXOpen::Assemblies::Arrangement* NXOpen::Assemblies::ArrangementCollection::FindObject | ( | const char * | journalIdentifier | ) |
Finds the Arrangement 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.
- Returns
- Arrangement found, or null if no such arrangement exists.
Created in NX3.0.0.
License requirements : None
- Parameters
-
journalIdentifier Name of the arrangement to be found
| tag_t NXOpen::Assemblies::ArrangementCollection::Tag | ( | ) | const |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- Assemblies_ArrangementCollection.hxx