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

Represents a collection of NXOpen::Layout2d::Component s. More...

Inheritance diagram for NXOpen::Layout2d::ComponentCollection:
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::Layout2d::AssemblyFromLayout2dBuilderCreateAssemblyFromLayout2dBuilder ()
 Creates a NXOpen::Layout2d::AssemblyFromLayout2dBuilder that can create assembly from the selected layout. More...
 
NXOpen::Layout2d::DefineComponentAnchorPointBuilderCreateDefineComponentAnchorPointBuilder ()
 Creates a NXOpen::Layout2d::DefineComponentAnchorPointBuilder that can define the Anchor Point location of a 2D Component. More...
 
NXOpen::Layout2d::DefineComponentBuilderCreateDefineComponentBuilder (NXOpen::Layout2d::Component *component)
 Creates a NXOpen::Layout2d::DefineComponentBuilder that can create a fully defined 2D Component with specified content, anchor point, name and reuse library destination folder. More...
 
NXOpen::Layout2d::InsertComponentBuilderCreateInsertComponentBuilder ()
 Creates a NXOpen::Layout2d::InsertComponentBuilder that inserts a 2D Component instance in the active sketch. More...
 
NXOpen::Layout2d::MakeComponentUniqueBuilderCreateMakeComponentUniqueBuilder ()
 Creates a NXOpen::Layout2d::MakeComponentUniqueBuilder that can create definition for the selected 2D Component instance. More...
 
NXOpen::Layout2d::NewComponentBuilderCreateNewComponentBuilder ()
 Creates a NXOpen::Layout2d::NewComponentBuilder that creates an empty 2D Component instance and stores its definition in local 2D Component folder. More...
 
NXOpen::Layout2d::PublishComponentBuilderCreatePublishComponentBuilder ()
 Creates a NXOpen::Layout2d::PublishComponentBuilder that can export local definitions into external storage locations. More...
 
NXOpen::Layout2d::ReplaceComponentBuilderCreateReplaceComponentBuilder ()
 Creates a NXOpen::Layout2d::ReplaceComponentBuilder that can replace the selected 2D Component instance with another 2D Component definition. More...
 
NXOpen::Layout2d::SmashComponentBuilderCreateSmashComponentBuilder ()
 Creates a NXOpen::Layout2d::SmashComponentBuilder that can smash the selected 2D Component instance. More...
 
void DeleteComponents (const std::vector< NXOpen::Layout2d::Component * > &components)
 Deletes a list of 2D Components
Created in NX10.0.0. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Layout2d::ComponentFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Layout2d::Component with the given identifier as recorded in a journal. More...
 
NXOpen::Layout2d::ComponentFindObject (const char *journalIdentifier)
 Finds the NXOpen::Layout2d::Component with the given identifier as recorded in a journal. More...
 
bool IsComponentMember (NXOpen::DisplayableObject *disObject)
 Verify if the object belong to this component. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen::Layout2d::Component s.


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

Created in NX10.0.0.

Member Function Documentation

iterator NXOpen::Layout2d::ComponentCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Layout2d::AssemblyFromLayout2dBuilder* NXOpen::Layout2d::ComponentCollection::CreateAssemblyFromLayout2dBuilder ( )

Creates a NXOpen::Layout2d::AssemblyFromLayout2dBuilder that can create assembly from the selected layout.

Returns

Created in NX10.0.0.

License requirements : nx_layout ("NX Layout")
NXOpen::Layout2d::DefineComponentAnchorPointBuilder* NXOpen::Layout2d::ComponentCollection::CreateDefineComponentAnchorPointBuilder ( )

Creates a NXOpen::Layout2d::DefineComponentAnchorPointBuilder that can define the Anchor Point location of a 2D Component.

Returns

Created in NX10.0.0.

License requirements : nx_layout ("NX Layout")
NXOpen::Layout2d::DefineComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreateDefineComponentBuilder ( NXOpen::Layout2d::Component component)

Creates a NXOpen::Layout2d::DefineComponentBuilder that can create a fully defined 2D Component with specified content, anchor point, name and reuse library destination folder.

Returns

Created in NX10.0.0.

License requirements : nx_layout ("NX Layout")
Parameters
componentthe component to be edited, NULL in case of new component view.
NXOpen::Layout2d::InsertComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreateInsertComponentBuilder ( )

Creates a NXOpen::Layout2d::InsertComponentBuilder that inserts a 2D Component instance in the active sketch.

Returns

Created in NX10.0.0.

License requirements : nx_layout ("NX Layout")
NXOpen::Layout2d::MakeComponentUniqueBuilder* NXOpen::Layout2d::ComponentCollection::CreateMakeComponentUniqueBuilder ( )

Creates a NXOpen::Layout2d::MakeComponentUniqueBuilder that can create definition for the selected 2D Component instance.

Returns

Created in NX10.0.0.

License requirements : nx_layout ("NX Layout")
NXOpen::Layout2d::NewComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreateNewComponentBuilder ( )

Creates a NXOpen::Layout2d::NewComponentBuilder that creates an empty 2D Component instance and stores its definition in local 2D Component folder.

Returns

Created in NX10.0.0.

License requirements : nx_layout ("NX Layout")
NXOpen::Layout2d::PublishComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreatePublishComponentBuilder ( )

Creates a NXOpen::Layout2d::PublishComponentBuilder that can export local definitions into external storage locations.

Returns

Created in NX10.0.0.

License requirements : nx_layout ("NX Layout")
NXOpen::Layout2d::ReplaceComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreateReplaceComponentBuilder ( )

Creates a NXOpen::Layout2d::ReplaceComponentBuilder that can replace the selected 2D Component instance with another 2D Component definition.

Returns

Created in NX10.0.0.

License requirements : nx_layout ("NX Layout")
NXOpen::Layout2d::SmashComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreateSmashComponentBuilder ( )

Creates a NXOpen::Layout2d::SmashComponentBuilder that can smash the selected 2D Component instance.

Returns

Created in NX10.0.0.

License requirements : nx_layout ("NX Layout")
void NXOpen::Layout2d::ComponentCollection::DeleteComponents ( const std::vector< NXOpen::Layout2d::Component * > &  components)

Deletes a list of 2D Components
Created in NX10.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
componentscomponents
iterator NXOpen::Layout2d::ComponentCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Layout2d::Component* NXOpen::Layout2d::ComponentCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Layout2d::Component 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
2D Component with this identifier
Created in NX10.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the 2D Component to be found
NXOpen::Layout2d::Component* NXOpen::Layout2d::ComponentCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Layout2d::Component 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
2D Component with this identifier
Created in NX10.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the 2D Component to be found
bool NXOpen::Layout2d::ComponentCollection::IsComponentMember ( NXOpen::DisplayableObject disObject)

Verify if the object belong to this component.

Returns
true if the object is component member
Created in NX10.0.0.

License requirements : nx_layout ("NX Layout")
Parameters
disObjectdisobject
tag_t NXOpen::Layout2d::ComponentCollection::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.