NXOpen::Routing::OverstockApplicationCollection Class Reference

Represents a collection of NXOpen::Routing::OverstockApplication objects. More...

Inheritance diagram for NXOpen::Routing::OverstockApplicationCollection:

Classes
class	iterator
	Iterator for accessing the contents of the collection. More...

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element. More...
NXOpen::Routing::OverstockApplication *	ConvertOverstockApplication (NXOpen::Routing::ControlPoint *startControlPoint, const std::vector< NXOpen::Routing::ISegment * > &segments, const std::vector< NXOpen::Routing::Stock * > &stocks, NXOpen::Routing::CharacteristicList *overstockPart, NXOpen::Routing::CharacteristicList *reqOptCharxList, NXOpen::Expression *wrapValue, const std::vector< NXOpen::Routing::Overstock * > &overstocks)
	Converts an existing NXOpen::Routing::Overstock to Routing::MethodEntireSegments overstock. More...
NXOpen::Routing::OverstockApplication *	ConvertOverstockApplication (NXOpen::Routing::ControlPoint *startControlPoint, const std::vector< NXOpen::Routing::ISegment * > &segments, const std::vector< NXOpen::Routing::Stock * > &stocks, NXOpen::Expression *startOffset, NXOpen::Expression *endOffset, NXOpen::Expression *pieceLength, NXOpen::Expression *gap, NXOpen::Expression *numberOfPieces, NXOpen::Point *startPoint, NXOpen::Routing::CharacteristicList *overstockPart, NXOpen::Routing::CharacteristicList *reqOptCharxList, NXOpen::Expression *wrapValue, const std::vector< NXOpen::Routing::Overstock * > &overstocks)
	Converts an existing NXOpen::Routing::Overstock to Routing::MethodInterval overstock. More...
NXOpen::Routing::OverstockApplication *	ConvertOverstockApplication (NXOpen::Routing::ControlPoint *startControlPoint, const std::vector< NXOpen::Routing::ISegment * > &segments, const std::vector< NXOpen::Routing::Stock * > &stocks, NXOpen::Point *startPoint, NXOpen::Point *endPoint, NXOpen::Routing::CharacteristicList *overstockPart, NXOpen::Routing::CharacteristicList *reqOptCharxList, NXOpen::Expression *wrapValue, const std::vector< NXOpen::Routing::Overstock * > &overstocks)
	Converts an existing NXOpen::Routing::Overstock to Routing::MethodPointToPoint overstock. More...
NXOpen::Routing::OverstockApplication *	ConvertOverstockApplication (NXOpen::Routing::ControlPoint *startControlPoint, const std::vector< NXOpen::Routing::ISegment * > &segments, const std::vector< NXOpen::Routing::Stock * > &stocks, NXOpen::Point *definingPoint, NXOpen::Routing::PointDefinition definingDirection, NXOpen::Expression *pieceLength, NXOpen::Routing::CharacteristicList *overstockPart, NXOpen::Routing::CharacteristicList *reqOptCharxList, NXOpen::Expression *wrapValue, const std::vector< NXOpen::Routing::Overstock * > &overstocks)
	Converts an existing NXOpen::Routing::Overstock to Routing::MethodPointAndLength overstock. More...
NXOpen::Routing::OverstockApplication *	CreateOverstockApplication (NXOpen::Routing::ControlPoint *startControlPoint, const std::vector< NXOpen::Routing::ISegment * > &segments, const std::vector< NXOpen::Routing::Stock * > &stocks, NXOpen::Routing::CharacteristicList *overstockPart, NXOpen::Routing::WrapApplicationType stockWrapType, NXOpen::Expression *wrapValue)
	Creates the Routing::MethodEntireSegments overstock. More...
NXOpen::Routing::OverstockApplication *	CreateOverstockApplication (NXOpen::Routing::ControlPoint *startControlPoint, const std::vector< NXOpen::Routing::ISegment * > &segments, const std::vector< NXOpen::Routing::Stock * > &stocks, NXOpen::Expression *startOffset, NXOpen::Expression *endOffset, NXOpen::Expression *pieceLength, NXOpen::Expression *gap, NXOpen::Expression *numberOfPieces, NXOpen::Point *startPoint, NXOpen::Routing::CharacteristicList *overstockPart, NXOpen::Routing::WrapApplicationType stockWrapType, NXOpen::Expression *wrapValue)
	Creates an NXOpen::Routing::OverstockApplication using the Interval method of application. More...
