Builder for creating/editing overstocks. More...

Inheritance diagram for NXOpen::Routing::OverstockBuilder:

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, WrapTypeUnknown }
	The application type for wrapped overstock. More...

Public Member Functions
NXOpen::Routing::OverstockBuilder::ApplicationType	ApplicationMethod ()
	Returns the application method for overstock assignment. More...

NXOpen::GeometricUtilities::OnPathDimensionBuilder *	DefiningPoint ()
	Returns the defining point for NXOpen::Routing::OverstockBuilder::ApplicationTypePointAndLength method. More...

NXOpen::Expression *	Distance ()
	Returns the distance over which the pieces of overstock can possibly range for NXOpen::Routing::OverstockBuilder::ApplicationTypeInterval method. More...

bool	DistanceLock ()
	Returns the distance lock state. More...

NXOpen::GeometricUtilities::OnPathDimensionBuilder *	EndOffset ()
	Returns the end offset value for NXOpen::Routing::OverstockBuilder::ApplicationTypeInterval method. More...

bool	EndOffsetLock ()
	Returns the end offset lock state. More...

NXOpen::GeometricUtilities::OnPathDimensionBuilder *	EndPoint ()
	Returns the end point that defines the end of the overstock for NXOpen::Routing::OverstockBuilder::ApplicationTypePointToPoint method. More...

bool	FlipStock ()
	Returns the stock flip flag Created in NX6.0.1. More...

NXOpen::Expression *	Gap ()
	Returns the gap from the end of one piece of overstock to the start of the next piece of overstock for NXOpen::Routing::OverstockBuilder::ApplicationTypeInterval method. More...

NXOpen::Expression *	GapDistance ()
	Returns the gap distance if the NXOpen::Routing::OverstockBuilder::WrapType is NXOpen::Routing::OverstockBuilder::WrapTypeStripedSpiral Created in NX6.0.0. More...

bool	GapLock ()
	Returns the gap lock state. More...

std::vector < NXOpen::Routing::Stock * >	GetCoveredStocks ()
	Returns the stocks to be covered by the overstock. More...

NXOpen::Expression *	GetNumberOfLayers ()
	Returns the number of layers in case of wrapped overstock. More...

NXOpen::Expression *	IntervalPieceLength ()
	Returns the length of the overstock pieces for NXOpen::Routing::OverstockBuilder::ApplicationTypeInterval method. More...

bool	IsOverlapDefinedByNumberOfLayers ()
	Returns if wrapped overstock is defined by number of layers. More...

NXOpen::Expression *	NumberOfPieces ()
	Returns the number of pieces of overstock to place along the path for NXOpen::Routing::OverstockBuilder::ApplicationTypeInterval method. More...

bool	NumberOfPiecesLock ()
	Returns the number of pieces lock state. More...

NXOpen::Expression *	NumberOfWraps ()
	Returns the number of wraps if the NXOpen::Routing::OverstockBuilder::WrapType is NXOpen::Routing::OverstockBuilder::WrapTypeSpot Created in NX6.0.0. More...

NXOpen::Expression *	OverlapPercentage ()
	Returns the percentage overlap if the NXOpen::Routing::OverstockBuilder::WrapType is NXOpen::Routing::OverstockBuilder::WrapTypeOverlapSpiral Created in NX6.0.0. More...

NXOpen::Curve *	PathCurve ()
	Returns the path curve that is used to specify overstock defining points. More...

NXOpen::Expression *	PieceLength ()
	Returns the length over which overstock piece to be assigned for NXOpen::Routing::OverstockBuilder::ApplicationTypePointAndLength method. More...

bool	PieceLengthLock ()
	Returns the piece length lock state. More...

NXOpen::Routing::OverstockBuilder::PointType	PointDefines ()
	Returns the defining point location which can be any of NXOpen::Routing::OverstockBuilder::PointType for NXOpen::Routing::OverstockBuilder::ApplicationTypePointAndLength method. More...

NXOpen::Expression *	RotationValue ()
	Returns the rotation value. More...

NXOpen::Routing::RouteObjectCollector *	SegmentCollector ()
	Returns the routing object collector to collect the segments to assign overstock to. More...

