public interface OverstockBuilder extends Builder
RouteManager.createOverstockBuilder(nxopen.routing.Overstock)
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 |
Modifier and Type | Interface and Description |
---|---|
static class |
OverstockBuilder.ApplicationType
The overstock application type.
|
static class |
OverstockBuilder.PointType
The defining point location.
|
static class |
OverstockBuilder.WrapType
The application type for wrapped overstock
|
Modifier and Type | Method and Description |
---|---|
OverstockBuilder.ApplicationType |
applicationMethod()
Returns the application method for overstock assignment.
|
OnPathDimensionBuilder |
definingPoint()
Returns the defining point for
OverstockBuilder.ApplicationType.POINT_AND_LENGTH method. |
Expression |
distance()
Returns the distance over which the pieces of overstock can possibly range for
OverstockBuilder.ApplicationType.INTERVAL
method. |
boolean |
distanceLock()
Returns the distance lock state.
|
OnPathDimensionBuilder |
endOffset()
Returns the end offset value for
OverstockBuilder.ApplicationType.INTERVAL
method. |
boolean |
endOffsetLock()
Returns the end offset lock state.
|
OnPathDimensionBuilder |
endPoint()
Returns the end point that defines the end of the overstock for
OverstockBuilder.ApplicationType.POINT_TO_POINT
method. |
boolean |
flipStock()
Returns the stock flip flag
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") . |
Expression |
gap()
Returns the gap from the end of one piece of overstock to the start of the next piece
of overstock for
OverstockBuilder.ApplicationType.INTERVAL method. |
Expression |
gapDistance()
Returns the gap distance if the
OverstockBuilder.WrapType
is OverstockBuilder.WrapType.STRIPED_SPIRAL
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") Created in NX6.0.0 |
boolean |
gapLock()
Returns the gap lock state.
|
Stock[] |
getCoveredStocks()
Returns the stocks to be covered by the overstock.
|
Expression |
intervalPieceLength()
Returns the length of the overstock pieces for
OverstockBuilder.ApplicationType.INTERVAL
method. |
Expression |
numberOfPieces()
Returns the number of pieces of overstock to place along the path for
OverstockBuilder.ApplicationType.INTERVAL
method. |
boolean |
numberOfPiecesLock()
Returns the number of pieces lock state.
|
Expression |
numberOfWraps()
Returns the number of wraps if the
OverstockBuilder.WrapType
is OverstockBuilder.WrapType.SPOT
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") Created in NX6.0.0 |
Expression |
overlapPercentage()
Returns the percentage overlap if the
OverstockBuilder.WrapType
is OverstockBuilder.WrapType.OVERLAP_SPIRAL
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") Created in NX6.0.0 |
Curve |
pathCurve()
Returns the path curve that is used to specify overstock defining points.
|
Expression |
pieceLength()
Returns the length over which overstock piece to be assigned for
OverstockBuilder.ApplicationType.POINT_AND_LENGTH method. |
boolean |
pieceLengthLock()
Returns the piece length lock state.
|
OverstockBuilder.PointType |
pointDefines()
Returns the defining point location which can be any of
OverstockBuilder.PointType
for OverstockBuilder.ApplicationType.POINT_AND_LENGTH method. |
Expression |
rotationValue()
Returns the rotation value.
|
RouteObjectCollector |
segmentCollector()
Returns the routing object collector to collect the segments to assign overstock to.
|
void |
setApplicationMethod(OverstockBuilder.ApplicationType applicationMethod)
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") . |
void |
setCoveredStocks(Stock[] stocks)
Sets the stocks to be covered by the overstock.
|
void |
setDistanceLock(boolean distanceLock)
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") . |
void |
setEndOffsetLock(boolean endOffsetLock)
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") . |
void |
setFlipStock(boolean flipStock)
Sets the stock flip flag
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") . |
void |
setGapLock(boolean gapLock)
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") . |
void |
setNumberOfPiecesLock(boolean numberOfPiecesLock)
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") . |
void |
setPieceLengthLock(boolean pieceLengthLock)
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") . |
void |
setPointDefines(OverstockBuilder.PointType pointDefines)
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") . |
void |
setStartOffsetLock(boolean startOffsetLock)
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") . |
void |
setStockAnchor(String anchorName)
Sets the
Anchor name associated with the overstock. |
void |
setStockSettings(PathStockBuilder stockBuilder)
Sets the stock settings for overstock assignment.
|
void |
setSwapProfile(boolean swapProfile)
Sets the profile swap flag.
|
void |
setSwitchStartEnd(boolean switchStartEnd)
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") . |
void |
setWrapMethod(OverstockBuilder.WrapType wrapMethod)
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") . |
OnPathDimensionBuilder |
startOffset()
Returns the start offset value for
OverstockBuilder.ApplicationType.INTERVAL
method. |
boolean |
startOffsetLock()
Returns the start offset lock state.
|
OnPathDimensionBuilder |
startPoint()
Returns the start point that defines the start of the overstock for
OverstockBuilder.ApplicationType.POINT_TO_POINT
method. |
String |
stockAnchor()
Returns the
Anchor name associated with the overstock. |
PathStockBuilder |
stockSettings()
Returns the stock settings for overstock assignment.
|
boolean |
swapProfile()
Returns the profile swap flag.
|
boolean |
switchStartEnd()
Returns the path direction that defines the start of overstock assignment.
|
void |
updatePathCurve()
Update the path curve that is used to specify overstock defining points
when any segment is selected or deselected.
|
OverstockBuilder.WrapType |
wrapMethod()
Returns the
OverstockBuilder.WrapType for Wrapped overstock. |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
RouteObjectCollector segmentCollector() throws NXException, RemoteException
NXException
RemoteException
PathStockBuilder stockSettings() throws NXException, RemoteException
NXException
RemoteException
void setStockSettings(PathStockBuilder stockBuilder) throws NXException, RemoteException
stockBuilder
- NXException
RemoteException
OverstockBuilder.ApplicationType applicationMethod() throws NXException, RemoteException
NXException
RemoteException
void setApplicationMethod(OverstockBuilder.ApplicationType applicationMethod) throws NXException, RemoteException
applicationMethod
- NXException
RemoteException
OnPathDimensionBuilder startOffset() throws NXException, RemoteException
OverstockBuilder.ApplicationType.INTERVAL
method. It defines the distance from the beginning of the path to place the
first piece of overstock.
NXException
RemoteException
boolean startOffsetLock() throws NXException, RemoteException
NXException
RemoteException
void setStartOffsetLock(boolean startOffsetLock) throws NXException, RemoteException
startOffsetLock
- NXException
RemoteException
OnPathDimensionBuilder endOffset() throws NXException, RemoteException
OverstockBuilder.ApplicationType.INTERVAL
method. It defins the MINIMUM distance from the end of the path to place
the last piece of overstock.
NXException
RemoteException
boolean endOffsetLock() throws NXException, RemoteException
NXException
RemoteException
void setEndOffsetLock(boolean endOffsetLock) throws NXException, RemoteException
endOffsetLock
- NXException
RemoteException
Expression distance() throws NXException, RemoteException
OverstockBuilder.ApplicationType.INTERVAL
method.
NXException
RemoteException
boolean distanceLock() throws NXException, RemoteException
NXException
RemoteException
void setDistanceLock(boolean distanceLock) throws NXException, RemoteException
distanceLock
- NXException
RemoteException
Expression gap() throws NXException, RemoteException
OverstockBuilder.ApplicationType.INTERVAL
method.
NXException
RemoteException
boolean gapLock() throws NXException, RemoteException
NXException
RemoteException
void setGapLock(boolean gapLock) throws NXException, RemoteException
gapLock
- NXException
RemoteException
Expression intervalPieceLength() throws NXException, RemoteException
OverstockBuilder.ApplicationType.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.
NXException
RemoteException
boolean pieceLengthLock() throws NXException, RemoteException
NXException
RemoteException
void setPieceLengthLock(boolean pieceLengthLock) throws NXException, RemoteException
pieceLengthLock
- NXException
RemoteException
Expression numberOfPieces() throws NXException, RemoteException
OverstockBuilder.ApplicationType.INTERVAL
method.
NXException
RemoteException
boolean numberOfPiecesLock() throws NXException, RemoteException
NXException
RemoteException
void setNumberOfPiecesLock(boolean numberOfPiecesLock) throws NXException, RemoteException
numberOfPiecesLock
- NXException
RemoteException
OnPathDimensionBuilder startPoint() throws NXException, RemoteException
OverstockBuilder.ApplicationType.POINT_TO_POINT
method.
NXException
RemoteException
OnPathDimensionBuilder endPoint() throws NXException, RemoteException
OverstockBuilder.ApplicationType.POINT_TO_POINT
method.
NXException
RemoteException
OnPathDimensionBuilder definingPoint() throws NXException, RemoteException
OverstockBuilder.ApplicationType.POINT_AND_LENGTH
method.
NXException
RemoteException
OverstockBuilder.PointType pointDefines() throws NXException, RemoteException
OverstockBuilder.PointType
for OverstockBuilder.ApplicationType.POINT_AND_LENGTH
method.
NXException
RemoteException
void setPointDefines(OverstockBuilder.PointType pointDefines) throws NXException, RemoteException
pointDefines
- NXException
RemoteException
Expression pieceLength() throws NXException, RemoteException
OverstockBuilder.ApplicationType.POINT_AND_LENGTH
method.
NXException
RemoteException
boolean switchStartEnd() throws NXException, RemoteException
NXException
RemoteException
void setSwitchStartEnd(boolean switchStartEnd) throws NXException, RemoteException
switchStartEnd
- NXException
RemoteException
OverstockBuilder.WrapType wrapMethod() throws NXException, RemoteException
OverstockBuilder.WrapType
for Wrapped overstock.
NXException
RemoteException
void setWrapMethod(OverstockBuilder.WrapType wrapMethod) throws NXException, RemoteException
wrapMethod
- NXException
RemoteException
Expression overlapPercentage() throws NXException, RemoteException
OverstockBuilder.WrapType
is OverstockBuilder.WrapType.OVERLAP_SPIRAL
NXException
RemoteException
Expression numberOfWraps() throws NXException, RemoteException
OverstockBuilder.WrapType
is OverstockBuilder.WrapType.SPOT
NXException
RemoteException
Expression gapDistance() throws NXException, RemoteException
OverstockBuilder.WrapType
is OverstockBuilder.WrapType.STRIPED_SPIRAL
NXException
RemoteException
boolean flipStock() throws NXException, RemoteException
NXException
RemoteException
void setFlipStock(boolean flipStock) throws NXException, RemoteException
flipStock
- NXException
RemoteException
boolean swapProfile() throws NXException, RemoteException
NXException
RemoteException
void setSwapProfile(boolean swapProfile) throws NXException, RemoteException
swapProfile
- NXException
RemoteException
Expression rotationValue() throws NXException, RemoteException
NXException
RemoteException
String stockAnchor() throws NXException, RemoteException
Anchor
name associated with the overstock.
NXException
RemoteException
void setStockAnchor(String anchorName) throws NXException, RemoteException
Anchor
name associated with the overstock.
anchorName
- NXException
RemoteException
Curve pathCurve() throws NXException, RemoteException
NXException
RemoteException
void updatePathCurve() throws NXException, RemoteException
NXException
RemoteException
Stock[] getCoveredStocks() throws NXException, RemoteException
NXException
RemoteException
void setCoveredStocks(Stock[] stocks) throws NXException, RemoteException
stocks
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.