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

Contains a collection of Component Groups a NXOpen::Assemblies::ComponentGroup that are defined within an Assembly part. More...

Inheritance diagram for NXOpen::Assemblies::ComponentGroupCollection:
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::ComponentGroupCreateComponentGroup (const NXString &name)
 Creates a NXOpen::Assemblies::ComponentGroup with the given name. More...
 
NXOpen::Assemblies::ComponentGroupCreateComponentGroup (const char *name)
 Creates a NXOpen::Assemblies::ComponentGroup with the given name. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Assemblies::ComponentGroupFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Assemblies::ComponentGroup with the given identifier as recorded in a journal. More...
 
NXOpen::Assemblies::ComponentGroupFindObject (const char *journalIdentifier)
 Finds the NXOpen::Assemblies::ComponentGroup with the given identifier as recorded in a journal. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Contains a collection of Component Groups a NXOpen::Assemblies::ComponentGroup that are defined within an Assembly part.


To obtain an instance of this class, refer to NXOpen::Part

Created in NX5.0.0.

Member Function Documentation

iterator NXOpen::Assemblies::ComponentGroupCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Assemblies::ComponentGroup* NXOpen::Assemblies::ComponentGroupCollection::CreateComponentGroup ( const NXString name)

Creates a NXOpen::Assemblies::ComponentGroup with the given name.

Returns
the ComponentGroup created
Created in NX7.5.0.

License requirements : adv_assemblies ("ADVANCED ASSEMBLIES")
Parameters
nameName for the ComponentGroup
NXOpen::Assemblies::ComponentGroup* NXOpen::Assemblies::ComponentGroupCollection::CreateComponentGroup ( const char *  name)

Creates a NXOpen::Assemblies::ComponentGroup with the given name.

Returns
the ComponentGroup created
Created in NX7.5.0.

License requirements : adv_assemblies ("ADVANCED ASSEMBLIES")
Parameters
nameName for the ComponentGroup
iterator NXOpen::Assemblies::ComponentGroupCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Assemblies::ComponentGroup* NXOpen::Assemblies::ComponentGroupCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Assemblies::ComponentGroup 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
ComponentGroup with this identifier
Created in NX5.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the ComponentGroup you want
NXOpen::Assemblies::ComponentGroup* NXOpen::Assemblies::ComponentGroupCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Assemblies::ComponentGroup 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
ComponentGroup with this identifier
Created in NX5.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the ComponentGroup you want
tag_t NXOpen::Assemblies::ComponentGroupCollection::Tag ( ) const

Returns the tag of this object.


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