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

Builder to edit required and optional characteristics of Routing::Stock or Assemblies::Component as defined in the application view file. More...

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

Public Member Functions

void ApplyReferenceObjectCharx (NXOpen::NXObject *refObject)
 Apply characteristics of the reference object to the selected objects. More...
 
void ClearValues ()
 Clear the characteristic values of the selected objects. More...
 
NXOpen::Routing::CharacteristicListGetOptionalCharacteristicsToEdit ()
 Returns the editable Routing::CharacteristicList that contains optional characteristics common to all the selected objects. More...
 
NXOpen::Routing::CharacteristicListGetRequiredCharacteristicsToEdit ()
 Returns the editable Routing::CharacteristicList that contains required characteristics common to all the selected objects. More...
 
NXOpen::SelectNXObjectReferenceObject ()
 Returns the reference object to obtain the characteristic values
Created in NX7.5.0. More...
 
void ResetValues ()
 Reset the characteristic values of the selected objects. More...
 
NXOpen::Routing::RouteObjectCollectorRouteObjectCollector ()
 Returns the routing objects to edit characteristics. More...
 
NXString RoutingLevel ()
 Returns the Routing Level associated with selected objects. More...
 
void SetRoutingLevel (const NXString &routeLevel)
 Sets the Routing Level associated with selected objects. More...
 
void SetRoutingLevel (const char *routeLevel)
 Sets the Routing Level associated with selected objects. 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 to edit required and optional characteristics of Routing::Stock or Assemblies::Component as defined in the application view file.


To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateEditCharacteristicsBuilder

Created in NX7.5.0.

Member Function Documentation

void NXOpen::Routing::EditCharacteristicsBuilder::ApplyReferenceObjectCharx ( NXOpen::NXObject refObject)

Apply characteristics of the reference object to the selected objects.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

Parameters
refObjectrefobject
void NXOpen::Routing::EditCharacteristicsBuilder::ClearValues ( )

Clear the characteristic values of the selected objects.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::CharacteristicList* NXOpen::Routing::EditCharacteristicsBuilder::GetOptionalCharacteristicsToEdit ( )

Returns the editable Routing::CharacteristicList that contains optional characteristics common to all the selected objects.

Returns
The characteristics to edit.
Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")
NXOpen::Routing::CharacteristicList* NXOpen::Routing::EditCharacteristicsBuilder::GetRequiredCharacteristicsToEdit ( )

Returns the editable Routing::CharacteristicList that contains required characteristics common to all the selected objects.

Returns
The characteristics to edit.
Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")
NXOpen::SelectNXObject* NXOpen::Routing::EditCharacteristicsBuilder::ReferenceObject ( )

Returns the reference object to obtain the characteristic values
Created in NX7.5.0.



License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::EditCharacteristicsBuilder::ResetValues ( )

Reset the characteristic values of the selected objects.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::RouteObjectCollector* NXOpen::Routing::EditCharacteristicsBuilder::RouteObjectCollector ( )

Returns the routing objects to edit characteristics.

The objects should be either Routing::Stock or Assemblies::Component
Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

NXString NXOpen::Routing::EditCharacteristicsBuilder::RoutingLevel ( )

Returns the Routing Level associated with selected objects.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::EditCharacteristicsBuilder::SetRoutingLevel ( const NXString routeLevel)

Sets the Routing Level associated with selected objects.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

Parameters
routeLevelroutelevel
void NXOpen::Routing::EditCharacteristicsBuilder::SetRoutingLevel ( const char *  routeLevel)

Sets the Routing Level associated with selected objects.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

Parameters
routeLevelroutelevel

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