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

The Routing Wire object is a list of segments in a route and some stock. More...

Inheritance diagram for NXOpen::Routing::WireCollection:
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::WireCreateWire (NXOpen::Routing::ControlPoint *startControlPoint, NXOpen::Routing::ControlPoint *endControlPoint, const std::vector< NXOpen::Routing::ISegment * > &segments, NXOpen::Routing::StockData *stockData, const std::vector< NXOpen::Routing::Stock * > &stocks, double lengthOfWire)
 Creates a wire object.
iterator end ()
 Returns an iterator addressing one past the last element.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

The Routing Wire object is a list of segments in a route and some stock.

It also contains the beginning and ending control point for the path.
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::Wire* NXOpen::Routing::WireCollection::CreateWire ( NXOpen::Routing::ControlPoint startControlPoint,
NXOpen::Routing::ControlPoint endControlPoint,
const std::vector< NXOpen::Routing::ISegment * > &  segments,
NXOpen::Routing::StockData stockData,
const std::vector< NXOpen::Routing::Stock * > &  stocks,
double  lengthOfWire 
)

Creates a wire object.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
startControlPointstart of the path
endControlPointend of the path
segmentsThe list of segments this wire is following.
stockDatastockdata
stocksStock bodies that cover the segments. Can be none and the system will generate them.
lengthOfWirelengthofwire

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.