NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::Routing::RunCollection Class Reference

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

Inheritance diagram for NXOpen::Routing::RunCollection:
NXOpen::TaggedObjectCollection

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::RunCreateRun (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 NXOpen::Routing::Run object whose "From" item(s), "To" item(s), and "Member" item(s) are assigned to components in the assembly. More...
 
NXOpen::Routing::RunCreateRun (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 NXOpen::Routing::Run object whose "From" item(s), "To" item(s), and "Member" item(s) are assigned to components in the assembly. More...
 
NXOpen::Routing::RunCreateRun (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 NXOpen::Routing::Run with items that are not assigned to components in the assembly. More...
 
NXOpen::Routing::RunCreateRun (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 NXOpen::Routing::Run with items that are not assigned to components in the assembly. More...
 
NXOpen::Routing::RunCreateRun (const NXString &runId, const NXString &runType, NXOpen::Routing::CharacteristicList *attributes)
 Creates an empty NXOpen::Routing::Run using just a unique Run identifier and a type. More...
 
NXOpen::Routing::RunCreateRun (const char *runId, const char *runType, NXOpen::Routing::CharacteristicList *attributes)
 Creates an empty NXOpen::Routing::Run using just a unique Run identifier and a type. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
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. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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


To obtain an instance of this class, refer to NXOpen::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 NXOpen::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
runIdUnique identifier of the Run
runTypeType of the Run
fromArray of "From" items. Must be NXOpen::Routing::Port , NXOpen::Routing::Run or NXOpen::Routing::ControlPoint
toArray of "To" items. Must be NXOpen::Routing::Port , NXOpen::Routing::Run or NXOpen::Routing::ControlPoint
memberArray of "Member" items. Must be NXOpen::Assemblies::Component , NXOpen::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 NXOpen::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
runIdUnique identifier of the Run
runTypeType of the Run
fromArray of "From" items. Must be NXOpen::Routing::Port , NXOpen::Routing::Run or NXOpen::Routing::ControlPoint
toArray of "To" items. Must be NXOpen::Routing::Port , NXOpen::Routing::Run or NXOpen::Routing::ControlPoint
memberArray of "Member" items. Must be NXOpen::Assemblies::Component , NXOpen::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 NXOpen::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
runIdUnique identifier of the Run
runTypeType of the Run
attributesRun attributes
fromItemsArray of "From" items.
toItemsArray of "To" items.
memberItemsArray 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 NXOpen::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
runIdUnique identifier of the Run
runTypeType of the Run
attributesRun attributes
fromItemsArray of "From" items.
toItemsArray of "To" items.
memberItemsArray of "Member" items.
NXOpen::Routing::Run* NXOpen::Routing::RunCollection::CreateRun ( const NXString runId,
const NXString runType,
NXOpen::Routing::CharacteristicList attributes 
)

Creates an empty NXOpen::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
runIdUnique identifier of the Run
runTypeType of the Run
attributesRun attributes
NXOpen::Routing::Run* NXOpen::Routing::RunCollection::CreateRun ( const char *  runId,
const char *  runType,
NXOpen::Routing::CharacteristicList attributes 
)

Creates an empty NXOpen::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
runIdUnique identifier of the Run
runTypeType of the Run
attributesRun 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 NXOpen::Assemblies::Component , NXOpen::Routing::ISegment or Routing.Stock
Created in NX8.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
sourceArray of from items. Must be NXOpen::Routing::Port , NXOpen::Routing::Run or NXOpen::Routing::ControlPoint
targetArray of to items. Must be NXOpen::Routing::Port , NXOpen::Routing::Run or NXOpen::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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.