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

The Builder to Model/UnModel the Terminals
To create a new instance of this class, use NXOpen::Routing::RouteManager::ModelTerminalsBuilder
Default values. More...

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

Public Types

enum  CutBackLocationOption { CutBackLocationOptionFromCharacteristic, CutBackLocationOptionUniformValue, CutBackLocationOptionIndividualCutbacks }
 The Enum for selecting the CutBack Option. More...
 
enum  ExtensionValueOption { ExtensionValueOptionFromCharacteristic, ExtensionValueOptionUniformValue, ExtensionValueOptionIndividualExtensions }
 The Enum for selecting the ExtensionValue Option. More...
 

Public Member Functions

NXOpen::Routing::ModelTerminalsBuilder::CutBackLocationOption CutbackOption ()
 Returns the cutback option
Created in NX7.5.0. More...
 
NXOpen::Routing::ModelTerminalsBuilder::ExtensionValueOption ExtensionOption ()
 Returns the extension option
Created in NX7.5.0. More...
 
NXOpen::TaggedObjectListList ()
 Returns the List Containing the Terminals and their properties. More...
 
void Model ()
 The Model the selected Terminals
Created in NX7.5.0. More...
 
void ModelAll ()
 The Model all the terminals
Created in NX7.5.0. More...
 
NXOpen::NXObjectMultiPort ()
 Returns the MultiPort of the selected object
Created in NX7.5.0. More...
 
NXOpen::Routing::SelectPortPortSelection ()
 Returns the port selection
Created in NX7.5.0. More...
 
bool PreviewToggle ()
 Returns the preview
Created in NX7.5.0. More...
 
void SetCutbackOption (NXOpen::Routing::ModelTerminalsBuilder::CutBackLocationOption cutbackOption)
 Sets the cutback option
Created in NX7.5.0. More...
 
void SetExtensionOption (NXOpen::Routing::ModelTerminalsBuilder::ExtensionValueOption extensionOption)
 Sets the extension option
Created in NX7.5.0. More...
 
void SetMultiPort (NXOpen::NXObject *port)
 Sets the MultiPort of the selected object
Created in NX7.5.0. More...
 
void SetPreviewToggle (bool preview)
 Sets the preview
Created in NX7.5.0. More...
 
void UnModel ()
 The UnModel the selected terminals
Created in NX7.5.0. More...
 
void UnModelAll ()
 Unmodel all of the terminals
Created in NX7.5.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

The Builder to Model/UnModel the Terminals
To create a new instance of this class, use NXOpen::Routing::RouteManager::ModelTerminalsBuilder
Default values.

Property Value

CutbackOption

FromCharacteristic

ExtensionOption

FromCharacteristic

PreviewToggle

0


Created in NX7.5.0.

Member Enumeration Documentation

The Enum for selecting the CutBack Option.

Enumerator
CutBackLocationOptionFromCharacteristic 

FromCharacteristic.

CutBackLocationOptionUniformValue 

UniformValue.

CutBackLocationOptionIndividualCutbacks 

IndividualValue.

The Enum for selecting the ExtensionValue Option.

Enumerator
ExtensionValueOptionFromCharacteristic 

FromCharacteristic.

ExtensionValueOptionUniformValue 

UniformValue.

ExtensionValueOptionIndividualExtensions 

IndividualValue.

Member Function Documentation

NXOpen::Routing::ModelTerminalsBuilder::CutBackLocationOption NXOpen::Routing::ModelTerminalsBuilder::CutbackOption ( )

Returns the cutback option
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

NXOpen::Routing::ModelTerminalsBuilder::ExtensionValueOption NXOpen::Routing::ModelTerminalsBuilder::ExtensionOption ( )

Returns the extension option
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

NXOpen::TaggedObjectList* NXOpen::Routing::ModelTerminalsBuilder::List ( )

Returns the List Containing the Terminals and their properties.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Routing::ModelTerminalsBuilder::Model ( )

The Model the selected Terminals
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

void NXOpen::Routing::ModelTerminalsBuilder::ModelAll ( )

The Model all the terminals
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

NXOpen::NXObject* NXOpen::Routing::ModelTerminalsBuilder::MultiPort ( )

Returns the MultiPort of the selected object
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

NXOpen::Routing::SelectPort* NXOpen::Routing::ModelTerminalsBuilder::PortSelection ( )

Returns the port selection
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

bool NXOpen::Routing::ModelTerminalsBuilder::PreviewToggle ( )

Returns the preview
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

void NXOpen::Routing::ModelTerminalsBuilder::SetCutbackOption ( NXOpen::Routing::ModelTerminalsBuilder::CutBackLocationOption  cutbackOption)

Sets the cutback option
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

Parameters
cutbackOptioncutbackoption
void NXOpen::Routing::ModelTerminalsBuilder::SetExtensionOption ( NXOpen::Routing::ModelTerminalsBuilder::ExtensionValueOption  extensionOption)

Sets the extension option
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

Parameters
extensionOptionextensionoption
void NXOpen::Routing::ModelTerminalsBuilder::SetMultiPort ( NXOpen::NXObject port)

Sets the MultiPort of the selected object
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

Parameters
portRouting Port
void NXOpen::Routing::ModelTerminalsBuilder::SetPreviewToggle ( bool  preview)

Sets the preview
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

Parameters
previewpreview
void NXOpen::Routing::ModelTerminalsBuilder::UnModel ( )

The UnModel the selected terminals
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

void NXOpen::Routing::ModelTerminalsBuilder::UnModelAll ( )

Unmodel all of the terminals
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")


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