The builder for creating the list item of RunItems
To create a new instance of this class, use Routing::DefineRunBuilder::CreateRunItemsBuilder

Created in NX8.5.0. More...

Inheritance diagram for NXOpen::Routing::RunItemsBuilder:

Public Member Functions
NXOpen::TaggedObject *	CurrentSelectedPort ()
	Returns the ports of FROM/TO item of the run.

NXOpen::TaggedObject *	GetVirtualStubItem (const NXString &virtualReferenceId)
	A virtual stub item to be used as From/To item.

NXOpen::TaggedObject *	GetVirtualStubItem (const char *virtualReferenceId)
	A virtual stub item to be used as From/To item.

NXOpen::SelectNXObjectList *	RunItems ()
	Returns the list item of run From/To item Created in NX8.5.0.

void	SetCurrentSelectedPort (NXOpen::TaggedObject *selectedPort)
	Sets the ports of FROM/TO item of the run.

void	SetSelectedItemData (NXOpen::TaggedObject scopedObject, const NXString &referenceId, const NXString &portName, const std::vector< NXOpen::TaggedObject > &availablePorts)
	The selected items data of the run Created in NX8.5.0.

void	SetSelectedItemData (NXOpen::TaggedObject scopedObject, const char referenceId, const char portName, const std::vector< NXOpen::TaggedObject > &availablePorts)
	The selected items data of the run Created in NX8.5.0.

void	SetVirtualReferenceId (const NXString &virtualRefIdFrom)
	Sets the virtual reference Id for FROM/TO items of a run.

void	SetVirtualReferenceId (const char *virtualRefIdFrom)
	Sets the virtual reference Id for FROM/TO items of a run.

NXString	VirtualReferenceId ()
	Returns the virtual reference Id for FROM/TO items of a run.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

The builder for creating the list item of RunItems
To create a new instance of this class, use Routing::DefineRunBuilder::CreateRunItemsBuilder

Created in NX8.5.0.

Member Function Documentation

NXOpen::TaggedObject* NXOpen::Routing::RunItemsBuilder::CurrentSelectedPort ( )

Returns the ports of FROM/TO item of the run.

Created in NX8.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

NXOpen::TaggedObject* NXOpen::Routing::RunItemsBuilder::GetVirtualStubItem ( const NXString & virtualReferenceId )

A virtual stub item to be used as From/To item.

Returns: Created in NX8.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

virtualReferenceId NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::TaggedObject* NXOpen::Routing::RunItemsBuilder::GetVirtualStubItem ( const char * virtualReferenceId )

A virtual stub item to be used as From/To item.

Returns: Created in NX8.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

virtualReferenceId NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::SelectNXObjectList* NXOpen::Routing::RunItemsBuilder::RunItems ( )

Returns the list item of run From/To item
Created in NX8.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::RunItemsBuilder::SetCurrentSelectedPort ( NXOpen::TaggedObject * selectedPort )

Sets the ports of FROM/TO item of the run.

Created in NX8.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

selectedPort selectedport

void NXOpen::Routing::RunItemsBuilder::SetSelectedItemData	(	NXOpen::TaggedObject *	scopedObject,
		const NXString &	referenceId,
		const NXString &	portName,
		const std::vector< NXOpen::TaggedObject * > &	availablePorts
	)

The selected items data of the run
Created in NX8.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

scopedObject	scopedobject
referenceId	NOTE: The full Unicode character set is not supported for this parameter.
portName	NOTE: The full Unicode character set is not supported for this parameter.
availablePorts	availableports

void NXOpen::Routing::RunItemsBuilder::SetSelectedItemData	(	NXOpen::TaggedObject *	scopedObject,
		const char *	referenceId,
		const char *	portName,
		const std::vector< NXOpen::TaggedObject * > &	availablePorts
	)

The selected items data of the run
Created in NX8.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

scopedObject	scopedobject
referenceId	NOTE: The full Unicode character set is not supported for this parameter.
portName	NOTE: The full Unicode character set is not supported for this parameter.
availablePorts	availableports

void NXOpen::Routing::RunItemsBuilder::SetVirtualReferenceId ( const NXString & virtualRefIdFrom )

Sets the virtual reference Id for FROM/TO items of a run.

Created in NX8.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

virtualRefIdFrom ReferenceId to create a stub item as FROM/TO item of a run.

void NXOpen::Routing::RunItemsBuilder::SetVirtualReferenceId ( const char * virtualRefIdFrom )

Sets the virtual reference Id for FROM/TO items of a run.

Created in NX8.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

virtualRefIdFrom ReferenceId to create a stub item as FROM/TO item of a run.

NXString NXOpen::Routing::RunItemsBuilder::VirtualReferenceId ( )

Returns the virtual reference Id for FROM/TO items of a run.

Created in NX8.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

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

Routing_RunItemsBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation