OverstockBuilder Class¶

class NXOpen.Routing.OverstockBuilder¶

Bases: NXOpen.Builder

Builder for creating/editing overstocks.

Create Overstock: This builder takes a set of segments and overstock and assign the the overstock on the segments depending on the applicatio method and parameters chosen by the user. Edit Overstock: This builder takes in the selected overstock to edit as input and redefines the overstock with the modified(by the user) parameters.

To create a new instance of this class, use NXOpen.Routing.RouteManager.CreateOverstockBuilder()

Default values.

Property	Value
ApplicationMethod	Interval
Distance.Value	0 (millimeters part), 0 (inches part)
DistanceLock	0
EndOffsetLock	0
FlipStock	0
Gap.Value	0 (millimeters part), 0 (inches part)
GapDistance.Value	1 (millimeters part), 1 (inches part)
GapLock	0
IntervalPieceLength.Value	0 (millimeters part), 0 (inches part)
NumberOfPieces.Value	1 (millimeters part), 1 (inches part)
NumberOfPiecesLock	0
NumberOfWraps.Value	2 (millimeters part), 2 (inches part)
OverlapPercentage.Value	50 (millimeters part), 50 (inches part)
PieceLength.Value	0 (millimeters part), 0 (inches part)
PieceLengthLock	0
PointDefines	Start
RotationValue.Value	0
StartOffsetLock	0
SwapProfile	0
WrapMethod	OverlapSpiral

New in version NX6.0.0.

Properties¶

Property	Description
ApplicationMethod	Returns or sets the application method for overstock assignment.
DefiningPoint	Returns the defining point for :py:class:` NXOpen.Routing.OverstockBuilderApplicationType.PointAndLength < NXOpen.Routing.OverstockBuilderApplicationType>` method.
Distance	Returns the distance over which the pieces of overstock can possibly range for `NXOpen.Routing.OverstockBuilderApplicationType.Interval` method.
DistanceLock	Returns or sets the distance lock state.
EndOffset	Returns the end offset value for `NXOpen.Routing.OverstockBuilderApplicationType.Interval` method.
EndOffsetLock	Returns or sets the end offset lock state.
EndPoint	Returns the end point that defines the end of the overstock for `NXOpen.Routing.OverstockBuilderApplicationType.PointToPoint` method.
FlipStock	Returns or sets the stock flip flag
Gap	Returns the gap from the end of one piece of overstock to the start of the next piece of overstock for `NXOpen.Routing.OverstockBuilderApplicationType.Interval` method.
GapDistance	Returns the gap distance if the `NXOpen.Routing.OverstockBuilderWrapType` is `NXOpen.Routing.OverstockBuilderWrapType.StripedSpiral`
GapLock	Returns or sets the gap lock state.
IntervalPieceLength	Returns the length of the overstock pieces for `NXOpen.Routing.OverstockBuilderApplicationType.Interval` method.
NumberOfPieces	Returns the number of pieces of overstock to place along the path for `NXOpen.Routing.OverstockBuilderApplicationType.Interval` method.
NumberOfPiecesLock	Returns or sets the number of pieces lock state.
NumberOfWraps	Returns the number of wraps if the `NXOpen.Routing.OverstockBuilderWrapType` is `NXOpen.Routing.OverstockBuilderWrapType.Spot`
OverlapPercentage	Returns the percentage overlap if the `NXOpen.Routing.OverstockBuilderWrapType` is `NXOpen.Routing.OverstockBuilderWrapType.OverlapSpiral`
PathCurve	Returns the path curve that is used to specify overstock defining points.
PieceLength	Returns the length over which overstock piece to be assigned for `NXOpen.Routing.OverstockBuilderApplicationType.PointAndLength` method.
PieceLengthLock	Returns or sets the piece length lock state.
PointDefines	Returns or sets the defining point location which can be any of `NXOpen.Routing.OverstockBuilderPointType` for :py:class:` NXOpen.Routing.OverstockBuilderApplicationType.PointAndLength < NXOpen.Routing.OverstockBuilderApplicationType>` method.
RotationValue	Returns the rotation value.
SegmentCollector	Returns the routing object collector to collect the segments to assign overstock to.
StartOffset	Returns the start offset value for `NXOpen.Routing.OverstockBuilderApplicationType.Interval` method.
StartOffsetLock	Returns or sets the start offset lock state.
StartPoint	Returns the start point that defines the start of the overstock for `NXOpen.Routing.OverstockBuilderApplicationType.PointToPoint` method.
StockAnchor	Returns or sets the `NXOpen.Routing.Anchor` name associated with the overstock.
StockSettings	Returns or sets the stock settings for overstock assignment.
SwapProfile	Returns or sets the profile swap flag.
SwitchStartEnd	Returns or sets the path direction that defines the start of overstock assignment.
Tag	Returns the Tag for this object.
WrapMethod	Returns or sets the `NXOpen.Routing.OverstockBuilderWrapType` for Wrapped overstock.

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.
GetCoveredStocks	Returns the stocks to be covered by the overstock.
GetNumberOfLayers	Returns the number of layers in case of wrapped overstock.
GetObject	Returns the object currently being edited by this builder.
IsOverlapDefinedByNumberOfLayers	Returns if wrapped overstock is defined by number of layers
SetCoveredStocks	Sets the stocks to be covered by the overstock.
SetNumberOfLayers	Sets the number of layers in case of wrapped overstock.
SetOverlapDefinedByNumberOfLayers	Sets wrapped overstock is to be defined by number of layers
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdatePathCurve	Update the path curve that is used to specify overstock defining points when any segment is selected or deselected.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations¶

