NXOpen::Routing::RunCollection Class Reference

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

Inheritance diagram for NXOpen::Routing::RunCollection:

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

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element.
NXOpen::Routing::Run *	CreateRun (const NXString &runId, const NXString &runType, const std::vector< NXOpen::NXObject * > &from, const std::vector< NXOpen::NXObject * > &to, const std::vector< NXOpen::NXObject * > &member)
	Creates a fully defined Routing::Run object whose "From" item(s), "To" item(s), and "Member" item(s) are assigned to components in the assembly.
NXOpen::Routing::Run *	CreateRun (const char *runId, const char *runType, const std::vector< NXOpen::NXObject * > &from, const std::vector< NXOpen::NXObject * > &to, const std::vector< NXOpen::NXObject * > &member)
	Creates a fully defined Routing::Run object whose "From" item(s), "To" item(s), and "Member" item(s) are assigned to components in the assembly.
NXOpen::Routing::Run *	CreateRun (const NXString &runId, const NXString &runType, NXOpen::Routing::CharacteristicList *attributes, const std::vector< NXOpen::Routing::RunItem * > &fromItems, const std::vector< NXOpen::Routing::RunItem * > &toItems, const std::vector< NXOpen::Routing::RunItem * > &memberItems)
	Creates a Routing::Run with items that are not assigned to components in the assembly.
NXOpen::Routing::Run *	CreateRun (const char *runId, const char *runType, NXOpen::Routing::CharacteristicList *attributes, const std::vector< NXOpen::Routing::RunItem * > &fromItems, const std::vector< NXOpen::Routing::RunItem * > &toItems, const std::vector< NXOpen::Routing::RunItem * > &memberItems)
	Creates a Routing::Run with items that are not assigned to components in the assembly.
NXOpen::Routing::Run *	CreateRun (const NXString &runId, const NXString &runType, NXOpen::Routing::CharacteristicList *attributes)
	Creates an empty Routing::Run using just a unique Run identifier and a type.
NXOpen::Routing::Run *	CreateRun (const char *runId, const char *runType, NXOpen::Routing::CharacteristicList *attributes)
	Creates an empty Routing::Run using just a unique Run identifier and a type.
iterator	end ()
	Returns an iterator addressing one past the last element.
std::vector< NXOpen::NXObject * >	FindPath (const std::vector< NXOpen::NXObject * > &source, const std::vector< NXOpen::NXObject * > &target)
	Find a run path connecting all input From items to the To items.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a collection of Routing::Run objects.

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

Created in NX4.0.0.

Member Function Documentation

iterator NXOpen::Routing::RunCollection::begin

(

)

Returns an iterator addressing the first element.

NXOpen::Routing::Run* NXOpen::Routing::RunCollection::CreateRun	(	const NXString &	runId,
		const NXString &	runType,
		const std::vector< NXOpen::NXObject * > &	from,
		const std::vector< NXOpen::NXObject * > &	to,
		const std::vector< NXOpen::NXObject * > &	member
	)

Creates a fully defined Routing::Run object whose "From" item(s), "To" item(s), and "Member" item(s) are assigned to components in the assembly.

Returns

Created in NX4.0.0.

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

Parameters

runId	Unique identifier of the Run NOTE: The full Unicode character set is not supported for this parameter.
runType	Type of the Run NOTE: The full Unicode character set is not supported for this parameter.
from	Array of "From" items. Must be Port , Routing::Run or Routing::ControlPoint
to	Array of "To" items. Must be Port , Routing::Run or Routing::ControlPoint
member	Array of "Member" items. Must be Assemblies::Component , Routing::ISegment or Routing.Stock

NXOpen::Routing::Run* NXOpen::Routing::RunCollection::CreateRun	(	const char *	runId,
		const char *	runType,
		const std::vector< NXOpen::NXObject * > &	from,
		const std::vector< NXOpen::NXObject * > &	to,
		const std::vector< NXOpen::NXObject * > &	member
	)

Creates a fully defined Routing::Run object whose "From" item(s), "To" item(s), and "Member" item(s) are assigned to components in the assembly.

Returns

Created in NX4.0.0.

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