NXOpen::Routing::OverstockApplication *	CreateOverstockApplication (NXOpen::Routing::ControlPoint *startControlPoint, const std::vector< NXOpen::Routing::ISegment * > &segments, const std::vector< NXOpen::Routing::Stock * > &stocks, NXOpen::Point *startPoint, NXOpen::Point *endPoint, NXOpen::Routing::CharacteristicList *overstockPart, NXOpen::Routing::WrapApplicationType stockType, NXOpen::Expression *wrapValue)
	Creates an NXOpen::Routing::OverstockApplication using the Point to Point method of application. More...
NXOpen::Routing::OverstockApplication *	CreateOverstockApplication (NXOpen::Routing::ControlPoint *startControlPoint, const std::vector< NXOpen::Routing::ISegment * > &segments, const std::vector< NXOpen::Routing::Stock * > &stocks, NXOpen::Point *definingPoint, NXOpen::Routing::PointDefinition definingDirection, NXOpen::Expression *pieceLength, NXOpen::Routing::CharacteristicList *overstockPart, NXOpen::Routing::WrapApplicationType stockWrapType, NXOpen::Expression *wrapValue)
	Creates the Routing::MethodPointAndLength overstock by the Point and Length method. More...
iterator	end ()
	Returns an iterator addressing one past the last element. More...
void	ReplaceOverstockApplication (NXOpen::Routing::CharacteristicList *charxMap, NXOpen::Routing::Overstock *overstock)
	Replace current selected overstock NXOpen::Routing::Overstock with the chosen overstock. More...
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a collection of NXOpen::Routing::OverstockApplication objects.

To obtain an instance of this class, refer to NXOpen::Routing::RouteManager

Created in NX4.0.0.

Member Function Documentation

iterator NXOpen::Routing::OverstockApplicationCollection::begin

(

)

Returns an iterator addressing the first element.

NXOpen::Routing::OverstockApplication* NXOpen::Routing::OverstockApplicationCollection::ConvertOverstockApplication	(	NXOpen::Routing::ControlPoint *	startControlPoint,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const std::vector< NXOpen::Routing::Stock * > &	stocks,
		NXOpen::Routing::CharacteristicList *	overstockPart,
		NXOpen::Routing::CharacteristicList *	reqOptCharxList,
		NXOpen::Expression *	wrapValue,
		const std::vector< NXOpen::Routing::Overstock * > &	overstocks
	)

Converts an existing NXOpen::Routing::Overstock to Routing::MethodEntireSegments overstock.

Returns

Created in NX5.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

startControlPoint	Control Point at the start of the set of segments
segments	Segments to cover with overstock
stocks	Stocks to cover with overstock
overstockPart	overstock part
reqOptCharxList	List of optional and required characteristics to be applied on the overstock.
wrapValue	wrap value
overstocks	overstocks

NXOpen::Routing::OverstockApplication* NXOpen::Routing::OverstockApplicationCollection::ConvertOverstockApplication	(	NXOpen::Routing::ControlPoint *	startControlPoint,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const std::vector< NXOpen::Routing::Stock * > &	stocks,
		NXOpen::Expression *	startOffset,
		NXOpen::Expression *	endOffset,
		NXOpen::Expression *	pieceLength,
		NXOpen::Expression *	gap,
		NXOpen::Expression *	numberOfPieces,
		NXOpen::Point *	startPoint,
		NXOpen::Routing::CharacteristicList *	overstockPart,
		NXOpen::Routing::CharacteristicList *	reqOptCharxList,
		NXOpen::Expression *	wrapValue,
		const std::vector< NXOpen::Routing::Overstock * > &	overstocks
	)

Converts an existing NXOpen::Routing::Overstock to Routing::MethodInterval overstock.

Returns

Created in NX5.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

