NXOpen::Layout2d::ComponentCollection Class Reference

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

Inheritance diagram for NXOpen::Layout2d::ComponentCollection:

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::Layout2d::DefineComponentAnchorPointBuilder *	CreateDefineComponentAnchorPointBuilder ()
	Creates a Layout2d::DefineComponentAnchorPointBuilder that can define the Anchor Point location of a 2d component.
NXOpen::Layout2d::DefineComponentBuilder *	CreateDefineComponentBuilder (NXOpen::Layout2d::Component *component)
	Creates a Layout2d::DefineComponentBuilder that can create a fully defined 2D Component with specified content, anchor point, name and reuse library destination folder.
NXOpen::Layout2d::InsertComponentBuilder *	CreateInsertComponentBuilder ()
	Creates a Layout2d::InsertComponentBuilder that inserts a 2d Component instance in the active sketch.
NXOpen::Layout2d::MakeComponentUniqueBuilder *	CreateMakeComponentUniqueBuilder ()
	Creates a Layout2d::MakeComponentUniqueBuilder that can create definition for the selected 2d component instance.
NXOpen::Layout2d::NewComponentBuilder *	CreateNewComponentBuilder ()
	Creates a Layout2d::NewComponentBuilder that creates an empty 2d Component instance and stores its definition in Local 2D Component folder.
NXOpen::Layout2d::PublishComponentBuilder *	CreatePublishComponentBuilder ()
	Creates a Layout2d::PublishComponentBuilder that can export local definitions into external storage locations.
NXOpen::Layout2d::ReplaceComponentBuilder *	CreateReplaceComponentBuilder ()
	Creates a Layout2d::ReplaceComponentBuilder that can replace the selected 2d component instance with another 2d component definition.
NXOpen::Layout2d::SmashComponentBuilder *	CreateSmashComponentBuilder ()
	Creates a Layout2d::SmashComponentBuilder that can smash the selected 2d component instance.
iterator	end ()
	Returns an iterator addressing one past the last element.
NXOpen::Layout2d::Component *	FindObject (const NXString &journalIdentifier)
	Finds the Layout2d::Component with the given identifier as recorded in a journal.
NXOpen::Layout2d::Component *	FindObject (const char *journalIdentifier)
	Finds the Layout2d::Component with the given identifier as recorded in a journal.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a collection of Layout2d::Component s.

<br> To obtain an instance of this class, refer to @link Part  Part @endlink  <br> 

Created in NX9.0.0.

Member Function Documentation

iterator NXOpen::Layout2d::ComponentCollection::begin

(

)

Returns an iterator addressing the first element.

NXOpen::Layout2d::DefineComponentAnchorPointBuilder* NXOpen::Layout2d::ComponentCollection::CreateDefineComponentAnchorPointBuilder

(

)

Creates a Layout2d::DefineComponentAnchorPointBuilder that can define the Anchor Point location of a 2d component.

    @return  

Created in NX9.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

NXOpen::Layout2d::DefineComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreateDefineComponentBuilder

(

NXOpen::Layout2d::Component *

component

)

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

    @return  

Created in NX9.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

component

the component to be edited, NULL in case of new component view.

NXOpen::Layout2d::InsertComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreateInsertComponentBuilder

(

)

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

    @return  

Created in NX9.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

NXOpen::Layout2d::MakeComponentUniqueBuilder* NXOpen::Layout2d::ComponentCollection::CreateMakeComponentUniqueBuilder

(

)

Creates a Layout2d::MakeComponentUniqueBuilder that can create definition for the selected 2d component instance.

    @return  

Created in NX9.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

NXOpen::Layout2d::NewComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreateNewComponentBuilder

(

)

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

    @return  

Created in NX9.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

NXOpen::Layout2d::PublishComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreatePublishComponentBuilder

(

)

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

    @return  

Created in NX9.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

NXOpen::Layout2d::ReplaceComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreateReplaceComponentBuilder

(

)

Creates a Layout2d::ReplaceComponentBuilder that can replace the selected 2d component instance with another 2d component definition.

    @return  

Created in NX9.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

NXOpen::Layout2d::SmashComponentBuilder* NXOpen::Layout2d::ComponentCollection::CreateSmashComponentBuilder

(

)

Creates a Layout2d::SmashComponentBuilder that can smash the selected 2d component instance.

    @return  

Created in NX9.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

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 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.  @return  2d component with this identifier 

Created in NX9.0.0.

License requirements : None

Parameters

journalIdentifier

Identifier of the 2d component to be found

NXOpen::Layout2d::Component* NXOpen::Layout2d::ComponentCollection::FindObject

(

const char *

journalIdentifier

)

Finds the 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.  @return  2d component with this identifier 

Created in NX9.0.0.

License requirements : None

Parameters

journalIdentifier

Identifier of the 2d component to be found

tag_t NXOpen::Layout2d::ComponentCollection::Tag

(

)

const

Returns the tag of this object.

---

The documentation for this class was generated from the following file:

• Layout2d_ComponentCollection.hxx