Parameters

runId	Unique identifier of the Run NOTE: The full Unicode character set is not supported for this parameter.
runType	Type of the Run NOTE: The full Unicode character set is not supported for this parameter.
from	Array of "From" items. Must be Port , Routing::Run or Routing::ControlPoint
to	Array of "To" items. Must be Port , Routing::Run or Routing::ControlPoint
member	Array of "Member" items. Must be Assemblies::Component , Routing::ISegment or Routing.Stock

NXOpen::Routing::Run* NXOpen::Routing::RunCollection::CreateRun	(	const NXString &	runId,
		const NXString &	runType,
		NXOpen::Routing::CharacteristicList *	attributes,
		const std::vector< NXOpen::Routing::RunItem * > &	fromItems,
		const std::vector< NXOpen::Routing::RunItem * > &	toItems,
		const std::vector< NXOpen::Routing::RunItem * > &	memberItems
	)

Creates a Routing::Run with items that are not assigned to components in the assembly.

Returns

Created in NX7.5.4.

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

Parameters

runId	Unique identifier of the Run NOTE: The full Unicode character set is not supported for this parameter.
runType	Type of the Run NOTE: The full Unicode character set is not supported for this parameter.
attributes	Run attributes
fromItems	Array of "From" items.
toItems	Array of "To" items.
memberItems	Array of "Member" items.

NXOpen::Routing::Run* NXOpen::Routing::RunCollection::CreateRun	(	const char *	runId,
		const char *	runType,
		NXOpen::Routing::CharacteristicList *	attributes,
		const std::vector< NXOpen::Routing::RunItem * > &	fromItems,
		const std::vector< NXOpen::Routing::RunItem * > &	toItems,
		const std::vector< NXOpen::Routing::RunItem * > &	memberItems
	)

Creates a Routing::Run with items that are not assigned to components in the assembly.

Returns

Created in NX7.5.4.

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

Parameters

runId	Unique identifier of the Run NOTE: The full Unicode character set is not supported for this parameter.
runType	Type of the Run NOTE: The full Unicode character set is not supported for this parameter.
attributes	Run attributes
fromItems	Array of "From" items.
toItems	Array of "To" items.
memberItems	Array of "Member" items.

NXOpen::Routing::Run* NXOpen::Routing::RunCollection::CreateRun	(	const NXString &	runId,
		const NXString &	runType,
		NXOpen::Routing::CharacteristicList *	attributes
	)

Creates an empty Routing::Run using just a unique Run identifier and a type.

Returns

Created in NX7.5.4.

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

Parameters

runId	Unique identifier of the Run NOTE: The full Unicode character set is not supported for this parameter.
runType	Type of the Run NOTE: The full Unicode character set is not supported for this parameter.
attributes	Run attributes

NXOpen::Routing::Run* NXOpen::Routing::RunCollection::CreateRun	(	const char *	runId,
		const char *	runType,
		NXOpen::Routing::CharacteristicList *	attributes
	)

Creates an empty Routing::Run using just a unique Run identifier and a type.

Returns

Created in NX7.5.4.

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

Parameters

runId	Unique identifier of the Run NOTE: The full Unicode character set is not supported for this parameter.
runType	Type of the Run NOTE: The full Unicode character set is not supported for this parameter.
attributes	Run attributes

iterator NXOpen::Routing::RunCollection::end

(

)

Returns an iterator addressing one past the last element.

std::vector<NXOpen::NXObject *> NXOpen::Routing::RunCollection::FindPath	(	const std::vector< NXOpen::NXObject * > &	source,
		const std::vector< NXOpen::NXObject * > &	target
	)

Find a run path connecting all input From items to the To items.

Returns

Array of member items. Must be Assemblies::Component , Routing::ISegment or Routing.Stock
Created in NX8.0.2.

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

Parameters

source	Array of from items. Must be Port , Routing::Run or Routing::ControlPoint
target	Array of to items. Must be Routing::Port , Routing::Run or Routing::ControlPoint

tag_t NXOpen::Routing::RunCollection::Tag

(

)

const

Returns the tag of this object.

---

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

• Routing_RunCollection.hxx