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

Builder Class for Integrate Runs Object
To create a new instance of this class, use NXOpen::Routing::RouteManager::IntegrateRunsBuilder
Default values. More...

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

Public Types

enum  Button { ButtonFromItems, ButtonToItems, ButtonMemberItems, ButtonUnknown = -1 }
 Enums to distinguish callback's for from/to/member Item buttons. More...
 
enum  Enum { EnumFirstRun, EnumSecondRun }
 RunAttributes from which Run. More...
 

Public Member Functions

NXOpen::SelectNXObjectFirstRun ()
 Returns the first run
Created in NX8.0.0. More...
 
void ModifyItemsButton (const std::vector< NXOpen::NXObject * > &objects, NXOpen::Routing::IntegrateRunsBuilder::Button buttonType)
 Updates the selected nodes in Specify From/To item tree list to From/To/Member item based on buttonType
Created in NX8.0.0. More...
 
NXOpen::Routing::IntegrateRunsBuilder::Enum RunAttributes ()
 Returns the run attributes
Created in NX8.0.0. More...
 
NXString RunName ()
 Returns the user mentioned run name for Integrated Run
Created in NX8.0.0. More...
 
NXOpen::SelectNXObjectSecondRun ()
 Returns the second run
Created in NX8.0.0. More...
 
void SetRunAttributes (NXOpen::Routing::IntegrateRunsBuilder::Enum runAttributes)
 Sets the run attributes
Created in NX8.0.0. More...
 
void SetRunName (const NXString &runName)
 Sets the user mentioned run name for Integrated Run
Created in NX8.0.0. More...
 
void SetRunName (const char *runName)
 Sets the user mentioned run name for Integrated Run
Created in NX8.0.0. 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

Builder Class for Integrate Runs Object
To create a new instance of this class, use NXOpen::Routing::RouteManager::IntegrateRunsBuilder
Default values.

Property Value

RunAttributes

FirstRun


Created in NX8.0.0.

Member Enumeration Documentation

Enums to distinguish callback's for from/to/member Item buttons.

Enumerator
ButtonFromItems 

Set as FromItem for selected node in tree list.

ButtonToItems 

Set as ToItem for selected node in tree list.

ButtonMemberItems 

Set as MemberItem for selected node in tree list.

ButtonUnknown 

unknown button ID

RunAttributes from which Run.

Enumerator
EnumFirstRun 

first run

EnumSecondRun 

second run

Member Function Documentation

NXOpen::SelectNXObject* NXOpen::Routing::IntegrateRunsBuilder::FirstRun ( )

Returns the first run
Created in NX8.0.0.



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

void NXOpen::Routing::IntegrateRunsBuilder::ModifyItemsButton ( const std::vector< NXOpen::NXObject * > &  objects,
NXOpen::Routing::IntegrateRunsBuilder::Button  buttonType 
)

Updates the selected nodes in Specify From/To item tree list to From/To/Member item based on buttonType
Created in NX8.0.0.



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

Parameters
objectsobject of From/To/Member Items of a Run
buttonTypeModify the selected nodes to From,To,Member Items
NXOpen::Routing::IntegrateRunsBuilder::Enum NXOpen::Routing::IntegrateRunsBuilder::RunAttributes ( )

Returns the run attributes
Created in NX8.0.0.



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

NXString NXOpen::Routing::IntegrateRunsBuilder::RunName ( )

Returns the user mentioned run name for Integrated Run
Created in NX8.0.0.



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

NXOpen::SelectNXObject* NXOpen::Routing::IntegrateRunsBuilder::SecondRun ( )

Returns the second run
Created in NX8.0.0.



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

void NXOpen::Routing::IntegrateRunsBuilder::SetRunAttributes ( NXOpen::Routing::IntegrateRunsBuilder::Enum  runAttributes)

Sets the run attributes
Created in NX8.0.0.



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

Parameters
runAttributesrunattributes
void NXOpen::Routing::IntegrateRunsBuilder::SetRunName ( const NXString runName)

Sets the user mentioned run name for Integrated Run
Created in NX8.0.0.



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

Parameters
runNamerunname
void NXOpen::Routing::IntegrateRunsBuilder::SetRunName ( const char *  runName)

Sets the user mentioned run name for Integrated Run
Created in NX8.0.0.



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

Parameters
runNamerunname

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