startControlPoint	Control Point at the start of the set of segments
segments	Segments to cover with overstock
stocks	Stocks to cover with overstock
startOffset	start offset
endOffset	end offset
pieceLength	piece length
gap	gap
numberOfPieces	number of pieces
startPoint	Point at the start offset location along the set of segments
overstockPart	overstock part
reqOptCharxList	List of optional and required characteristics to be applied on the overstock.
wrapValue	wrap value
overstocks	overstocks

NXOpen::Routing::OverstockApplication* NXOpen::Routing::OverstockApplicationCollection::ConvertOverstockApplication	(	NXOpen::Routing::ControlPoint *	startControlPoint,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const std::vector< NXOpen::Routing::Stock * > &	stocks,
		NXOpen::Point *	startPoint,
		NXOpen::Point *	endPoint,
		NXOpen::Routing::CharacteristicList *	overstockPart,
		NXOpen::Routing::CharacteristicList *	reqOptCharxList,
		NXOpen::Expression *	wrapValue,
		const std::vector< NXOpen::Routing::Overstock * > &	overstocks
	)

Converts an existing NXOpen::Routing::Overstock to Routing::MethodPointToPoint overstock.

Returns

Created in NX5.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

startControlPoint	Control Point at the start of the set of segments
segments	Segments to cover with overstock
stocks	Stocks to cover with overstock
startPoint	point at the start of the piece of overstock
endPoint	point at the end of the piece of overstock
overstockPart	overstock part
reqOptCharxList	List of optional and required characteristics to be applied on the overstock.
wrapValue	wrap value
overstocks	overstocks

NXOpen::Routing::OverstockApplication* NXOpen::Routing::OverstockApplicationCollection::ConvertOverstockApplication	(	NXOpen::Routing::ControlPoint *	startControlPoint,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const std::vector< NXOpen::Routing::Stock * > &	stocks,
		NXOpen::Point *	definingPoint,
		NXOpen::Routing::PointDefinition	definingDirection,
		NXOpen::Expression *	pieceLength,
		NXOpen::Routing::CharacteristicList *	overstockPart,
		NXOpen::Routing::CharacteristicList *	reqOptCharxList,
		NXOpen::Expression *	wrapValue,
		const std::vector< NXOpen::Routing::Overstock * > &	overstocks
	)

Converts an existing NXOpen::Routing::Overstock to Routing::MethodPointAndLength overstock.

Returns

Created in NX5.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

startControlPoint	Control Point at the start of the set of segments
segments	Segments to cover with overstock
stocks	Stocks to cover with overstock
definingPoint	defining point
definingDirection	location of the defining point.
pieceLength	piece length
overstockPart	overstock part
reqOptCharxList	List of optional and required characteristics to be applied on the overstock.
wrapValue	wrap value
overstocks	overstocks

NXOpen::Routing::OverstockApplication* NXOpen::Routing::OverstockApplicationCollection::CreateOverstockApplication	(	NXOpen::Routing::ControlPoint *	startControlPoint,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const std::vector< NXOpen::Routing::Stock * > &	stocks,
		NXOpen::Routing::CharacteristicList *	overstockPart,
		NXOpen::Routing::WrapApplicationType	stockWrapType,
		NXOpen::Expression *	wrapValue
	)

Creates the Routing::MethodEntireSegments overstock.

Specify the type of overstock to create (for example fixed cross section, wrapped, sleeved, or flagged) in the overstock part characteristic list using the "OVERSTOCK_TYPE" characteristic. Spot wrapping is not allowed for entire segments.

Returns

Created in NX5.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

startControlPoint	Control Point at the start of the set of segments
segments	Segments to cover with overstock
stocks	Stocks to cover with overstock
overstockPart	overstock part
stockWrapType	stock wrap type
wrapValue	wrap value

NXOpen::Routing::OverstockApplication* NXOpen::Routing::OverstockApplicationCollection::CreateOverstockApplication	(	NXOpen::Routing::ControlPoint *	startControlPoint,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const std::vector< NXOpen::Routing::Stock * > &	stocks,
		NXOpen::Expression *	startOffset,
		NXOpen::Expression *	endOffset,
		NXOpen::Expression *	pieceLength,
		NXOpen::Expression *	gap,
		NXOpen::Expression *	numberOfPieces,
		NXOpen::Point *	startPoint,
		NXOpen::Routing::CharacteristicList *	overstockPart,
		NXOpen::Routing::WrapApplicationType	stockWrapType,
		NXOpen::Expression *	wrapValue
	)

Creates an NXOpen::Routing::OverstockApplication using the Interval method of application.

Specify the type of overstock to create (for example fixed cross section, wrapped, sleeved, or flagged) in the overstock part characteristic list using the "OVERSTOCK_TYPE" characteristic.

Returns

Created in NX5.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

startControlPoint	Control Point at the start of the set of segments
segments	Segments to cover with overstock
stocks	Stocks to cover with overstock
startOffset	start offset
endOffset	end offset
pieceLength	piece length
gap	gap
numberOfPieces	number of pieces
startPoint	Point at the start offset location along the set of segments
overstockPart	overstock part
stockWrapType	stock wrap type
wrapValue	wrap value

NXOpen::Routing::OverstockApplication* NXOpen::Routing::OverstockApplicationCollection::CreateOverstockApplication	(	NXOpen::Routing::ControlPoint *	startControlPoint,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const std::vector< NXOpen::Routing::Stock * > &	stocks,
		NXOpen::Point *	startPoint,
		NXOpen::Point *	endPoint,
		NXOpen::Routing::CharacteristicList *	overstockPart,
		NXOpen::Routing::WrapApplicationType	stockType,
		NXOpen::Expression *	wrapValue
	)

Creates an NXOpen::Routing::OverstockApplication using the Point to Point method of application.

Specify the type of overstock to create (for example fixed cross section, wrapped, sleeved, or flagged) in the overstock part characteristic list using the "OVERSTOCK_TYPE" characteristic.

Returns

Created in NX5.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

startControlPoint	Control Point at the start of the set of segments
segments	Segments to cover with overstock
stocks	Stocks to cover with overstock
startPoint	point at the start of the piece of overstock
endPoint	point at the end of the piece of overstock
overstockPart	overstock part
stockType	stock type
wrapValue	wrap value

NXOpen::Routing::OverstockApplication* NXOpen::Routing::OverstockApplicationCollection::CreateOverstockApplication	(	NXOpen::Routing::ControlPoint *	startControlPoint,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const std::vector< NXOpen::Routing::Stock * > &	stocks,
		NXOpen::Point *	definingPoint,
		NXOpen::Routing::PointDefinition	definingDirection,
		NXOpen::Expression *	pieceLength,
		NXOpen::Routing::CharacteristicList *	overstockPart,
		NXOpen::Routing::WrapApplicationType	stockWrapType,
		NXOpen::Expression *	wrapValue
	)

Creates the Routing::MethodPointAndLength overstock by the Point and Length method.

Specify the type of overstock to create (for example fixed cross section, wrapped, sleeved, or flagged) in the overstock part characteristic list using the "OVERSTOCK_TYPE" characteristic.

Returns

Created in NX5.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

startControlPoint	Control Point at the start of the set of segments
segments	Segments to cover with overstock
stocks	Stocks to cover with overstock
definingPoint	defining point
definingDirection	location of the defining point.
pieceLength	piece length
overstockPart	overstock part
stockWrapType	stock wrap type
wrapValue	wrap value

iterator NXOpen::Routing::OverstockApplicationCollection::end

(

)

Returns an iterator addressing one past the last element.

void NXOpen::Routing::OverstockApplicationCollection::ReplaceOverstockApplication	(	NXOpen::Routing::CharacteristicList *	charxMap,
		NXOpen::Routing::Overstock *	overstock
	)

Replace current selected overstock NXOpen::Routing::Overstock with the chosen overstock.

It is only used by UI.

Created in NX10.0.0.

License requirements : routing_base ("Routing Basic") OR routing_advanced ("Routing Advanced")

Parameters

charxMap	charxmap
overstock	overstock

tag_t NXOpen::Routing::OverstockApplicationCollection::Tag

(

)

const

Returns the tag of this object.

---

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

• Routing_OverstockApplicationCollection.hxx