void	SetApplicationMethod (NXOpen::Routing::OverstockBuilder::ApplicationType applicationMethod)
	Sets the application method for overstock assignment. More...

void	SetCoveredStocks (const std::vector< NXOpen::Routing::Stock * > &stocks)
	Sets the stocks to be covered by the overstock. More...

void	SetDistanceLock (bool distanceLock)
	Sets the distance lock state. More...

void	SetEndOffsetLock (bool endOffsetLock)
	Sets the end offset lock state. More...

void	SetFlipStock (bool flipStock)
	Sets the stock flip flag Created in NX6.0.1. More...

void	SetGapLock (bool gapLock)
	Sets the gap lock state. More...

void	SetNumberOfLayers (NXOpen::Expression *numberOfLayers)
	Sets the number of layers in case of wrapped overstock. More...

void	SetNumberOfPiecesLock (bool numberOfPiecesLock)
	Sets the number of pieces lock state. More...

void	SetOverlapDefinedByNumberOfLayers (bool isOverlapDefinedByNumberOfLayers)
	Sets wrapped overstock is to be defined by number of layers Created in NX11.0.1. More...

void	SetPieceLengthLock (bool pieceLengthLock)
	Sets the piece length lock state. More...

void	SetPointDefines (NXOpen::Routing::OverstockBuilder::PointType pointDefines)
	Sets the defining point location which can be any of NXOpen::Routing::OverstockBuilder::PointType for NXOpen::Routing::OverstockBuilder::ApplicationTypePointAndLength method. More...

void	SetStartOffsetLock (bool startOffsetLock)
	Sets the start offset lock state. More...

void	SetStockAnchor (const NXString &anchorName)
	Sets the NXOpen::Routing::Anchor name associated with the overstock. More...

void	SetStockAnchor (const char *anchorName)
	Sets the NXOpen::Routing::Anchor name associated with the overstock. More...

void	SetStockSettings (NXOpen::Routing::PathStockBuilder *stockBuilder)
	Sets the stock settings for overstock assignment. More...

void	SetSwapProfile (bool swapProfile)
	Sets the profile swap flag. More...

void	SetSwitchStartEnd (bool switchStartEnd)
	Sets the path direction that defines the start of overstock assignment. More...

void	SetWrapMethod (NXOpen::Routing::OverstockBuilder::WrapType wrapMethod)
	Sets the NXOpen::Routing::OverstockBuilder::WrapType for Wrapped overstock. More...

NXOpen::GeometricUtilities::OnPathDimensionBuilder *	StartOffset ()
	Returns the start offset value for NXOpen::Routing::OverstockBuilder::ApplicationTypeInterval method. More...

bool	StartOffsetLock ()
	Returns the start offset lock state. More...

NXOpen::GeometricUtilities::OnPathDimensionBuilder *	StartPoint ()
	Returns the start point that defines the start of the overstock for NXOpen::Routing::OverstockBuilder::ApplicationTypePointToPoint method. More...

NXString	StockAnchor ()
	Returns the NXOpen::Routing::Anchor name associated with the overstock. More...

NXOpen::Routing::PathStockBuilder *	StockSettings ()
	Returns the stock settings for overstock assignment. More...

bool	SwapProfile ()
	Returns the profile swap flag. More...

bool	SwitchStartEnd ()
	Returns the path direction that defines the start of overstock assignment. More...

void	UpdatePathCurve ()
	Update the path curve that is used to specify overstock defining points when any segment is selected or deselected. More...

NXOpen::Routing::OverstockBuilder::WrapType	WrapMethod ()
	Returns the NXOpen::Routing::OverstockBuilder::WrapType for Wrapped overstock. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

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

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Routing::OverstockBuilder::ApplicationType

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.

enum NXOpen::Routing::OverstockBuilder::PointType

The defining point location.

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

Enumerator
PointTypeStart	Start.
PointTypeMiddle	Middle.
PointTypeEnd	End.

enum NXOpen::Routing::OverstockBuilder::WrapType

The application type for wrapped overstock.

Enumerator
WrapTypeOverlapSpiral	Overlap Spiral.
WrapTypeSpot	Spot.
WrapTypeStripedSpiral	Striped Spiral.
WrapTypeUnknown	unknown

