NX Open C++ Reference Guide
Classes | Public Member Functions
NXOpen::Assemblies::ArrangementCollection Class Reference

a collection of arrangements
To obtain an instance of this class, refer to Assemblies::ComponentAssembly

Created in NX3.0.0. More...

Inheritance diagram for NXOpen::Assemblies::ArrangementCollection:
NXOpen::TaggedObjectCollection

List of all members.

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::ArrangementCreate (NXOpen::Assemblies::Arrangement *templateArrangement, const NXString &name)
 Creates an arrangement, based on an existing arrangement.
iterator end ()
 Returns an iterator addressing one past the last element.
NXOpen::Assemblies::ArrangementFindObject (const NXString &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

Returns an iterator addressing the first element.

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:
templateArrangementThe original arranegment. The new arrangement will be copied from this.
nameThe name of the new arrangement
NOTE: The full Unicode character set is not supported for this parameter.

Returns an iterator addressing one past the last element.

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:
journalIdentifierName of the arrangement to be found

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.