NX Open C++ Reference Guide
Public Member Functions
NXOpen::Routing::IPath Class Reference

The Routing IPath object is a list of segments in a route. More...

Inheritance diagram for NXOpen::Routing::IPath:
NXOpen::INXObject NXOpen::Routing::OffsetPath NXOpen::Routing::Path NXOpen::Routing::Wire

List of all members.

Public Member Functions

virtual void AddSegmentsToList (const std::vector< NXOpen::Routing::ISegment * > &objs)=0
 Adds segment(s) to an IPath object.
virtual
NXOpen::Routing::ControlPoint
ControlPointEnd ()=0
 Returns the end ControlPoint for an IPath object.
virtual
NXOpen::Routing::ControlPoint
ControlPointStart ()=0
 Returns the start ControlPoint for an IPath object.
virtual void DelSegmentsFromList (const std::vector< NXOpen::Routing::ISegment * > &objs)=0
 Removes segment(s) from the IPath object.
virtual std::vector
< NXOpen::Routing::ISegment * > 
GetSegmentList ()=0
 Returns the list of all of the segments contained in the IPath.
virtual void SetControlPointEnd (NXOpen::Routing::ControlPoint *end)=0
 Sets the end ControlPoint for an IPath object.
virtual void SetControlPointStart (NXOpen::Routing::ControlPoint *start)=0
 Sets the start ControlPoint for an IPath object.

Detailed Description

The Routing IPath object is a list of segments in a route.

It also contains the beginning and ending control point for the path.


Created in NX4.0.0.


Member Function Documentation

virtual void NXOpen::Routing::IPath::AddSegmentsToList ( const std::vector< NXOpen::Routing::ISegment * > &  objs) [pure virtual]

Adds segment(s) to an IPath object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
objslist of segments that are to be added

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

Returns the end ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

Returns the start ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

virtual void NXOpen::Routing::IPath::DelSegmentsFromList ( const std::vector< NXOpen::Routing::ISegment * > &  objs) [pure virtual]

Removes segment(s) from the IPath object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
objslist of segments that are to be deleted

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

virtual std::vector<NXOpen::Routing::ISegment *> NXOpen::Routing::IPath::GetSegmentList ( ) [pure virtual]

Returns the list of all of the segments contained in the IPath.

Returns:
list of all of the segments in this IPath object
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

Sets the end ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
endend ControlPoint for the IPath object

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

Sets the start ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startstart ControlPoint for the IPath object

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.


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