PathTransitionBuilder Class¶
-
class
NXOpen.MechanicalRouting.
PathTransitionBuilder
¶ Bases:
NXOpen.Builder
Represents
NXOpen.MechanicalRouting.PathTransitionBuilder
.Allows the user to create a routing path transition.
To create a new instance of this class, use
NXOpen.MechanicalRouting.PathTransitionListManagerBuilder.CreatePathTransitionBuilder()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
AddExtensionToggle | Returns or sets the toggle to set forward/backward extensions for this transition. |
BackwardExtension | Returns or sets the backward extension length for this transition. |
BoxOrientation | Returns or sets the box orientation for heal transition traversal order. |
ConnectedObject | Returns or sets the object that the end point of this path transition connects to. |
EndPoint | Returns or sets the end point that defines the end of the path transition. |
ExtensionVector | Returns or sets the direction for extension segments. |
ForwardExtension | Returns or sets the forward extension length for this transition. |
HealSolutionCsys | Returns or sets the user-defined coordinate system for the NXOpen.MechanicalRouting.PathTransitionBuilderHealOrientation.NewCsys heal box orientation. |
HealTraversalOrder | Returns or sets the heal transition traversal order the path takes to reach the transition end point. |
PathForwardThroughExtensionVector | Returns or sets the toggle setting to define whether the path passes forward through the extension vector, or backward. |
Tag | Returns the Tag for this object. |
TransitionType | Returns or sets the type of transition the path takes to reach the transition end point. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
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. |
GetObject | Returns the object currently being edited by this builder. |
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. |
Enumerations¶
PathTransitionBuilderHealOrientation Enumeration | The box orientation for heal transition traversal order. |
PathTransitionBuilderTraversalOrder Enumeration | The heal transition traversal order the path takes to reach the transition end point. |
PathTransitionBuilderType Enumeration | The type of transition the path takes to reach the transition end point. |
Property Detail¶
AddExtensionToggle¶
-
PathTransitionBuilder.
AddExtensionToggle
¶ Returns or sets the toggle to set forward/backward extensions for this transition.
-------------------------------------
Getter Method
Signature
AddExtensionToggle
Returns: Return type: bool New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
AddExtensionToggle
Parameters: extensionToggle (bool) – New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
BackwardExtension¶
-
PathTransitionBuilder.
BackwardExtension
¶ Returns or sets the backward extension length for this transition.
-------------------------------------
Getter Method
Signature
BackwardExtension
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
BackwardExtension
Parameters: backwardExtension ( NXOpen.Expression
) –New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
BoxOrientation¶
-
PathTransitionBuilder.
BoxOrientation
¶ Returns or sets the box orientation for heal transition traversal order.
-------------------------------------
Getter Method
Signature
BoxOrientation
Returns: Return type: NXOpen.MechanicalRouting.PathTransitionBuilderHealOrientation
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
BoxOrientation
Parameters: boxOrientation ( NXOpen.MechanicalRouting.PathTransitionBuilderHealOrientation
) –New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
ConnectedObject¶
-
PathTransitionBuilder.
ConnectedObject
¶ Returns or sets the object that the end point of this path transition connects to.
If the transition connects to a port or a routing control point, it is required to set that object as the connected object to build connectivity.
-------------------------------------
Getter Method
Signature
ConnectedObject
Returns: Return type: NXOpen.NXObject
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
ConnectedObject
Parameters: connectedObject ( NXOpen.NXObject
) –New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
EndPoint¶
-
PathTransitionBuilder.
EndPoint
¶ Returns or sets the end point that defines the end of the path transition.
-------------------------------------
Getter Method
Signature
EndPoint
Returns: Return type: NXOpen.Point
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
EndPoint
Parameters: endPoint ( NXOpen.Point
) –New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
ExtensionVector¶
-
PathTransitionBuilder.
ExtensionVector
¶ Returns or sets the direction for extension segments.
-------------------------------------
Getter Method
Signature
ExtensionVector
Returns: Return type: NXOpen.Direction
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
ExtensionVector
Parameters: extensionVector ( NXOpen.Direction
) –New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
ForwardExtension¶
-
PathTransitionBuilder.
ForwardExtension
¶ Returns or sets the forward extension length for this transition.
-------------------------------------
Getter Method
Signature
ForwardExtension
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
ForwardExtension
Parameters: forwardExtension ( NXOpen.Expression
) –New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
HealSolutionCsys¶
-
PathTransitionBuilder.
HealSolutionCsys
¶ Returns or sets the user-defined coordinate system for the
NXOpen.MechanicalRouting.PathTransitionBuilderHealOrientation.NewCsys
heal box orientation.-------------------------------------
Getter Method
Signature
HealSolutionCsys
Returns: Return type: NXOpen.CoordinateSystem
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
HealSolutionCsys
Parameters: coordinateSystem ( NXOpen.CoordinateSystem
) –New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
HealTraversalOrder¶
-
PathTransitionBuilder.
HealTraversalOrder
¶ Returns or sets the heal transition traversal order the path takes to reach the transition end point.
-------------------------------------
Getter Method
Signature
HealTraversalOrder
Returns: Return type: NXOpen.MechanicalRouting.PathTransitionBuilderTraversalOrder
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
HealTraversalOrder
Parameters: healTraversalOrder ( NXOpen.MechanicalRouting.PathTransitionBuilderTraversalOrder
) –New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
PathForwardThroughExtensionVector¶
-
PathTransitionBuilder.
PathForwardThroughExtensionVector
¶ Returns or sets the toggle setting to define whether the path passes forward through the extension vector, or backward.
-------------------------------------
Getter Method
Signature
PathForwardThroughExtensionVector
Returns: Return type: bool New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
PathForwardThroughExtensionVector
Parameters: isPathForwardThroughExtensionVector (bool) – New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
TransitionType¶
-
PathTransitionBuilder.
TransitionType
¶ Returns or sets the type of transition the path takes to reach the transition end point.
-------------------------------------
Getter Method
Signature
TransitionType
Returns: Return type: NXOpen.MechanicalRouting.PathTransitionBuilderType
New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
TransitionType
Parameters: transitionType ( NXOpen.MechanicalRouting.PathTransitionBuilderType
) –New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
Validate¶
-
PathTransitionBuilder.
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.