OverstockBuilderApplicationType Enumeration	The overstock application type.
OverstockBuilderPointType Enumeration	The defining point location.
OverstockBuilderWrapType Enumeration	The application type for wrapped overstock

Property Detail¶

ApplicationMethod¶

OverstockBuilder.ApplicationMethod¶

Returns or sets the application method for overstock assignment.

It defines the way in which to create piggyback segment for overstock.

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

Getter Method

Signature ApplicationMethod

Returns:
Return type:	`NXOpen.Routing.OverstockBuilderApplicationType`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature ApplicationMethod

Parameters:	applicationMethod (`NXOpen.Routing.OverstockBuilderApplicationType`) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

DefiningPoint¶

OverstockBuilder.DefiningPoint¶

Returns the defining point for :py:class:` NXOpen.Routing.OverstockBuilderApplicationType.PointAndLength < NXOpen.Routing.OverstockBuilderApplicationType>` method.

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

Getter Method

Signature DefiningPoint

Returns:
Return type:	`NXOpen.GeometricUtilities.OnPathDimensionBuilder`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

Distance¶

OverstockBuilder.Distance¶

Returns the distance over which the pieces of overstock can possibly range for NXOpen.Routing.OverstockBuilderApplicationType.Interval method.

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

Getter Method

Signature Distance

Returns:
Return type:	`NXOpen.Expression`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

DistanceLock¶

OverstockBuilder.DistanceLock¶

Returns or sets the distance lock state.

If TRUE, changing the parameters will change other unlocked parameters to fit overstock along the selected path.

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

Getter Method

Signature DistanceLock

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature DistanceLock

Parameters:	distanceLock (bool) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

EndOffset¶

OverstockBuilder.EndOffset¶

Returns the end offset value for NXOpen.Routing.OverstockBuilderApplicationType.Interval method.

It defins the MINIMUM distance from the end of the path to place the last piece of overstock.

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

Getter Method

Signature EndOffset

Returns:
Return type:	`NXOpen.GeometricUtilities.OnPathDimensionBuilder`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

EndOffsetLock¶

OverstockBuilder.EndOffsetLock¶

Returns or sets the end offset lock state.

If TRUE, changing the parameters will change other unlocked parameters to fit overstock along the selected path.

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

Getter Method

Signature EndOffsetLock

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature EndOffsetLock

Parameters:	endOffsetLock (bool) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

EndPoint¶

OverstockBuilder.EndPoint¶

Returns the end point that defines the end of the overstock for NXOpen.Routing.OverstockBuilderApplicationType.PointToPoint method.

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

Getter Method

Signature EndPoint

Returns:
Return type:	`NXOpen.GeometricUtilities.OnPathDimensionBuilder`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

FlipStock¶

OverstockBuilder.FlipStock¶

Returns or sets the stock flip flag

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

Getter Method

Signature FlipStock

Returns:
Return type:	bool

New in version NX6.0.1.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature FlipStock

Parameters:	flipStock (bool) –

New in version NX6.0.1.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

Gap¶

OverstockBuilder.Gap¶

Returns the gap from the end of one piece of overstock to the start of the next piece of overstock for NXOpen.Routing.OverstockBuilderApplicationType.Interval method.

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

Getter Method

Signature Gap

Returns:
Return type:	`NXOpen.Expression`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

GapDistance¶

OverstockBuilder.GapDistance¶

