Represents a collection of Routing::Stock objects. More...

Inheritance diagram for NXOpen::Routing::StockCollection:

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

Public Member Functions
void	AddStock (NXOpen::Routing::CharacteristicList stockPart, NXOpen::Routing::CharacteristicList dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const NXString &routeLevel)
	Creates stock on the given segments.

void	AddStock (NXOpen::Routing::CharacteristicList stockPart, NXOpen::Routing::CharacteristicList dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const char *routeLevel)
	Creates stock on the given segments.

void	AddStock (NXOpen::Routing::CharacteristicList stockPart, NXOpen::Routing::CharacteristicList dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const NXString &routeLevel, std::vector< NXOpen::Routing::Stock * > &stocks)
	Creates stock Routing::Stock on the given segments.

void	AddStock (NXOpen::Routing::CharacteristicList stockPart, NXOpen::Routing::CharacteristicList dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const char routeLevel, std::vector< NXOpen::Routing::Stock > &stocks)
	Creates stock Routing::Stock on the given segments.

void	AddStock (NXOpen::Routing::CharacteristicList stockPart, NXOpen::Routing::CharacteristicList dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const NXString &routeLevel, bool isSpaceReservation, std::vector< NXOpen::Routing::Stock * > &stocks)
	Creates normal or space reservation stock on the given segments.

void	AddStock (NXOpen::Routing::CharacteristicList stockPart, NXOpen::Routing::CharacteristicList dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const char routeLevel, bool isSpaceReservation, std::vector< NXOpen::Routing::Stock > &stocks)
	Creates normal or space reservation stock on the given segments.

void	AddStock (NXOpen::Routing::CharacteristicList stockPart, NXOpen::Routing::CharacteristicList dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const NXString &routeLevel, bool isSpaceReservation, const NXString &anchorName, std::vector< NXOpen::Routing::Stock * > &stocks)
	Creates normal or space reservation stock on the given segments.

void	AddStock (NXOpen::Routing::CharacteristicList stockPart, NXOpen::Routing::CharacteristicList dataCharx, const std::vector< NXOpen::Routing::ISegment * > &segments, const char routeLevel, bool isSpaceReservation, const char anchorName, std::vector< NXOpen::Routing::Stock * > &stocks)
	Creates normal or space reservation stock on the given segments.

iterator	begin ()
	Returns an iterator addressing the first element.

void	ConvertToStockAsComponents (NXOpen::Routing::ComponentName nameType)
	Converts a part file from Legacy Stock into Stock as Components.

void	ConvertToStockAsComponents (bool convertSpaceReservartion, NXOpen::Routing::ComponentName nameType)
	Converts a part file from Legacy Stock into Stock as Components.

std::vector < NXOpen::Routing::Stock * >	CreateStock (NXOpen::Routing::StockData stockData, NXOpen::Routing::Anchor anchor, NXOpen::Routing::CrossSection crossSection, const std::vector< NXOpen::Routing::ISegment > &segments)
	Creates a Routing::Stock object.

iterator	end ()
	Returns an iterator addressing one past the last element.

NXOpen::Routing::Stock *	GetComponentStock (NXOpen::Assemblies::Component *component)
	Returns the Routing::Stock that controls the given component.

void	RemoveAllFillerStocks (const std::vector< NXOpen::Routing::ISegment * > &segments)
	Removes all filler stocks from the input set of segments.

void	RemoveStock (const std::vector< NXOpen::Routing::ISegment * > &segments)
	Removes all stocks (excluding flexed stocks) from the input set of segments.

void	ResetReferenceStock ()
	Resets the reference Routing::Stock information to NULL.

void	SetAttachedStockLength (NXOpen::Assemblies::Component *partOcc)
	Set the length of the Routing::Stock to which a Assemblies::Component object is attached.

void	SetReferenceStockFromObject (NXOpen::NXObject *object)
	Sets the reference Routing::Stock information based on the Routing::Stock associated with this object.

tag_t	Tag () const
	Returns the tag of this object.

void	UpdateBundleStockForFiller (const std::vector< NXOpen::Routing::ISegment * > &segments)
	Update the bundle stock if the Routing::Filler stock is created underneath it.

Detailed Description

Represents a collection of Routing::Stock objects.

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

Created in NX4.0.0.

Member Function Documentation

void NXOpen::Routing::StockCollection::AddStock	(	NXOpen::Routing::CharacteristicList *	stockPart,
		NXOpen::Routing::CharacteristicList *	dataCharx,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const NXString &	routeLevel
	)

Creates stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.
Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockPart	Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharx	The list of optional and required characteristics to apply to the new stock.
segments	segments
routeLevel	Routing level. NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Routing::StockCollection::AddStock	(	NXOpen::Routing::CharacteristicList *	stockPart,
		NXOpen::Routing::CharacteristicList *	dataCharx,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const char *	routeLevel
	)

Creates stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.
Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockPart	Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharx	The list of optional and required characteristics to apply to the new stock.
segments	segments
routeLevel	Routing level. NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Routing::StockCollection::AddStock	(	NXOpen::Routing::CharacteristicList *	stockPart,
		NXOpen::Routing::CharacteristicList *	dataCharx,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const NXString &	routeLevel,
		std::vector< NXOpen::Routing::Stock * > &	stocks
	)

Creates stock Routing::Stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path. Returns created stock and number of stock
Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockPart	Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharx	The list of optional and required characteristics to apply to the new stock.
segments	segments
routeLevel	Routing level. NOTE: The full Unicode character set is not supported for this parameter.
stocks	Array of stocks created

void NXOpen::Routing::StockCollection::AddStock	(	NXOpen::Routing::CharacteristicList *	stockPart,
		NXOpen::Routing::CharacteristicList *	dataCharx,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const char *	routeLevel,
		std::vector< NXOpen::Routing::Stock * > &	stocks
	)

Creates stock Routing::Stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path. Returns created stock and number of stock
Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockPart	Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharx	The list of optional and required characteristics to apply to the new stock.
segments	segments
routeLevel	Routing level. NOTE: The full Unicode character set is not supported for this parameter.
stocks	Array of stocks created

void NXOpen::Routing::StockCollection::AddStock	(	NXOpen::Routing::CharacteristicList *	stockPart,
		NXOpen::Routing::CharacteristicList *	dataCharx,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const NXString &	routeLevel,
		bool	isSpaceReservation,
		std::vector< NXOpen::Routing::Stock * > &	stocks
	)

Creates normal or space reservation stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.
Created in NX7.5.2.

License requirements : routing_base ("Routing Basic")

Parameters

stockPart	Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharx	The list of optional and required characteristics to apply to the new stock.
segments	segments
routeLevel	Routing level. NOTE: The full Unicode character set is not supported for this parameter.
isSpaceReservation	TRUE to create Space Reservation stock, FALSE to create normal stock
stocks	Array of stocks created

void NXOpen::Routing::StockCollection::AddStock	(	NXOpen::Routing::CharacteristicList *	stockPart,
		NXOpen::Routing::CharacteristicList *	dataCharx,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const char *	routeLevel,
		bool	isSpaceReservation,
		std::vector< NXOpen::Routing::Stock * > &	stocks
	)

Creates normal or space reservation stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.
Created in NX7.5.2.

License requirements : routing_base ("Routing Basic")

Parameters

stockPart	Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharx	The list of optional and required characteristics to apply to the new stock.
segments	segments
routeLevel	Routing level. NOTE: The full Unicode character set is not supported for this parameter.
isSpaceReservation	TRUE to create Space Reservation stock, FALSE to create normal stock
stocks	Array of stocks created

void NXOpen::Routing::StockCollection::AddStock	(	NXOpen::Routing::CharacteristicList *	stockPart,
		NXOpen::Routing::CharacteristicList *	dataCharx,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const NXString &	routeLevel,
		bool	isSpaceReservation,
		const NXString &	anchorName,
		std::vector< NXOpen::Routing::Stock * > &	stocks
	)

Creates normal or space reservation stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.
Created in NX7.5.2.

License requirements : routing_base ("Routing Basic")

Parameters

stockPart	Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharx	The list of optional and required characteristics to apply to the new stock.
segments	segments
routeLevel	Routing level. NOTE: The full Unicode character set is not supported for this parameter.
isSpaceReservation	TRUE to create Space Reservation stock, FALSE to create normal stock
anchorName	Name of the anchor to use. NOTE: The full Unicode character set is not supported for this parameter.
stocks	Array of stocks created

void NXOpen::Routing::StockCollection::AddStock	(	NXOpen::Routing::CharacteristicList *	stockPart,
		NXOpen::Routing::CharacteristicList *	dataCharx,
		const std::vector< NXOpen::Routing::ISegment * > &	segments,
		const char *	routeLevel,
		bool	isSpaceReservation,
		const char *	anchorName,
		std::vector< NXOpen::Routing::Stock * > &	stocks
	)

Creates normal or space reservation stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.
Created in NX7.5.2.

License requirements : routing_base ("Routing Basic")

Parameters

stockPart	Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharx	The list of optional and required characteristics to apply to the new stock.
segments	segments
routeLevel	Routing level. NOTE: The full Unicode character set is not supported for this parameter.
isSpaceReservation	TRUE to create Space Reservation stock, FALSE to create normal stock
anchorName	Name of the anchor to use. NOTE: The full Unicode character set is not supported for this parameter.
stocks	Array of stocks created

iterator NXOpen::Routing::StockCollection::begin ( )

Returns an iterator addressing the first element.

void NXOpen::Routing::StockCollection::ConvertToStockAsComponents ( NXOpen::Routing::ComponentName nameType )

Converts a part file from Legacy Stock into Stock as Components.

Converts all stocks whose use is NXOpen::Routing::StockUseLegacyStock into NXOpen::Routing::StockUseStockAsComponent stocks by creating components for each stock. After calling this routine, all new stocks in this part will have components associated with them.

Deprecated:: Deprecated in NX8.0.0. Use Routing::StockCollection::ConvertToStockAsComponents instead.

Created in NX4.0.0.

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

Parameters

nameType Naming scheme to use for components. Calls ??? on each new stock component if input is Routing::ComponentNamePermanent .

void NXOpen::Routing::StockCollection::ConvertToStockAsComponents	(	bool	convertSpaceReservartion,
		NXOpen::Routing::ComponentName	nameType
	)

Converts a part file from Legacy Stock into Stock as Components.

       Converts all stocks whose use is @link NXOpen::Routing::StockUseLegacyStock NXOpen::Routing::StockUseLegacyStock@endlink  into @link NXOpen::Routing::StockUseStockAsComponent NXOpen::Routing::StockUseStockAsComponent@endlink 
       stocks by creating components for each stock.  After calling this routine, all new stocks in this part will have components associated with them.

Created in NX7.5.2.

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

Parameters

convertSpaceReservartion	If true, convert Space Reservation as Components
nameType	Naming scheme to use for components. Calls ??? on each new stock component if input is Routing::ComponentNamePermanent .

std::vector<NXOpen::Routing::Stock *> NXOpen::Routing::StockCollection::CreateStock	(	NXOpen::Routing::StockData *	stockData,
		NXOpen::Routing::Anchor *	anchor,
		NXOpen::Routing::CrossSection *	crossSection,
		const std::vector< NXOpen::Routing::ISegment * > &	segments
	)

Creates a Routing::Stock object.

Returns: The resulting array of newly created Routing::Stock objects.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

stockData	The Routing::StockData that defines the stock
anchor	The Routing::Anchor from the input Routing::StockData to use, NULL is allowed for no anchor.
crossSection	The Routing::CrossSection from the input Routing::StockData to use, NULL is not allowed.
segments	The array of Routing::ISegment curves that the stock must cover.

iterator NXOpen::Routing::StockCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Routing::Stock* NXOpen::Routing::StockCollection::GetComponentStock ( NXOpen::Assemblies::Component * component )

Returns the Routing::Stock that controls the given component.

       Only returns a @link Routing::Stock Routing::Stock@endlink  if the input component is a component created 
       by a Stock as Components stock object.  @return  Returns NULL if the input component is not controlled
                                       by a @link Routing::Stock Routing::Stock@endlink

Created in NX4.0.0.

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

Parameters

component component

void NXOpen::Routing::StockCollection::RemoveAllFillerStocks ( const std::vector< NXOpen::Routing::ISegment * > & segments )

Removes all filler stocks from the input set of segments.

Created in NX5.0.4.

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

Parameters

segments segments

void NXOpen::Routing::StockCollection::RemoveStock ( const std::vector< NXOpen::Routing::ISegment * > & segments )

Removes all stocks (excluding flexed stocks) from the input set of segments.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

segments segments

void NXOpen::Routing::StockCollection::ResetReferenceStock ( )

Resets the reference Routing::Stock information to NULL.

The information attributes are rotation, twist, negate, flip, port and anchor. They determine the default creation options for the new stock. This information is used during path creation.
Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::StockCollection::SetAttachedStockLength ( NXOpen::Assemblies::Component * partOcc )

Set the length of the Routing::Stock to which a Assemblies::Component object is attached.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

partOcc part occ

void NXOpen::Routing::StockCollection::SetReferenceStockFromObject ( NXOpen::NXObject * object )

Sets the reference Routing::Stock information based on the Routing::Stock associated with this object.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

object object

tag_t NXOpen::Routing::StockCollection::Tag ( ) const

Returns the tag of this object.

void NXOpen::Routing::StockCollection::UpdateBundleStockForFiller ( const std::vector< NXOpen::Routing::ISegment * > & segments )

Update the bundle stock if the Routing::Filler stock is created underneath it.

Created in NX5.0.0.

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

Parameters

segments segments

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

Routing_StockCollection.hxx

Classes

Public Member Functions

Detailed Description

Member Function Documentation