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

Represents NXOpen::MechanicalRouting::CreatePathBuilder . More...

Inheritance diagram for NXOpen::MechanicalRouting::CreatePathBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::MechanicalRouting::BendCornerTypeBuilderBendCornerSettings ()
 Returns the builder to assign corners to the routing path. More...
 
NXOpen::MechanicalRouting::CornerBuilderCornerSettings ()
 Returns the builder to assign corners to the routing path. More...
 
NXOpen::MechanicalRouting::PathTransitionListManagerBuilderCreatePathTransitionManagerBuilder (NXOpen::Part *workPart, NXOpen::Assemblies::Component *workOcc, NXOpen::Part *displayPart)
 Creates a NXOpen::MechanicalRouting::PathTransitionListManagerBuilder object. More...
 
void GetLogicalObjects (std::vector< NXOpen::PDM::LogicalObject * > &logicalObjects)
 Returns the PDM::LogicalObject s that represent the content that will be created by this builder. More...
 
NXOpen::MechanicalRouting::PathTransitionListManagerBuilderPathTransitionListManagerBuilder ()
 Returns the builder for managing path transitions that make up the path. More...
 
bool PlaceDefaultElbow ()
 Returns the setting to determine whether to assign the default elbow to new segments. More...
 
void PreCommit ()
 Performs the operations needed prior to a commit. More...
 
void SetPlaceDefaultElbow (bool placeDefaultElbow)
 Sets the setting to determine whether to assign the default elbow to new segments. More...
 
void SetSimplifyPath (bool simplifyPath)
 Sets the setting to determine whether to simplify the path by removing collinear extension Routing Control Points. More...
 
void SetSnapAngle (double snapAngle)
 Sets the angle tolerance to snap to a location that allows a valid placement of an elbow. More...
 
void SetSnapToElbowAngles (bool snapToElbowAngles)
 Sets the setting to determine whether to force the new control point to automatically snap to a location that allows a valid placement of an elbow. More...
 
bool SimplifyPath ()
 Returns the setting to determine whether to simplify the path by removing collinear extension Routing Control Points. More...
 
double SnapAngle ()
 Returns the angle tolerance to snap to a location that allows a valid placement of an elbow. More...
 
bool SnapToElbowAngles ()
 Returns the setting to determine whether to force the new control point to automatically snap to a location that allows a valid placement of an elbow. More...
 
NXOpen::MechanicalRouting::PathStockPreferenceBuilderStockSettings ()
 Returns the builder for assigning stock to the new path. 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

Represents NXOpen::MechanicalRouting::CreatePathBuilder .

Allows the user to create routing path.
To create a new instance of this class, use NXOpen::MechanicalRouting::BuilderFactory::CreateCreatePathBuilder
Default values.

Property Value

BendCornerSettings.Method (deprecated)

Radius

BendCornerSettings.Radius.Value (deprecated)

0 (millimeters part), 0 (inches part)

BendCornerSettings.RatioToDiameter.Value (deprecated)

0 (millimeters part), 0 (inches part)

CornerSettings.CornerType

None


Created in NX11.0.0.

Member Function Documentation

NXOpen::MechanicalRouting::BendCornerTypeBuilder* NXOpen::MechanicalRouting::CreatePathBuilder::BendCornerSettings ( )

Returns the builder to assign corners to the routing path.


Deprecated:
Deprecated in NX11.0.1. Use NXOpen::MechanicalRouting::CreatePathBuilder::CornerSettings instead.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::MechanicalRouting::CornerBuilder* NXOpen::MechanicalRouting::CreatePathBuilder::CornerSettings ( )

Returns the builder to assign corners to the routing path.


Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

NXOpen::MechanicalRouting::PathTransitionListManagerBuilder* NXOpen::MechanicalRouting::CreatePathBuilder::CreatePathTransitionManagerBuilder ( NXOpen::Part workPart,
NXOpen::Assemblies::Component workOcc,
NXOpen::Part displayPart 
)

Creates a NXOpen::MechanicalRouting::PathTransitionListManagerBuilder object.

Returns

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
workPartworkpart
workOccworkocc
displayPartdisplaypart
void NXOpen::MechanicalRouting::CreatePathBuilder::GetLogicalObjects ( std::vector< NXOpen::PDM::LogicalObject * > &  logicalObjects)

Returns the PDM::LogicalObject s that represent the content that will be created by this builder.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
logicalObjectslogicalobjects
NXOpen::MechanicalRouting::PathTransitionListManagerBuilder* NXOpen::MechanicalRouting::CreatePathBuilder::PathTransitionListManagerBuilder ( )

Returns the builder for managing path transitions that make up the path.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::MechanicalRouting::CreatePathBuilder::PlaceDefaultElbow ( )

Returns the setting to determine whether to assign the default elbow to new segments.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::MechanicalRouting::CreatePathBuilder::PreCommit ( )

Performs the operations needed prior to a commit.

This method has to be called before invoking commit.
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::MechanicalRouting::CreatePathBuilder::SetPlaceDefaultElbow ( bool  placeDefaultElbow)

Sets the setting to determine whether to assign the default elbow to new segments.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
placeDefaultElbowplacedefaultelbow
void NXOpen::MechanicalRouting::CreatePathBuilder::SetSimplifyPath ( bool  simplifyPath)

Sets the setting to determine whether to simplify the path by removing collinear extension Routing Control Points.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
simplifyPathsimplifypath
void NXOpen::MechanicalRouting::CreatePathBuilder::SetSnapAngle ( double  snapAngle)

Sets the angle tolerance to snap to a location that allows a valid placement of an elbow.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
snapAnglesnapangle
void NXOpen::MechanicalRouting::CreatePathBuilder::SetSnapToElbowAngles ( bool  snapToElbowAngles)

Sets the setting to determine whether to force the new control point to automatically snap to a location that allows a valid placement of an elbow.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
snapToElbowAnglessnaptoelbowangles
bool NXOpen::MechanicalRouting::CreatePathBuilder::SimplifyPath ( )

Returns the setting to determine whether to simplify the path by removing collinear extension Routing Control Points.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

double NXOpen::MechanicalRouting::CreatePathBuilder::SnapAngle ( )

Returns the angle tolerance to snap to a location that allows a valid placement of an elbow.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::MechanicalRouting::CreatePathBuilder::SnapToElbowAngles ( )

Returns the setting to determine whether to force the new control point to automatically snap to a location that allows a valid placement of an elbow.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::MechanicalRouting::PathStockPreferenceBuilder* NXOpen::MechanicalRouting::CreatePathBuilder::StockSettings ( )

Returns the builder for assigning stock to the new path.


Created in NX11.0.0.

License requirements : 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.