Returns the gap distance if the NXOpen.Routing.OverstockBuilderWrapType is NXOpen.Routing.OverstockBuilderWrapType.StripedSpiral

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

Getter Method

Signature GapDistance

Returns:
Return type:	`NXOpen.Expression`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

GapLock¶

OverstockBuilder.GapLock¶

Returns or sets the gap lock state.

If TRUE, changing the parameters will change other unlocked parameters to fit overstock along the selected path.

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

Getter Method

Signature GapLock

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature GapLock

Parameters:	gapLock (bool) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

IntervalPieceLength¶

OverstockBuilder.IntervalPieceLength¶

Returns the length of the overstock pieces for NXOpen.Routing.OverstockBuilderApplicationType.Interval method.

If the overstock type is Wrapped, and the wrap method is set to Spot, the Piece Length is always the width of the overstock and is locked.

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

Getter Method

Signature IntervalPieceLength

Returns:
Return type:	`NXOpen.Expression`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

NumberOfPieces¶

OverstockBuilder.NumberOfPieces¶

Returns the number of pieces of overstock to place along the path for NXOpen.Routing.OverstockBuilderApplicationType.Interval method.

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

Getter Method

Signature NumberOfPieces

Returns:
Return type:	`NXOpen.Expression`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

NumberOfPiecesLock¶

OverstockBuilder.NumberOfPiecesLock¶

Returns or sets the number of pieces lock state.

If TRUE, changing the parameters will change other unlocked parameters to fit overstock along the selected path.

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

Getter Method

Signature NumberOfPiecesLock

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature NumberOfPiecesLock

Parameters:	numberOfPiecesLock (bool) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

NumberOfWraps¶

OverstockBuilder.NumberOfWraps¶

Returns the number of wraps if the NXOpen.Routing.OverstockBuilderWrapType is NXOpen.Routing.OverstockBuilderWrapType.Spot

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

Getter Method

Signature NumberOfWraps

Returns:
Return type:	`NXOpen.Expression`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

OverlapPercentage¶

OverstockBuilder.OverlapPercentage¶

Returns the percentage overlap if the NXOpen.Routing.OverstockBuilderWrapType is NXOpen.Routing.OverstockBuilderWrapType.OverlapSpiral

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

Getter Method

Signature OverlapPercentage

Returns:
Return type:	`NXOpen.Expression`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

PathCurve¶

OverstockBuilder.PathCurve¶

Returns the path curve that is used to specify overstock defining points.

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

Getter Method

Signature PathCurve

Returns:
Return type:	`NXOpen.Curve`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

PieceLength¶

OverstockBuilder.PieceLength¶

Returns the length over which overstock piece to be assigned for NXOpen.Routing.OverstockBuilderApplicationType.PointAndLength method.

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

Getter Method

Signature PieceLength

Returns:
Return type:	`NXOpen.Expression`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

PieceLengthLock¶

OverstockBuilder.PieceLengthLock¶

Returns or sets the piece length lock state.

If TRUE, changing the parameters will change other unlocked parameters to fit overstock along the selected path.

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

Getter Method

Signature PieceLengthLock

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature PieceLengthLock

Parameters:	pieceLengthLock (bool) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

PointDefines¶

OverstockBuilder.PointDefines¶

Returns or sets the defining point location which can be any of NXOpen.Routing.OverstockBuilderPointType for :py:class:` NXOpen.Routing.OverstockBuilderApplicationType.PointAndLength < NXOpen.Routing.OverstockBuilderApplicationType>` method.

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

Getter Method

Signature PointDefines

Returns:
Return type:	`NXOpen.Routing.OverstockBuilderPointType`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature PointDefines

Parameters:	pointDefines (`NXOpen.Routing.OverstockBuilderPointType`) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

RotationValue¶

OverstockBuilder.RotationValue¶

Returns the rotation value.

Determines the rotation angle of the overstock.

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

Getter Method

Signature RotationValue

Returns:
Return type:	`NXOpen.Expression`

New in version NX6.0.1.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

SegmentCollector¶

OverstockBuilder.SegmentCollector¶

Returns the routing object collector to collect the segments to assign overstock to.

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

Getter Method

Signature SegmentCollector

Returns:
Return type:	`NXOpen.Routing.RouteObjectCollector`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

StartOffset¶

OverstockBuilder.StartOffset¶

Returns the start offset value for NXOpen.Routing.OverstockBuilderApplicationType.Interval method.

It defines the distance from the beginning of the path to place the first piece of overstock.

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

Getter Method

Signature StartOffset

