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

Interface class for all routing segments [Line/Arc/Spline]
Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Routing::ISegment:
NXOpen::Routing::ICharacteristic NXOpen::INXObject NXOpen::Routing::ArcSegment NXOpen::Routing::LineSegment NXOpen::Routing::SplineSegment

List of all members.

Public Member Functions

virtual
NXOpen::Routing::ConvertEccentricLinearToLinear 
ConvertEccentricLinearToLinear ()=0
 Is line segment eccentric converted to line segment?
virtual
NXOpen::Routing::ConvertLinearToEccentricLinear 
ConvertLinearToEccentricLinear ()=0
 Is line segment converted to eccentric line segment?
virtual NXOpen::CurveFollowCurve ()=0
 Returns the segment follow curve.
virtual std::vector
< NXOpen::Routing::Electrical::CableDevice * > 
GetCableDevices ()=0
 Returns Routing::Electrical::CableDevice objects from Routing::ISegment .
virtual std::vector
< NXOpen::Routing::Electrical::CablewaysLayoutView * > 
GetCablewaysLayoutViews ()=0
 Returns Routing::Electrical::CablewaysLayoutView objects from the Routing::ISegment .
virtual void GetEndPoints (NXOpen::Point3d *startPoint, NXOpen::Point3d *endPoint)=0
 Get the current location of the segment ends in ABS coordinates.
virtual void GetEndRcps (NXOpen::Routing::ControlPoint **startRcp, NXOpen::Routing::ControlPoint **endRcp)=0
 Return of segment end control points.
virtual NXOpen::Routing::Eccentric GetIsEccentricSegment ()=0
 Is given segment a eccentric segment?
virtual NXOpen::Routing::Interior GetIsSegmentInterior ()=0
 Query if a segment is interior to any part.
virtual NXOpen::Routing::Terminal GetIsTerminalSegment ()=0
 Is given segment a terminal segment?
virtual std::vector
< NXOpen::Routing::Stock * > 
GetSegmentAllStocks ()=0
 Returns Routing::Stock as well as Routing::Overstock objects from the Routing::ISegment .
virtual std::vector
< NXOpen::Routing::Stock * > 
GetSegmentStock ()=0
 Returns all stocks that directly reference this segment as part of the path defining the stock.
virtual void SetEndPoints (const NXOpen::Point3d &startPoint, const NXOpen::Point3d &endPoint)=0
 Set the current location of the segment ends in ABS coordinates.
virtual void SetEndRcps (NXOpen::Routing::ControlPoint *startRcp, NXOpen::Routing::ControlPoint *endRcp)=0
 
Created in NX4.0.0.
virtual void SetIsTerminalSegment (NXOpen::Routing::Terminal isTerminal)=0
 Set given segment to be a terminal segment?
Created in NX4.0.0.
virtual void SetSegmentInteriorPart (NXOpen::Assemblies::Component *interiorPart)=0
 Set a segment to be interior to supplied part
Created in NX4.0.0.

Detailed Description

Interface class for all routing segments [Line/Arc/Spline]
Created in NX4.0.0.



Member Function Documentation

Is line segment eccentric converted to line segment?

Returns:
Is line segment eccentric converted to line segment?
Created in NX8.0.0.

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

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

Is line segment converted to eccentric line segment?

Returns:
Is line segment converted to eccentric line segment?
Created in NX8.0.0.

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

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

Returns the segment follow curve.

NULL object indicates segment has no follow curve
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::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

Returns Routing::Electrical::CableDevice objects from Routing::ISegment .

Returns:
Array of cable devices.
Created in NX7.5.0.

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

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

Returns Routing::Electrical::CablewaysLayoutView objects from the Routing::ISegment .

Returns:
Array of cableways layout views.
Created in NX7.5.0.

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

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

virtual void NXOpen::Routing::ISegment::GetEndPoints ( NXOpen::Point3d startPoint,
NXOpen::Point3d endPoint 
) [pure virtual]

Get the current location of the segment ends in ABS coordinates.

This value is overridden by the coordinates of the end RCPs associated with this segment.
Created in NX4.0.0.

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

Parameters:
startPointLocation of end 0 in ABS coordinates
endPointLocation of end 1 in ABS coordinates

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

virtual void NXOpen::Routing::ISegment::GetEndRcps ( NXOpen::Routing::ControlPoint **  startRcp,
NXOpen::Routing::ControlPoint **  endRcp 
) [pure virtual]

Return of segment end control points.

The Routing::ControlPoint defines an end of a segment
Created in NX4.0.0.

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

Parameters:
startRcpRCP defining start of segment
endRcpRCP defining end of segment

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

Is given segment a eccentric segment?

Returns:
Is segment a eccentric segment?
Created in NX8.0.0.

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

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

Query if a segment is interior to any part.

Returns:
Is segment interior?
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::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

Is given segment a terminal segment?

Returns:
Is segment a terminal segment?
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::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

Returns Routing::Stock as well as Routing::Overstock objects from the Routing::ISegment .

Returns:
Array of stocks/overstocks.
Created in NX5.0.0.

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

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

virtual std::vector<NXOpen::Routing::Stock *> NXOpen::Routing::ISegment::GetSegmentStock ( ) [pure virtual]

Returns all stocks that directly reference this segment as part of the path defining the stock.

Returns:

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::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

virtual void NXOpen::Routing::ISegment::SetEndPoints ( const NXOpen::Point3d startPoint,
const NXOpen::Point3d endPoint 
) [pure virtual]

Set the current location of the segment ends in ABS coordinates.

This value is overridden by the coordinates of the end RCPs associated with this segment.
Created in NX4.0.0.

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

Parameters:
startPointNew location of end 0 in ABS coordinates
endPointNew location of end 1 in ABS coordinates

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.


Created in NX4.0.0.



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

Parameters:
startRcpRCP defining start of segment
endRcpRCP defining end of segment

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

Set given segment to be a terminal segment?
Created in NX4.0.0.



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

Parameters:
isTerminalSet as terminal segment?

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.

Set a segment to be interior to supplied part
Created in NX4.0.0.



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

Parameters:
interiorPartPart segment interior?

Implemented in NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, and NXOpen::Routing::SplineSegment.


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