Member Function Documentation

NXOpen::Routing::OverstockBuilder::ApplicationType NXOpen::Routing::OverstockBuilder::ApplicationMethod ( )

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_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")

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Routing::OverstockBuilder::DefiningPoint ( )

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

Created in 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")

NXOpen::Expression* NXOpen::Routing::OverstockBuilder::Distance ( )

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

Created in 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")

bool NXOpen::Routing::OverstockBuilder::DistanceLock ( )

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_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")

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Routing::OverstockBuilder::EndOffset ( )

Returns the end offset value for NXOpen::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_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")

bool NXOpen::Routing::OverstockBuilder::EndOffsetLock ( )

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_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")

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Routing::OverstockBuilder::EndPoint ( )

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

Created in 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")

bool NXOpen::Routing::OverstockBuilder::FlipStock ( )

Returns the stock flip flag
Created in 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")

NXOpen::Expression* NXOpen::Routing::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::OverstockBuilder::ApplicationTypeInterval method.

Created in 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")

NXOpen::Expression* NXOpen::Routing::OverstockBuilder::GapDistance ( )

Returns the gap distance if the NXOpen::Routing::OverstockBuilder::WrapType is NXOpen::Routing::OverstockBuilder::WrapTypeStripedSpiral
Created in 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")

bool NXOpen::Routing::OverstockBuilder::GapLock ( )

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_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")

std::vector<NXOpen::Routing::Stock *> NXOpen::Routing::OverstockBuilder::GetCoveredStocks ( )

Returns the stocks to be covered by the overstock.

Returns: Created in 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")

NXOpen::Expression* NXOpen::Routing::OverstockBuilder::GetNumberOfLayers ( )

Returns the number of layers in case of wrapped overstock.

Returns: Created in 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")

NXOpen::Expression* NXOpen::Routing::OverstockBuilder::IntervalPieceLength ( )

Returns the length of the overstock pieces for NXOpen::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_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")

bool NXOpen::Routing::OverstockBuilder::IsOverlapDefinedByNumberOfLayers ( )

Returns if wrapped overstock is defined by number of layers.

Returns: Created in 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")

NXOpen::Expression* NXOpen::Routing::OverstockBuilder::NumberOfPieces ( )

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

Created in 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")

bool NXOpen::Routing::OverstockBuilder::NumberOfPiecesLock ( )

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_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")

NXOpen::Expression* NXOpen::Routing::OverstockBuilder::NumberOfWraps ( )

Returns the number of wraps if the NXOpen::Routing::OverstockBuilder::WrapType is NXOpen::Routing::OverstockBuilder::WrapTypeSpot
Created in 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")

NXOpen::Expression* NXOpen::Routing::OverstockBuilder::OverlapPercentage ( )

Returns the percentage overlap if the NXOpen::Routing::OverstockBuilder::WrapType is NXOpen::Routing::OverstockBuilder::WrapTypeOverlapSpiral
Created in 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")

NXOpen::Curve* NXOpen::Routing::OverstockBuilder::PathCurve ( )

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

Created in 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")

NXOpen::Expression* NXOpen::Routing::OverstockBuilder::PieceLength ( )

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

Created in 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")

bool NXOpen::Routing::OverstockBuilder::PieceLengthLock ( )

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_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")

NXOpen::Routing::OverstockBuilder::PointType NXOpen::Routing::OverstockBuilder::PointDefines ( )

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

Created in 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")

NXOpen::Expression* NXOpen::Routing::OverstockBuilder::RotationValue ( )

Returns the rotation value.

Determines the rotation angle of the overstock.
Created in 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")

NXOpen::Routing::RouteObjectCollector* NXOpen::Routing::OverstockBuilder::SegmentCollector ( )

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

Created in 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")

void NXOpen::Routing::OverstockBuilder::SetApplicationMethod ( NXOpen::Routing::OverstockBuilder::ApplicationType applicationMethod )

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_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")

Parameters

applicationMethod applicationmethod

void NXOpen::Routing::OverstockBuilder::SetCoveredStocks ( const std::vector< NXOpen::Routing::Stock * > & stocks )

Sets the stocks to be covered by the overstock.

Created in 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")

