CreatePathBuilder Class

class NXOpen.MechanicalRouting.CreatePathBuilder

Bases: NXOpen.Builder

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

New in version NX11.0.0.

Properties

Property Description
BendCornerSettings Returns the builder to assign corners to the routing path.
CornerSettings Returns the builder to assign corners to the routing path.
PathTransitionListManagerBuilder Returns the builder for managing path transitions that make up the path.
PlaceDefaultElbow Returns or sets the setting to determine whether to assign the default elbow to new segments.
SimplifyPath Returns or sets the setting to determine whether to simplify the path by removing collinear extension Routing Control Points.
SnapAngle Returns or sets the angle tolerance to snap to a location that allows a valid placement of an elbow.
SnapToElbowAngles Returns or 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.
StockSettings Returns the builder for assigning stock to the new path.
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
CreatePathTransitionManagerBuilder Creates a NXOpen.MechanicalRouting.PathTransitionListManagerBuilder object.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetLogicalObjects Returns the :py:class:`PDM.LogicalObject`s that represent the content that will be created by this builder.
GetObject Returns the object currently being edited by this builder.
PreCommit Performs the operations needed prior to a commit.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

BendCornerSettings

CreatePathBuilder.BendCornerSettings

Returns the builder to assign corners to the routing path.

-------------------------------------

Getter Method

Signature BendCornerSettings

Returns:
Return type:NXOpen.MechanicalRouting.BendCornerTypeBuilder

New in version NX11.0.0.

Deprecated since version NX11.0.1: Use NXOpen.MechanicalRouting.CreatePathBuilder.CornerSettings() instead.

License requirements: routing_base (“Routing Basic”)

CornerSettings

CreatePathBuilder.CornerSettings

Returns the builder to assign corners to the routing path.

-------------------------------------

Getter Method

Signature CornerSettings

Returns:
Return type:NXOpen.MechanicalRouting.CornerBuilder

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

PathTransitionListManagerBuilder

CreatePathBuilder.PathTransitionListManagerBuilder

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

-------------------------------------

Getter Method

Signature PathTransitionListManagerBuilder

Returns:
Return type:NXOpen.MechanicalRouting.PathTransitionListManagerBuilder

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

PlaceDefaultElbow

CreatePathBuilder.PlaceDefaultElbow

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

-------------------------------------

Getter Method

Signature PlaceDefaultElbow

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature PlaceDefaultElbow

Parameters:placeDefaultElbow (bool) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

SimplifyPath

CreatePathBuilder.SimplifyPath

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

-------------------------------------

Getter Method

Signature SimplifyPath

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature SimplifyPath

Parameters:simplifyPath (bool) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

SnapAngle

CreatePathBuilder.SnapAngle

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

-------------------------------------

Getter Method

Signature SnapAngle

Returns:
Return type:float

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature SnapAngle

Parameters:snapAngle (float) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

SnapToElbowAngles

CreatePathBuilder.SnapToElbowAngles

Returns or 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.

-------------------------------------

Getter Method

Signature SnapToElbowAngles

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature SnapToElbowAngles

Parameters:snapToElbowAngles (bool) –

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

StockSettings

CreatePathBuilder.StockSettings

Returns the builder for assigning stock to the new path.

-------------------------------------

Getter Method

Signature StockSettings

Returns:
Return type:NXOpen.MechanicalRouting.PathStockPreferenceBuilder

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

Method Detail

CreatePathTransitionManagerBuilder

CreatePathBuilder.CreatePathTransitionManagerBuilder

Creates a NXOpen.MechanicalRouting.PathTransitionListManagerBuilder object.

Signature CreatePathTransitionManagerBuilder(workPart, workOcc, displayPart)

Parameters:
Returns:
Return type:

NXOpen.MechanicalRouting.PathTransitionListManagerBuilder

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

GetLogicalObjects

CreatePathBuilder.GetLogicalObjects

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

Signature GetLogicalObjects()

Returns:
Return type:list of NXOpen.PDM.LogicalObject

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

PreCommit

CreatePathBuilder.PreCommit

Performs the operations needed prior to a commit.

This method has to be called before invoking commit.

Signature PreCommit()

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

Validate

CreatePathBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.