NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Routing::RunItemsBuilder Class Reference

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

Created in NX8.5.0. More...

Inheritance diagram for NXOpen::Routing::RunItemsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::TaggedObjectCurrentSelectedPort ()
 Returns the ports of FROM/TO item of the run. More...
 
NXOpen::TaggedObjectGetVirtualStubItem (const NXString &virtualReferenceId)
 A virtual stub item to be used as From/To item. More...
 
NXOpen::TaggedObjectGetVirtualStubItem (const char *virtualReferenceId)
 A virtual stub item to be used as From/To item. More...
 
NXOpen::SelectNXObjectListRunItems ()
 Returns the list item of run From/To item
Created in NX8.5.0. More...
 
void SetCurrentSelectedPort (NXOpen::TaggedObject *selectedPort)
 Sets the ports of FROM/TO item of the run. More...
 
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. More...
 
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. More...
 
void SetVirtualReferenceId (const NXString &virtualRefIdFrom)
 Sets the virtual reference Id for FROM/TO items of a run. More...
 
void SetVirtualReferenceId (const char *virtualRefIdFrom)
 Sets the virtual reference Id for FROM/TO items of a run. More...
 
NXString VirtualReferenceId ()
 Returns the virtual reference Id for FROM/TO items of a run. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

The builder for creating the list item of RunItems
To create a new instance of this class, use NXOpen::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
virtualReferenceIdvirtualreferenceid
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
virtualReferenceIdvirtualreferenceid
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
selectedPortselectedport
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
scopedObjectscopedobject
referenceIdreferenceid
portNameportname
availablePortsavailableports
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
scopedObjectscopedobject
referenceIdreferenceid
portNameportname
availablePortsavailableports
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
virtualRefIdFromReferenceId 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
virtualRefIdFromReferenceId 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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.