Parameters

stocks stocks

void NXOpen::Routing::OverstockBuilder::SetDistanceLock ( bool distanceLock )

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_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")

Parameters

distanceLock distancelock

void NXOpen::Routing::OverstockBuilder::SetEndOffsetLock ( bool endOffsetLock )

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_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")

Parameters

endOffsetLock endoffsetlock

void NXOpen::Routing::OverstockBuilder::SetFlipStock ( bool flipStock )

Sets the stock flip flag
Created in 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")

Parameters

flipStock flipstock

void NXOpen::Routing::OverstockBuilder::SetGapLock ( bool gapLock )

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_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")

Parameters

gapLock gaplock

void NXOpen::Routing::OverstockBuilder::SetNumberOfLayers ( NXOpen::Expression * numberOfLayers )

Sets the number of layers in case of wrapped overstock.

Created in 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")

Parameters

numberOfLayers numberoflayers

void NXOpen::Routing::OverstockBuilder::SetNumberOfPiecesLock ( bool numberOfPiecesLock )

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_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")

Parameters

numberOfPiecesLock numberofpieceslock

void NXOpen::Routing::OverstockBuilder::SetOverlapDefinedByNumberOfLayers ( bool isOverlapDefinedByNumberOfLayers )

Sets wrapped overstock is to be defined by number of layers
Created in 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")

Parameters

isOverlapDefinedByNumberOfLayers isoverlapdefinedbynumberoflayers

void NXOpen::Routing::OverstockBuilder::SetPieceLengthLock ( bool pieceLengthLock )

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_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")

Parameters

pieceLengthLock piecelengthlock

void NXOpen::Routing::OverstockBuilder::SetPointDefines ( NXOpen::Routing::OverstockBuilder::PointType pointDefines )

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

Created in 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")

Parameters

pointDefines pointdefines

void NXOpen::Routing::OverstockBuilder::SetStartOffsetLock ( bool startOffsetLock )

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_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")

Parameters

startOffsetLock startoffsetlock

void NXOpen::Routing::OverstockBuilder::SetStockAnchor ( const NXString & anchorName )

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

Created in 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")

Parameters

anchorName anchorname

void NXOpen::Routing::OverstockBuilder::SetStockAnchor ( const char * anchorName )

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

Created in 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")

Parameters

anchorName anchorname

void NXOpen::Routing::OverstockBuilder::SetStockSettings ( NXOpen::Routing::PathStockBuilder * stockBuilder )

Sets the stock settings for overstock assignment.

Created in 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")

Parameters

stockBuilder stockbuilder

void NXOpen::Routing::OverstockBuilder::SetSwapProfile ( bool swapProfile )

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_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")

Parameters

swapProfile swapprofile

void NXOpen::Routing::OverstockBuilder::SetSwitchStartEnd ( bool switchStartEnd )

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

Created in 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")

Parameters

switchStartEnd switchstartend

void NXOpen::Routing::OverstockBuilder::SetWrapMethod ( NXOpen::Routing::OverstockBuilder::WrapType wrapMethod )

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

Created in 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")

Parameters

wrapMethod wrapmethod

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Routing::OverstockBuilder::StartOffset ( )

Returns the start offset value for NXOpen::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_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")

bool NXOpen::Routing::OverstockBuilder::StartOffsetLock ( )

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_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")

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Routing::OverstockBuilder::StartPoint ( )

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

Created in 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")

NXString NXOpen::Routing::OverstockBuilder::StockAnchor ( )

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

Created in 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")

NXOpen::Routing::PathStockBuilder* NXOpen::Routing::OverstockBuilder::StockSettings ( )

Returns the stock settings for overstock assignment.

Created in 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")

bool NXOpen::Routing::OverstockBuilder::SwapProfile ( )

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_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")

bool NXOpen::Routing::OverstockBuilder::SwitchStartEnd ( )

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

Created in 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")

void NXOpen::Routing::OverstockBuilder::UpdatePathCurve ( )

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_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")

NXOpen::Routing::OverstockBuilder::WrapType NXOpen::Routing::OverstockBuilder::WrapMethod ( )

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

Created in 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")

The documentation for this class was generated from the following file:

Routing_OverstockBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation