NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Routing::OverstockBuilder Class Reference

Builder for creating/editing overstocks. More...

Inheritance diagram for NXOpen::Routing::OverstockBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  ApplicationType { ApplicationTypeEntireSegments, ApplicationTypeInterval, ApplicationTypePointToPoint, ApplicationTypePointAndLength }
 The overstock application type. More...
enum  PointType { PointTypeStart, PointTypeMiddle, PointTypeEnd }
 The defining point location. More...
enum  WrapType { WrapTypeOverlapSpiral, WrapTypeSpot, WrapTypeStripedSpiral }
 The application type for wrapped overstock. More...

Public Member Functions

NXOpen::Routing::OverstockBuilder::ApplicationType ApplicationMethod ()
 Returns the application method for overstock assignment.
NXOpen::GeometricUtilities::OnPathDimensionBuilderDefiningPoint ()
 Returns the defining point for Routing::OverstockBuilder::ApplicationTypePointAndLength method.
NXOpen::ExpressionDistance ()
 Returns the distance over which the pieces of overstock can possibly range for Routing::OverstockBuilder::ApplicationTypeInterval method.
bool DistanceLock ()
 Returns the distance lock state.
NXOpen::GeometricUtilities::OnPathDimensionBuilderEndOffset ()
 Returns the end offset value for Routing::OverstockBuilder::ApplicationTypeInterval method.
bool EndOffsetLock ()
 Returns the end offset lock state.
NXOpen::GeometricUtilities::OnPathDimensionBuilderEndPoint ()
 Returns the end point that defines the end of the overstock for Routing::OverstockBuilder::ApplicationTypePointToPoint method.
bool FlipStock ()
 Returns the stock flip flag
Created in NX6.0.1.
NXOpen::ExpressionGap ()
 Returns the gap from the end of one piece of overstock to the start of the next piece of overstock for Routing::OverstockBuilder::ApplicationTypeInterval method.
NXOpen::ExpressionGapDistance ()
 Returns the gap distance if the Routing::OverstockBuilder::WrapType is Routing::OverstockBuilder::WrapTypeStripedSpiral
Created in NX6.0.0.
bool GapLock ()
 Returns the gap lock state.
std::vector
< NXOpen::Routing::Stock * > 
GetCoveredStocks ()
 Returns the stocks to be covered by the overstock.
NXOpen::ExpressionIntervalPieceLength ()
 Returns the length of the overstock pieces for Routing::OverstockBuilder::ApplicationTypeInterval method.
NXOpen::ExpressionNumberOfPieces ()
 Returns the number of pieces of overstock to place along the path for Routing::OverstockBuilder::ApplicationTypeInterval method.
bool NumberOfPiecesLock ()
 Returns the number of pieces lock state.
NXOpen::ExpressionNumberOfWraps ()
 Returns the number of wraps if the Routing::OverstockBuilder::WrapType is Routing::OverstockBuilder::WrapTypeSpot
Created in NX6.0.0.
NXOpen::ExpressionOverlapPercentage ()
 Returns the percentage overlap if the Routing::OverstockBuilder::WrapType is Routing::OverstockBuilder::WrapTypeOverlapSpiral
Created in NX6.0.0.
NXOpen::CurvePathCurve ()
 Returns the path curve that is used to specify overstock defining points.
NXOpen::ExpressionPieceLength ()
 Returns the length over which overstock piece to be assigned for Routing::OverstockBuilder::ApplicationTypePointAndLength method.
bool PieceLengthLock ()
 Returns the piece length lock state.
NXOpen::Routing::OverstockBuilder::PointType PointDefines ()
 Returns the defining point location which can be any of Routing::OverstockBuilder::PointType for Routing::OverstockBuilder::ApplicationTypePointAndLength method.
NXOpen::ExpressionRotationValue ()
 Returns the rotation value.
NXOpen::Routing::RouteObjectCollectorSegmentCollector ()
 Returns the routing object collector to collect the segments to assign overstock to.
void SetApplicationMethod (NXOpen::Routing::OverstockBuilder::ApplicationType applicationMethod)
 Sets the application method for overstock assignment.
void SetCoveredStocks (const std::vector< NXOpen::Routing::Stock * > &stocks)
 Sets the stocks to be covered by the overstock.
void SetDistanceLock (bool distanceLock)
 Sets the distance lock state.
void SetEndOffsetLock (bool endOffsetLock)
 Sets the end offset lock state.
void SetFlipStock (bool flipStock)
 Sets the stock flip flag
Created in NX6.0.1.
void SetGapLock (bool gapLock)
 Sets the gap lock state.
void SetNumberOfPiecesLock (bool numberOfPiecesLock)
 Sets the number of pieces lock state.
void SetPieceLengthLock (bool pieceLengthLock)
 Sets the piece length lock state.
void SetPointDefines (NXOpen::Routing::OverstockBuilder::PointType pointDefines)
 Sets the defining point location which can be any of Routing::OverstockBuilder::PointType for Routing::OverstockBuilder::ApplicationTypePointAndLength method.
void SetStartOffsetLock (bool startOffsetLock)
 Sets the start offset lock state.
void SetStockAnchor (const NXString &anchorName)
 Sets the Routing::Anchor name associated with the overstock.
void SetStockSettings (NXOpen::Routing::PathStockBuilder *stockBuilder)
 Sets the stock settings for overstock assignment.
void SetSwapProfile (bool swapProfile)
 Sets the profile swap flag.
void SetSwitchStartEnd (bool switchStartEnd)
 Sets the path direction that defines the start of overstock assignment.
void SetWrapMethod (NXOpen::Routing::OverstockBuilder::WrapType wrapMethod)
 Sets the Routing::OverstockBuilder::WrapType for Wrapped overstock.
NXOpen::GeometricUtilities::OnPathDimensionBuilderStartOffset ()
 Returns the start offset value for Routing::OverstockBuilder::ApplicationTypeInterval method.
bool StartOffsetLock ()
 Returns the start offset lock state.
NXOpen::GeometricUtilities::OnPathDimensionBuilderStartPoint ()
 Returns the start point that defines the start of the overstock for Routing::OverstockBuilder::ApplicationTypePointToPoint method.
NXString StockAnchor ()
 Returns the Routing::Anchor name associated with the overstock.
NXOpen::Routing::PathStockBuilderStockSettings ()
 Returns the stock settings for overstock assignment.
bool SwapProfile ()
 Returns the profile swap flag.
bool 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.
NXOpen::Routing::OverstockBuilder::WrapType WrapMethod ()
 Returns the Routing::OverstockBuilder::WrapType for Wrapped overstock.

Detailed Description

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


Created in NX6.0.0.


Member Enumeration Documentation

The overstock application type.

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

Enumerator:
ApplicationTypeEntireSegments 

Entire Segments.

ApplicationTypeInterval 

Interval.

ApplicationTypePointToPoint 

Point To Point.

ApplicationTypePointAndLength 

Point And Length.

The defining point location.

This defines direction to go for the POINT and LENGTH method.

Enumerator:
PointTypeStart 

Start.

PointTypeMiddle 

Middle.

PointTypeEnd 

End.

The application type for wrapped overstock.

Enumerator:
WrapTypeOverlapSpiral 

Overlap Spiral.

WrapTypeSpot 

Spot.

WrapTypeStripedSpiral 

Striped Spiral.


Member Function Documentation

Returns the application method for overstock assignment.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the defining point for Routing::OverstockBuilder::ApplicationTypePointAndLength method.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the distance over which the pieces of overstock can possibly range for Routing::OverstockBuilder::ApplicationTypeInterval method.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the distance lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the end offset value for Routing::OverstockBuilder::ApplicationTypeInterval method.

It defins the MINIMUM distance from the end of the path to place the last piece of overstock.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the end offset lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the end point that defines the end of the overstock for Routing::OverstockBuilder::ApplicationTypePointToPoint method.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the stock flip flag
Created in NX6.0.1.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the gap from the end of one piece of overstock to the start of the next piece of overstock for Routing::OverstockBuilder::ApplicationTypeInterval method.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the gap distance if the Routing::OverstockBuilder::WrapType is Routing::OverstockBuilder::WrapTypeStripedSpiral
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the gap lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the stocks to be covered by the overstock.

Returns:

Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the length of the overstock pieces for Routing::OverstockBuilder::ApplicationTypeInterval 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.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the number of pieces of overstock to place along the path for Routing::OverstockBuilder::ApplicationTypeInterval method.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the number of pieces lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the number of wraps if the Routing::OverstockBuilder::WrapType is Routing::OverstockBuilder::WrapTypeSpot
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the percentage overlap if the Routing::OverstockBuilder::WrapType is Routing::OverstockBuilder::WrapTypeOverlapSpiral
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the length over which overstock piece to be assigned for Routing::OverstockBuilder::ApplicationTypePointAndLength method.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the piece length lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the defining point location which can be any of Routing::OverstockBuilder::PointType for Routing::OverstockBuilder::ApplicationTypePointAndLength method.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the rotation value.

Determines the rotation angle of the overstock.
Created in NX6.0.1.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Sets the application method for overstock assignment.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
applicationMethodapplicationmethod

Sets the stocks to be covered by the overstock.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stocksstocks

Sets the distance lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
distanceLockdistancelock

Sets the end offset lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
endOffsetLockendoffsetlock

Sets the stock flip flag
Created in NX6.0.1.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
flipStockflipstock

Sets the gap lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
gapLockgaplock

Sets the number of pieces lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
numberOfPiecesLocknumberofpieceslock

Sets the piece length lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
pieceLengthLockpiecelengthlock

Sets the defining point location which can be any of Routing::OverstockBuilder::PointType for Routing::OverstockBuilder::ApplicationTypePointAndLength method.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
pointDefinespointdefines

Sets the start offset lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startOffsetLockstartoffsetlock

Sets the Routing::Anchor name associated with the overstock.


Created in NX6.0.1.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
anchorNameanchorname

Sets the stock settings for overstock assignment.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockBuilderstockbuilder

Sets the profile swap flag.

Determines whether the profile should be at the path start or end.
Created in NX6.0.1.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
swapProfileswapprofile

Sets the path direction that defines the start of overstock assignment.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
switchStartEndswitchstartend

Sets the Routing::OverstockBuilder::WrapType for Wrapped overstock.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
wrapMethodwrapmethod

Returns the start offset value for Routing::OverstockBuilder::ApplicationTypeInterval method.

It defines the distance from the beginning of the path to place the first piece of overstock.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the start offset lock state.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the start point that defines the start of the overstock for Routing::OverstockBuilder::ApplicationTypePointToPoint method.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the Routing::Anchor name associated with the overstock.


Created in NX6.0.1.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the stock settings for overstock assignment.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the profile swap flag.

Determines whether the profile should be at the path start or end.
Created in NX6.0.1.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the Routing::OverstockBuilder::WrapType for Wrapped overstock.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.