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

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

Created in NX3.0.0. More...

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

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::Assemblies::ArrangementCreate (NXOpen::Assemblies::Arrangement *templateArrangement, const NXString &name)
 Creates a standard NXOpen::Assemblies::Arrangement , based on an existing standard NXOpen::Assemblies::Arrangement . More...
 
NXOpen::Assemblies::ArrangementCreate (NXOpen::Assemblies::Arrangement *templateArrangement, const char *name)
 Creates a standard NXOpen::Assemblies::Arrangement , based on an existing standard NXOpen::Assemblies::Arrangement . More...
 
NXOpen::Assemblies::ArrangementCreateIsolated (NXOpen::Assemblies::Arrangement *templateArrangement, const NXString &name)
 Creates an isolated NXOpen::Assemblies::Arrangement , based on an existing NXOpen::Assemblies::Arrangement NXOpen::Assemblies::Arrangement . More...
 
NXOpen::Assemblies::ArrangementCreateIsolated (NXOpen::Assemblies::Arrangement *templateArrangement, const char *name)
 Creates an isolated NXOpen::Assemblies::Arrangement , based on an existing NXOpen::Assemblies::Arrangement NXOpen::Assemblies::Arrangement . More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Assemblies::ArrangementFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Assemblies::Arrangement with the given identifier as recorded in a journal. More...
 
NXOpen::Assemblies::ArrangementFindObject (const char *journalIdentifier)
 Finds the NXOpen::Assemblies::Arrangement with the given identifier as recorded in a journal. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

a collection of arrangements
To obtain an instance of this class, refer to NXOpen::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 a standard NXOpen::Assemblies::Arrangement , based on an existing standard NXOpen::Assemblies::Arrangement .

Note that any NXOpen::Assemblies::ComponentAssembly that contains components will have at least one standard NXOpen::Assemblies::Arrangement .

See NXOpen::Assemblies::ComponentAssembly::ActiveArrangement .

Note that the existing NXOpen::Assemblies::Arrangement must not be isolated.

Returns
The new arrangement
Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters
templateArrangementThe original NXOpen::Assemblies::Arrangement . The new NXOpen::Assemblies::Arrangement will be copied from this. This NXOpen::Assemblies::Arrangement must not be isolated.
nameThe name of the new arrangement
NXOpen::Assemblies::Arrangement* NXOpen::Assemblies::ArrangementCollection::Create ( NXOpen::Assemblies::Arrangement templateArrangement,
const char *  name 
)

Creates a standard NXOpen::Assemblies::Arrangement , based on an existing standard NXOpen::Assemblies::Arrangement .

Note that any NXOpen::Assemblies::ComponentAssembly that contains components will have at least one standard NXOpen::Assemblies::Arrangement .

See NXOpen::Assemblies::ComponentAssembly::ActiveArrangement .

Note that the existing NXOpen::Assemblies::Arrangement must not be isolated.

Returns
The new arrangement
Created in NX3.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters
templateArrangementThe original NXOpen::Assemblies::Arrangement . The new NXOpen::Assemblies::Arrangement will be copied from this. This NXOpen::Assemblies::Arrangement must not be isolated.
nameThe name of the new arrangement
NXOpen::Assemblies::Arrangement* NXOpen::Assemblies::ArrangementCollection::CreateIsolated ( NXOpen::Assemblies::Arrangement templateArrangement,
const NXString name 
)

Creates an isolated NXOpen::Assemblies::Arrangement , based on an existing NXOpen::Assemblies::Arrangement NXOpen::Assemblies::Arrangement .

Note that any NXOpen::Assemblies::ComponentAssembly that contains components will have at least one standard NXOpen::Assemblies::Arrangement .

See Assemblies::ComponentAssembly::ActiveArrangement .

Note that the existing NXOpen::Assemblies::Arrangement must not be isolated.

Returns
The new NXOpen::Assemblies::Arrangement .
Created in NX9.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters
templateArrangementThe original NXOpen::Assemblies::Arrangement . This NXOpen::Assemblies::Arrangement must not be isolated.
nameThe name of the new NXOpen::Assemblies::Arrangement .
NXOpen::Assemblies::Arrangement* NXOpen::Assemblies::ArrangementCollection::CreateIsolated ( NXOpen::Assemblies::Arrangement templateArrangement,
const char *  name 
)

Creates an isolated NXOpen::Assemblies::Arrangement , based on an existing NXOpen::Assemblies::Arrangement NXOpen::Assemblies::Arrangement .

Note that any NXOpen::Assemblies::ComponentAssembly that contains components will have at least one standard NXOpen::Assemblies::Arrangement .

See Assemblies::ComponentAssembly::ActiveArrangement .

Note that the existing NXOpen::Assemblies::Arrangement must not be isolated.

Returns
The new NXOpen::Assemblies::Arrangement .
Created in NX9.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")
Parameters
templateArrangementThe original NXOpen::Assemblies::Arrangement . This NXOpen::Assemblies::Arrangement must not be isolated.
nameThe name of the new NXOpen::Assemblies::Arrangement .
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 NXOpen::Assemblies::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
NXOpen::Assemblies::Arrangement* NXOpen::Assemblies::ArrangementCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Assemblies::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
tag_t NXOpen::Assemblies::ArrangementCollection::Tag ( ) const

Returns the tag of this object.


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