Returns:
Return type:	`NXOpen.GeometricUtilities.OnPathDimensionBuilder`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

StartOffsetLock¶

OverstockBuilder.StartOffsetLock¶

Returns or sets the start offset lock state.

If TRUE, changing the parameters will change other unlocked parameters to fit overstock along the selected path

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

Getter Method

Signature StartOffsetLock

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature StartOffsetLock

Parameters:	startOffsetLock (bool) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

StartPoint¶

OverstockBuilder.StartPoint¶

Returns the start point that defines the start of the overstock for NXOpen.Routing.OverstockBuilderApplicationType.PointToPoint method.

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

Getter Method

Signature StartPoint

Returns:
Return type:	`NXOpen.GeometricUtilities.OnPathDimensionBuilder`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

StockAnchor¶

OverstockBuilder.StockAnchor¶

Returns or sets the NXOpen.Routing.Anchor name associated with the overstock.

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

Getter Method

Signature StockAnchor

Returns:
Return type:	str

New in version NX6.0.1.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature StockAnchor

Parameters:	anchorName (str) –

New in version NX6.0.1.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

StockSettings¶

OverstockBuilder.StockSettings¶

Returns or sets the stock settings for overstock assignment.

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

Getter Method

Signature StockSettings

Returns:
Return type:	`NXOpen.Routing.PathStockBuilder`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature StockSettings

Parameters:	stockBuilder (`NXOpen.Routing.PathStockBuilder`) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

SwapProfile¶

OverstockBuilder.SwapProfile¶

Returns or sets the profile swap flag.

Determines whether the profile should be at the path start or end.

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

Getter Method

Signature SwapProfile

Returns:
Return type:	bool

New in version NX6.0.1.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature SwapProfile

Parameters:	swapProfile (bool) –

New in version NX6.0.1.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

SwitchStartEnd¶

OverstockBuilder.SwitchStartEnd¶

Returns or sets the path direction that defines the start of overstock assignment.

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

Getter Method

Signature SwitchStartEnd

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature SwitchStartEnd

Parameters:	switchStartEnd (bool) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

WrapMethod¶

OverstockBuilder.WrapMethod¶

Returns or sets the NXOpen.Routing.OverstockBuilderWrapType for Wrapped overstock.

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

Getter Method

Signature WrapMethod

Returns:
Return type:	`NXOpen.Routing.OverstockBuilderWrapType`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

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

Setter Method

Signature WrapMethod

Parameters:	wrapMethod (`NXOpen.Routing.OverstockBuilderWrapType`) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

Method Detail¶

GetCoveredStocks¶

OverstockBuilder.GetCoveredStocks¶

Returns the stocks to be covered by the overstock.

Signature GetCoveredStocks()

Returns:
Return type:	list of `NXOpen.Routing.Stock`

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

GetNumberOfLayers¶

OverstockBuilder.GetNumberOfLayers¶

Returns the number of layers in case of wrapped overstock.

Signature GetNumberOfLayers()

Returns:
Return type:	`NXOpen.Expression`

New in version NX11.0.1.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

IsOverlapDefinedByNumberOfLayers¶

OverstockBuilder.IsOverlapDefinedByNumberOfLayers¶

Returns if wrapped overstock is defined by number of layers

Signature IsOverlapDefinedByNumberOfLayers()

Returns:
Return type:	bool

New in version NX11.0.1.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

SetCoveredStocks¶

OverstockBuilder.SetCoveredStocks¶

Sets the stocks to be covered by the overstock.

Signature SetCoveredStocks(stocks)

Parameters:	stocks (list of `NXOpen.Routing.Stock`) –

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

SetNumberOfLayers¶

OverstockBuilder.SetNumberOfLayers¶

Sets the number of layers in case of wrapped overstock.

Signature SetNumberOfLayers(numberOfLayers)

Parameters:	numberOfLayers (`NXOpen.Expression`) –

New in version NX11.0.1.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

SetOverlapDefinedByNumberOfLayers¶

OverstockBuilder.SetOverlapDefinedByNumberOfLayers¶

Sets wrapped overstock is to be defined by number of layers

Signature SetOverlapDefinedByNumberOfLayers(isOverlapDefinedByNumberOfLayers)

Parameters:	isOverlapDefinedByNumberOfLayers (bool) –

New in version NX11.0.1.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

UpdatePathCurve¶

OverstockBuilder.UpdatePathCurve¶

Update the path curve that is used to specify overstock defining points when any segment is selected or deselected.

Signature UpdatePathCurve()

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)

Validate¶

OverstockBuilder.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.