RoutingPath Class¶
-
class
NXOpen.Preferences.
RoutingPath
¶ Bases:
object
The RoutingPath object stores a set of path preferences.
To obtain an instance of this class, refer to
NXOpen.Preferences.RoutingApplicationView
New in version NX4.0.0.
Methods¶
Method | Description |
---|---|
GetAllowedCorners | Query the types of corners allowed in an application view |
GetAllowedCurves | Query the types of curves allowed in an application view |
GetBendRadius | Needs a work part and a loaded applicaiton view. |
GetBendRadiusMethod | Query wether the default corner should use bend ratio. |
GetBendRadiusUnits | Query bend radius units stored in path preferences |
GetBendRatio | Query default bend ratio. |
GetBendTable | Query default bend table. |
GetBendTableFilenames | Query loaded bend table filenames. |
GetBendTableRadius | Query bend radius from a loaded bend table. |
GetBendTables | Query loaded bend table names. |
GetChainableCurveTypes | Query all the types of chainable curve types |
GetConfirmBranchSelection | Confirm branch selection during Path selection? |
GetContinueUpdateOnError | Query default down direction for fixed length splines |
GetCreateNewPointsOnSubdivide | Add points to subdivided splines to maintain shape? |
GetCreateSlopeConstraints | Create slope constraints during line path creation to and from fitting ports? |
GetCreateSmartRcps | Create smart RCPs during path creation? |
GetCreateSplineTangency | Create tangency between splines? |
GetCurveChainingMethod | Query path curve chaining method |
GetDefaultCorner | Query the default corner type in an application view |
GetDisplayAnchors | Display anchors? |
GetDisplayConnectedPorts | Display connected ports? |
GetDisplayPortLength | Displayed port length |
GetDisplayPorts | Display ports? |
GetDisplayRcps | Display RCPs? |
GetDisplaySegmentConstraints | Display segment constraints? |
GetHealPathCurveType | Heal Path curve type. |
GetMergeDuplicateRcps | Merge duplicate RCPs after a Transform [Move or Copy] operation? |
GetOccurrenceChainable | Query if curve occurrences [curves not in the work part] are chainable |
GetStockOffsetExpression | Query default stock offset expression used by Create Path and Create Stock Offset Port [via Qualify Part] |
LoadBendTableFile | Load a specified bend table file. |
SetAllowedCorners | |
SetAllowedCurves | |
SetBendRadius | Needs a work part and a loaded applicaiton view. |
SetBendRadiusMethod | Set whether the default corner should use bend ratio. |
SetBendRadiusUnits | |
SetBendRatio | |
SetBendTable | |
SetChainableCurveTypes | |
SetConfirmBranchSelection | |
SetContinueUpdateOnError | |
SetCreateNewPointsOnSubdivide | |
SetCreateSlopeConstraints | |
SetCreateSmartRcps | |
SetCreateSplineTangency | |
SetCurveChainingMethod | |
SetDefaultCorner | |
SetDisplayAnchors | |
SetDisplayConnectedPorts | Display connected ports in the model |
SetDisplayPortLength | |
SetDisplayPorts | Display ports in the model? |
SetDisplayRcps | |
SetDisplaySegmentConstraints | |
SetHealPathCurveType | |
SetMergeDuplicateRcps | |
SetOccurrenceChainable | |
SetStockOffsetExpression |
Enumerations¶
RoutingPathAddPointsToSpline Enumeration | Should points be added to existing spline when they are subdivided to preserve shape? |
RoutingPathAllowedCornerType Enumeration | Describes the types of corners allowed in a routing application. |
RoutingPathChainMethod Enumeration | Path curve chaining methods |
RoutingPathConfirmBranchSel Enumeration | Should a branch selection confirmation dialog be show during Path selection? |
RoutingPathContinueUpdOnError Enumeration | Should fixed length splines ignore length constraint violations and update? |
RoutingPathCreateSlopeConstraints Enumeration | Create slope associativity constraints during line path creation [from ports only] |
RoutingPathCreateSmartRcps Enumeration | Should Smart RCPs be created during path creation in Create Path? |
RoutingPathCreateTangency Enumeration | Should new splines form tangencies with existing splines when they’re created? |
RoutingPathCurveType Enumeration | Describes the types of curves allowed in a routing application. |
RoutingPathDefaultCornerType Enumeration | Describes the types of corners allowed in a routing application. |
RoutingPathDisplayObject Enumeration | Display a certain routing object? |
RoutingPathMergeDupRcps Enumeration | Should duplicate RCPs be merged after a Transform [Move or Copy] operation? |
RoutingPathOccChainable Enumeration | Chain occurrences of curves ? [i. |
RoutingPathRadiusMethod Enumeration | Describes method used to determine bend radius on a bend or sbend corner |
RoutingPathRadiusUnits Enumeration | Describes units of specified radius value NXOpen.Preferences.RoutingPathRadiusMethod.Radius only. |
Method Detail¶
GetAllowedCorners¶
-
RoutingPath.
GetAllowedCorners
¶ Query the types of corners allowed in an application view
Signature
GetAllowedCorners()
Returns: Return type: list of NXOpen.Preferences.RoutingPathAllowedCornerType
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetAllowedCurves¶
-
RoutingPath.
GetAllowedCurves
¶ Query the types of curves allowed in an application view
Signature
GetAllowedCurves()
Returns: Return type: list of NXOpen.Preferences.RoutingPathCurveType
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetBendRadius¶
-
RoutingPath.
GetBendRadius
¶ Needs a work part and a loaded applicaiton view.
Radius units are converted to work part units automatically. Returns -1 and quits if input requirements are not met.
Signature
GetBendRadius()
Returns: Return type: float New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetBendRadiusMethod¶
-
RoutingPath.
GetBendRadiusMethod
¶ Query wether the default corner should use bend ratio.
Signature
GetBendRadiusMethod()
Returns: Return type: NXOpen.Preferences.RoutingPathRadiusMethod
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetBendRadiusUnits¶
-
RoutingPath.
GetBendRadiusUnits
¶ Query bend radius units stored in path preferences
Signature
GetBendRadiusUnits()
Returns: Return type: NXOpen.Preferences.RoutingPathRadiusUnits
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetBendRatio¶
-
RoutingPath.
GetBendRatio
¶ Query default bend ratio.
Used when default corner uses bend ratio method
Signature
GetBendRatio()
Returns: Return type: float New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetBendTable¶
-
RoutingPath.
GetBendTable
¶ Query default bend table.
Used when default corner uses bend table method
Signature
GetBendTable()
Returns: Return type: str New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetBendTableFilenames¶
-
RoutingPath.
GetBendTableFilenames
¶ Query loaded bend table filenames.
A bend table file can contain one or more named bend tables. Loading a bend table file loads all its constituent tables into memory.
Signature
GetBendTableFilenames()
Returns: Return type: list of str New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetBendTableRadius¶
-
RoutingPath.
GetBendTableRadius
¶ Query bend radius from a loaded bend table.
Returns a radius of -1 if input table is not loaded
Signature
GetBendTableRadius(bendTableName, diameter)
Parameters: - bendTableName (str) –
- diameter (float) –
Returns: Return type: float
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetBendTables¶
-
RoutingPath.
GetBendTables
¶ Query loaded bend table names.
A bend table maps a stock outer diameter to a radius appropriate for a certain bending machine
Signature
GetBendTables()
Returns: Return type: list of str New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetChainableCurveTypes¶
-
RoutingPath.
GetChainableCurveTypes
¶ Query all the types of chainable curve types
Signature
GetChainableCurveTypes()
Returns: Return type: list of NXOpen.Preferences.RoutingPathCurveType
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetConfirmBranchSelection¶
-
RoutingPath.
GetConfirmBranchSelection
¶ Confirm branch selection during Path selection?
Signature
GetConfirmBranchSelection()
Returns: Return type: NXOpen.Preferences.RoutingPathConfirmBranchSel
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetContinueUpdateOnError¶
-
RoutingPath.
GetContinueUpdateOnError
¶ Query default down direction for fixed length splines
Signature
GetContinueUpdateOnError()
Returns: Return type: NXOpen.Preferences.RoutingPathContinueUpdOnError
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetCreateNewPointsOnSubdivide¶
-
RoutingPath.
GetCreateNewPointsOnSubdivide
¶ Add points to subdivided splines to maintain shape?
Signature
GetCreateNewPointsOnSubdivide()
Returns: Return type: NXOpen.Preferences.RoutingPathAddPointsToSpline
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
GetCreateSlopeConstraints¶
-
RoutingPath.
GetCreateSlopeConstraints
¶ Create slope constraints during line path creation to and from fitting ports?
Signature
GetCreateSlopeConstraints()
Returns: Return type: NXOpen.Preferences.RoutingPathCreateSlopeConstraints
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetCreateSmartRcps¶
-
RoutingPath.
GetCreateSmartRcps
¶ Create smart RCPs during path creation?
Signature
GetCreateSmartRcps()
Returns: Return type: NXOpen.Preferences.RoutingPathCreateSmartRcps
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetCreateSplineTangency¶
-
RoutingPath.
GetCreateSplineTangency
¶ Create tangency between splines?
Signature
GetCreateSplineTangency()
Returns: Return type: NXOpen.Preferences.RoutingPathCreateTangency
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
GetCurveChainingMethod¶
-
RoutingPath.
GetCurveChainingMethod
¶ Query path curve chaining method
Signature
GetCurveChainingMethod()
Returns: Return type: NXOpen.Preferences.RoutingPathChainMethod
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetDefaultCorner¶
-
RoutingPath.
GetDefaultCorner
¶ Query the default corner type in an application view
Signature
GetDefaultCorner()
Returns: Return type: NXOpen.Preferences.RoutingPathDefaultCornerType
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetDisplayAnchors¶
-
RoutingPath.
GetDisplayAnchors
¶ Display anchors?
Signature
GetDisplayAnchors()
Returns: Return type: NXOpen.Preferences.RoutingPathDisplayObject
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetDisplayConnectedPorts¶
-
RoutingPath.
GetDisplayConnectedPorts
¶ Display connected ports?
Signature
GetDisplayConnectedPorts()
Returns: Return type: NXOpen.Preferences.RoutingPathDisplayObject
New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
GetDisplayPortLength¶
-
RoutingPath.
GetDisplayPortLength
¶ Displayed port length
Signature
GetDisplayPortLength()
Returns: Return type: float New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetDisplayPorts¶
-
RoutingPath.
GetDisplayPorts
¶ Display ports?
Signature
GetDisplayPorts()
Returns: Return type: NXOpen.Preferences.RoutingPathDisplayObject
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetDisplayRcps¶
-
RoutingPath.
GetDisplayRcps
¶ Display RCPs?
Signature
GetDisplayRcps()
Returns: Return type: NXOpen.Preferences.RoutingPathDisplayObject
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetDisplaySegmentConstraints¶
-
RoutingPath.
GetDisplaySegmentConstraints
¶ Display segment constraints?
Signature
GetDisplaySegmentConstraints()
Returns: Return type: NXOpen.Preferences.RoutingPathDisplayObject
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetHealPathCurveType¶
-
RoutingPath.
GetHealPathCurveType
¶ Heal Path curve type.
Signature
GetHealPathCurveType()
Returns: Return type: NXOpen.Preferences.RoutingPathCurveType
New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
GetMergeDuplicateRcps¶
-
RoutingPath.
GetMergeDuplicateRcps
¶ Merge duplicate RCPs after a Transform [Move or Copy] operation?
Signature
GetMergeDuplicateRcps()
Returns: Return type: NXOpen.Preferences.RoutingPathMergeDupRcps
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetOccurrenceChainable¶
-
RoutingPath.
GetOccurrenceChainable
¶ Query if curve occurrences [curves not in the work part] are chainable
Signature
GetOccurrenceChainable()
Returns: Return type: NXOpen.Preferences.RoutingPathOccChainable
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetStockOffsetExpression¶
-
RoutingPath.
GetStockOffsetExpression
¶ Query default stock offset expression used by Create Path and Create Stock Offset Port [via Qualify Part]
Signature
GetStockOffsetExpression()
Returns: Return type: str New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
LoadBendTableFile¶
-
RoutingPath.
LoadBendTableFile
¶ Load a specified bend table file.
Signature
LoadBendTableFile(bendTableFilename)
Parameters: bendTableFilename (str) – Returns: Descriptive error text, when appropriate Return type: str New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetAllowedCorners¶
-
RoutingPath.
SetAllowedCorners
¶ Signature
SetAllowedCorners(allowedCorners)
Parameters: allowedCorners (list of NXOpen.Preferences.RoutingPathAllowedCornerType
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetAllowedCurves¶
-
RoutingPath.
SetAllowedCurves
¶ Signature
SetAllowedCurves(allowedCurves)
Parameters: allowedCurves (list of NXOpen.Preferences.RoutingPathCurveType
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetBendRadius¶
-
RoutingPath.
SetBendRadius
¶ Needs a work part and a loaded applicaiton view.
Radius units are assumed to be work part units and are set automatically. Returns -1 and quits if input requirements are not met.
Signature
SetBendRadius(bendRadius)
Parameters: bendRadius (float) – New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetBendRadiusMethod¶
-
RoutingPath.
SetBendRadiusMethod
¶ Set whether the default corner should use bend ratio.
Signature
SetBendRadiusMethod(radiusMethod)
Parameters: radiusMethod ( NXOpen.Preferences.RoutingPathRadiusMethod
) –New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetBendRadiusUnits¶
-
RoutingPath.
SetBendRadiusUnits
¶ Signature
SetBendRadiusUnits(radiusUnits)
Parameters: radiusUnits ( NXOpen.Preferences.RoutingPathRadiusUnits
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetBendRatio¶
-
RoutingPath.
SetBendRatio
¶ Signature
SetBendRatio(bendRatio)
Parameters: bendRatio (float) – New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetBendTable¶
-
RoutingPath.
SetBendTable
¶ Signature
SetBendTable(bendTableName)
Parameters: bendTableName (str) – New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetChainableCurveTypes¶
-
RoutingPath.
SetChainableCurveTypes
¶ Signature
SetChainableCurveTypes(chainableCurveTypes)
Parameters: chainableCurveTypes (list of NXOpen.Preferences.RoutingPathCurveType
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetConfirmBranchSelection¶
-
RoutingPath.
SetConfirmBranchSelection
¶ Signature
SetConfirmBranchSelection(confirmBranchSel)
Parameters: confirmBranchSel ( NXOpen.Preferences.RoutingPathConfirmBranchSel
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetContinueUpdateOnError¶
-
RoutingPath.
SetContinueUpdateOnError
¶ Signature
SetContinueUpdateOnError(update)
Parameters: update ( NXOpen.Preferences.RoutingPathContinueUpdOnError
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetCreateNewPointsOnSubdivide¶
-
RoutingPath.
SetCreateNewPointsOnSubdivide
¶ Signature
SetCreateNewPointsOnSubdivide(addPoints)
Parameters: addPoints ( NXOpen.Preferences.RoutingPathAddPointsToSpline
) –New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
SetCreateSlopeConstraints¶
-
RoutingPath.
SetCreateSlopeConstraints
¶ Signature
SetCreateSlopeConstraints(createSlopeConstraints)
Parameters: createSlopeConstraints ( NXOpen.Preferences.RoutingPathCreateSlopeConstraints
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetCreateSmartRcps¶
-
RoutingPath.
SetCreateSmartRcps
¶ Signature
SetCreateSmartRcps(createSmart)
Parameters: createSmart ( NXOpen.Preferences.RoutingPathCreateSmartRcps
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetCreateSplineTangency¶
-
RoutingPath.
SetCreateSplineTangency
¶ Signature
SetCreateSplineTangency(applyTangency)
Parameters: applyTangency ( NXOpen.Preferences.RoutingPathCreateTangency
) –New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
SetCurveChainingMethod¶
-
RoutingPath.
SetCurveChainingMethod
¶ Signature
SetCurveChainingMethod(chainMethod)
Parameters: chainMethod ( NXOpen.Preferences.RoutingPathChainMethod
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetDefaultCorner¶
-
RoutingPath.
SetDefaultCorner
¶ Signature
SetDefaultCorner(defaultCorner)
Parameters: defaultCorner ( NXOpen.Preferences.RoutingPathDefaultCornerType
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetDisplayAnchors¶
-
RoutingPath.
SetDisplayAnchors
¶ Signature
SetDisplayAnchors(displayAnchors)
Parameters: displayAnchors ( NXOpen.Preferences.RoutingPathDisplayObject
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetDisplayConnectedPorts¶
-
RoutingPath.
SetDisplayConnectedPorts
¶ Display connected ports in the model
Signature
SetDisplayConnectedPorts(displayConnectedPorts)
Parameters: displayConnectedPorts ( NXOpen.Preferences.RoutingPathDisplayObject
) –New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
SetDisplayPortLength¶
-
RoutingPath.
SetDisplayPortLength
¶ Signature
SetDisplayPortLength(displayPortLength)
Parameters: displayPortLength (float) – New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetDisplayPorts¶
-
RoutingPath.
SetDisplayPorts
¶ Display ports in the model?
Signature
SetDisplayPorts(displayPorts)
Parameters: displayPorts ( NXOpen.Preferences.RoutingPathDisplayObject
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetDisplayRcps¶
-
RoutingPath.
SetDisplayRcps
¶ Signature
SetDisplayRcps(displayRcps)
Parameters: displayRcps ( NXOpen.Preferences.RoutingPathDisplayObject
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetDisplaySegmentConstraints¶
-
RoutingPath.
SetDisplaySegmentConstraints
¶ Signature
SetDisplaySegmentConstraints(displayConstraints)
Parameters: displayConstraints ( NXOpen.Preferences.RoutingPathDisplayObject
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetHealPathCurveType¶
-
RoutingPath.
SetHealPathCurveType
¶ Signature
SetHealPathCurveType(healPathCurveType)
Parameters: healPathCurveType ( NXOpen.Preferences.RoutingPathCurveType
) –New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetMergeDuplicateRcps¶
-
RoutingPath.
SetMergeDuplicateRcps
¶ Signature
SetMergeDuplicateRcps(mergeDuplicates)
Parameters: mergeDuplicates ( NXOpen.Preferences.RoutingPathMergeDupRcps
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetOccurrenceChainable¶
-
RoutingPath.
SetOccurrenceChainable
¶ Signature
SetOccurrenceChainable(occChainable)
Parameters: occChainable ( NXOpen.Preferences.RoutingPathOccChainable
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)