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

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

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

List of all members.

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::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 Routing::Run object whose "From" item(s), "To" item(s), and "Member" item(s) are assigned to components in the assembly.
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 Routing::Run with items that are not assigned to components in the assembly.
NXOpen::Routing::RunCreateRun (const NXString &runId, const NXString &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.
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

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_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")
Parameters:
runIdUnique identifier of the Run
NOTE: The full Unicode character set is not supported for this parameter.
runTypeType of the Run
NOTE: The full Unicode character set is not supported for this parameter.
fromArray of "From" items. Must be Port , Routing::Run or Routing::ControlPoint
toArray of "To" items. Must be Port , Routing::Run or Routing::ControlPoint
memberArray 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_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")
Parameters:
runIdUnique identifier of the Run
NOTE: The full Unicode character set is not supported for this parameter.
runTypeType of the Run
NOTE: The full Unicode character set is not supported for this parameter.
attributesRun attributes
fromItemsArray of "From" items.
toItemsArray of "To" items.
memberItemsArray of "Member" items.

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

Returns:

Created in NX7.5.4.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical")
Parameters:
runIdUnique identifier of the Run
NOTE: The full Unicode character set is not supported for this parameter.
runTypeType of the Run
NOTE: The full Unicode character set is not supported for this parameter.
attributesRun attributes

Returns an iterator addressing one past the last element.

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.