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

Builder Class for DefineRun Object
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateDefineRunBuilder

Created in NX8.5.0. More...

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

Public Member Functions

void AddMemberItems (NXOpen::TaggedObject *memberItem)
 Append a member item to the list in the builder for DefineRun
Created in NX8.5.0. More...
 
NXOpen::Routing::RunItemsBuilderCreateRunItemsBuilder ()
 Creates a RunItems used to create list item for DefineRun. More...
 
NXOpen::Routing::RunItemsBuilderListFromItemsList ()
 Returns the FROM items list of the run. More...
 
NXOpen::Routing::RouteObjectCollectorMemberItems ()
 Returns the MEMBER items of the run. More...
 
void RemoveMemberItems (const std::vector< NXOpen::TaggedObject * > &memberItems)
 Remove a member item from the list in the builder for DefineRun
Created in NX8.5.0. More...
 
NXString RunIdentifier ()
 Returns the run identifier
Created in NX8.5.0. More...
 
NXString RunType ()
 Returns the run type
Created in NX8.5.0. More...
 
void SetRunIdentifier (const NXString &runIdentifier)
 Sets the run identifier
Created in NX8.5.0. More...
 
void SetRunIdentifier (const char *runIdentifier)
 Sets the run identifier
Created in NX8.5.0. More...
 
void SetRunType (const NXString &runType)
 Sets the run type
Created in NX8.5.0. More...
 
void SetRunType (const char *runType)
 Sets the run type
Created in NX8.5.0. More...
 
void SetSpecificationOption (const NXString &specificationOption)
 Sets the specification of the run. More...
 
void SetSpecificationOption (const char *specificationOption)
 Sets the specification of the run. More...
 
NXString SpecificationOption ()
 Returns the specification of the run. More...
 
NXOpen::Routing::RunItemsBuilderListToItemsList ()
 Returns the TO items list of the run . More...
 
void UnifyPath ()
 UnifyPath of the 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

Builder Class for DefineRun Object
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateDefineRunBuilder

Created in NX8.5.0.


Member Function Documentation

void NXOpen::Routing::DefineRunBuilder::AddMemberItems ( NXOpen::TaggedObject memberItem)

Append a member item to the list in the builder for DefineRun
Created in NX8.5.0.



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

Parameters
memberItemrun member item
NXOpen::Routing::RunItemsBuilder* NXOpen::Routing::DefineRunBuilder::CreateRunItemsBuilder ( )

Creates a RunItems used to create list item for DefineRun.

Returns
runItems builder
Created in NX8.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::RunItemsBuilderList* NXOpen::Routing::DefineRunBuilder::FromItemsList ( )

Returns the FROM items list of the run.

The list consists of NXOpen::Routing::DefineRunBuilder objects.
Created in NX8.5.0.

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

NXOpen::Routing::RouteObjectCollector* NXOpen::Routing::DefineRunBuilder::MemberItems ( )

Returns the MEMBER items of the run.


Created in NX8.5.0.

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

void NXOpen::Routing::DefineRunBuilder::RemoveMemberItems ( const std::vector< NXOpen::TaggedObject * > &  memberItems)

Remove a member item from the list in the builder for DefineRun
Created in NX8.5.0.



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

Parameters
memberItemsmember items to be removed from the run.
NXString NXOpen::Routing::DefineRunBuilder::RunIdentifier ( )

Returns the run identifier
Created in NX8.5.0.



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

NXString NXOpen::Routing::DefineRunBuilder::RunType ( )

Returns the run type
Created in NX8.5.0.



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

void NXOpen::Routing::DefineRunBuilder::SetRunIdentifier ( const NXString runIdentifier)

Sets the run identifier
Created in NX8.5.0.



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

Parameters
runIdentifierrunidentifier
void NXOpen::Routing::DefineRunBuilder::SetRunIdentifier ( const char *  runIdentifier)

Sets the run identifier
Created in NX8.5.0.



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

Parameters
runIdentifierrunidentifier
void NXOpen::Routing::DefineRunBuilder::SetRunType ( const NXString runType)

Sets the run type
Created in NX8.5.0.



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

Parameters
runTyperuntype
void NXOpen::Routing::DefineRunBuilder::SetRunType ( const char *  runType)

Sets the run type
Created in NX8.5.0.



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

Parameters
runTyperuntype
void NXOpen::Routing::DefineRunBuilder::SetSpecificationOption ( const NXString specificationOption)

Sets the specification of the run.


Created in NX8.5.0.

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

Parameters
specificationOptionspecificationoption
void NXOpen::Routing::DefineRunBuilder::SetSpecificationOption ( const char *  specificationOption)

Sets the specification of the run.


Created in NX8.5.0.

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

Parameters
specificationOptionspecificationoption
NXString NXOpen::Routing::DefineRunBuilder::SpecificationOption ( )

Returns the specification of the run.


Created in NX8.5.0.

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

NXOpen::Routing::RunItemsBuilderList* NXOpen::Routing::DefineRunBuilder::ToItemsList ( )

Returns the TO items list of the run .

The list consists of NXOpen::Routing::DefineRunBuilder objects.
Created in NX8.5.0.

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

void NXOpen::Routing::DefineRunBuilder::UnifyPath ( )

UnifyPath of the 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.