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

Contains the type of the routing part as well as the Collection objects for creating/iterating over routing objects. More...

List of all members.

Classes

struct  SubdivideOption
 Contains subdivide segment method information. More...

Public Types

enum  SubdivideSpacing {
  SubdivideSpacingScreenPoint, SubdivideSpacingEqualArcLength, SubdivideSpacingEqualParameter, SubdivideSpacingIncrementalArcLength,
  SubdivideSpacingGeometricRatio, SubdivideSpacingChordalTolerance, SubdivideSpacingNumberOfOptions
}
 Specifies spacing option for subdivide segment. More...

Public Member Functions

NXOpen::Routing::ArcSegmentCollectionArcSegments ()
 Arc Segment collection
Created in NX3.0.0.
NXOpen::Routing::ISegmentCreateConstrainedSegment (NXOpen::Routing::ControlPoint *startRcp, NXOpen::Routing::ControlPoint *endRcp)
 Creates a constrained line Routing::ISegment object with input Routing::ControlPoint as ends.
NXOpen::Routing::HealPathCreateHealPath ()
 Creates a new empty Routing::HealPath object that can be used as an input to Routing::SegmentManager::CreateHealSpline .
NXOpen::Routing::ISegmentCreateHealSpline (NXOpen::DisplayableObject *startObject, NXOpen::DisplayableObject *endObject, NXOpen::Routing::HealPath *healPath)
 Creates a spline Routing::ISegment object with input Routing::ControlPoint as ends.
NXOpen::Routing::ISegmentCreateSegment (NXOpen::Curve *followCurve, NXOpen::Routing::ControlPoint *startRcp, NXOpen::Routing::ControlPoint *endRcp, NXOpen::Routing::UserDefined userDefined)
 Creates a Routing::ISegment object following a curve.
NXOpen::Routing::ISegmentCreateSegment (NXOpen::Routing::ControlPoint *startRcp, NXOpen::Routing::ControlPoint *endRcp)
 Creates a line Routing::ISegment object with input Routing::ControlPoint as ends.
NXOpen::Routing::LineSegmentCollectionLineSegments ()
 Line Segment collection
Created in NX3.0.0.
void ModelTerminals (NXOpen::Routing::Port *multiPort, double cutBackLength, const NXString &extensionString, bool overrideCharx, const std::vector< NXOpen::Routing::Port * > &terminalPorts)
 Models spline paths to to specified terminals.
void ProcessBuiltInPaths (NXOpen::Assemblies::Component *partOcc)
 Create segments of Routing::BuiltInPath objects present in this Assemblies::Component object.
NXOpen::Routing::ISegmentCollectionSegments ()
 All Segment types collection
Created in NX7.5.1.
NXOpen::Routing::ISegmentSetFollowCurve (NXOpen::Routing::ISegment *segment, NXOpen::Curve *followCurve)
 Set segment follow curve.
void SimplifySegments (const std::vector< NXOpen::Routing::ISegment * > &segments, bool doUpdate, std::vector< NXOpen::Routing::ISegment * > &newSegments)
 Combine segments that are collinear and whose intermediate RCPs do not branch
Created in NX5.0.0.
NXOpen::Routing::SplineSegmentCollectionSplineSegments ()
 Spline Segment collection
Created in NX3.0.0.
void Subdivide (NXOpen::Routing::ISegment *segment, const NXOpen::Routing::SegmentManager::SubdivideOption &subdivideOption, std::vector< NXOpen::Routing::ISegment * > &subdivideSegments)
 Subdivide a routing path segment
Created in NX5.0.0.
tag_t Tag () const
 Returns the tag of this object.
void UnmodelTerminals (NXOpen::Routing::Port *multiPort, const std::vector< NXOpen::Routing::Port * > &terminalPorts)
 Unmodel terminals and update connection list routes for specified terminal ports.

Detailed Description

Contains the type of the routing part as well as the Collection objects for creating/iterating over routing objects.


To obtain an instance of this class, refer to Part

Created in NX4.0.0.


Member Enumeration Documentation

Specifies spacing option for subdivide segment.

Enumerator:
SubdivideSpacingScreenPoint 

Screen Point.

SubdivideSpacingEqualArcLength 

Equal Arc Length.

SubdivideSpacingEqualParameter 

Equal Parameter.

SubdivideSpacingIncrementalArcLength 

Incremental Arc Length.

SubdivideSpacingGeometricRatio 

Geometric Progression Ratio.

SubdivideSpacingChordalTolerance 

Chordal Tolerance.

SubdivideSpacingNumberOfOptions 

Number of Options.


Member Function Documentation

Arc Segment collection
Created in NX3.0.0.


Creates a constrained line Routing::ISegment object with input Routing::ControlPoint as ends.

Only use this method when building segments in a part that use Positioning::Constraint objects to constraint components and geometry. This is a new method for creating segments in NX5 and should be used instead of Routing::SegmentManager::CreateSegment for all line segments.

Returns:
Created segment
Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical")
Parameters:
startRcpStart Routing::ControlPoint of the segment
endRcpEnd Routing::ControlPoint of the segment

Creates a new empty Routing::HealPath object that can be used as an input to Routing::SegmentManager::CreateHealSpline .

Returns:

Created in NX5.0.0.

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

Creates a spline Routing::ISegment object with input Routing::ControlPoint as ends.

Returns:
Created segment
Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical")
Parameters:
startObjectStart DisplayableObject of the segment, ideally it should be Routing::Port
endObjectEnd DisplayableObject of the segment, ideally it should be Routing::Port
healPathheal path

Creates a Routing::ISegment object following a curve.

Returns:
Created segment
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical")
Parameters:
followCurveCurve to follow
startRcpStart Routing::ControlPoint of the segment
endRcpEnd Routing::ControlPoint of the segment
userDefinedIs segment user defined?

Creates a line Routing::ISegment object with input Routing::ControlPoint as ends.

Returns:
Created segment
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical")
Parameters:
startRcpStart Routing::ControlPoint of the segment
endRcpEnd Routing::ControlPoint of the segment

Line Segment collection
Created in NX3.0.0.


void NXOpen::Routing::SegmentManager::ModelTerminals ( NXOpen::Routing::Port multiPort,
double  cutBackLength,
const NXString extensionString,
bool  overrideCharx,
const std::vector< NXOpen::Routing::Port * > &  terminalPorts 
)

Models spline paths to to specified terminals.

Updates connection list to reflect changes to wire lengths of referencing connections.
Created in NX5.0.0.

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

Parameters:
multiPortMultiPort whose terminals are modelled
cutBackLengthLength of cut back path connected to multiport.
extensionStringLength of terminal segments which extends parallel to terminal ports
NOTE: The full Unicode character set is not supported for this parameter.
overrideCharxif TRUE: extension_string determines all terminal extensions
terminalPortsTerminal ports from which terminals are modelled

Create segments of Routing::BuiltInPath objects present in this Assemblies::Component object.


Created in NX5.0.0.

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

Parameters:
partOccpart occ

All Segment types collection
Created in NX7.5.1.


Set segment follow curve.

Segment can change type to mirror the type of the follow curve being set.

Returns:
Segment can possibly change types. Use the returned segment object pointer instead of any older pointers after calling this function. For eg: A LineSegment can become a SplineSegment after calling this function if new follow curve is a spline.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical")
Parameters:
segmentSegment to set follow curve on
followCurveFollow curve of segment
void NXOpen::Routing::SegmentManager::SimplifySegments ( const std::vector< NXOpen::Routing::ISegment * > &  segments,
bool  doUpdate,
std::vector< NXOpen::Routing::ISegment * > &  newSegments 
)

Combine segments that are collinear and whose intermediate RCPs do not branch
Created in NX5.0.0.



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

Parameters:
segmentssegments to combine
doUpdateFires update if True
newSegmentsresulting segments

Spline Segment collection
Created in NX3.0.0.


void NXOpen::Routing::SegmentManager::Subdivide ( NXOpen::Routing::ISegment segment,
const NXOpen::Routing::SegmentManager::SubdivideOption subdivideOption,
std::vector< NXOpen::Routing::ISegment * > &  subdivideSegments 
)

Subdivide a routing path segment
Created in NX5.0.0.



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

Parameters:
segmentSegment to subdivide
subdivideOptionsubdivide option
subdivideSegmentsresulting segments

Returns the tag of this object.

void NXOpen::Routing::SegmentManager::UnmodelTerminals ( NXOpen::Routing::Port multiPort,
const std::vector< NXOpen::Routing::Port * > &  terminalPorts 
)

Unmodel terminals and update connection list routes for specified terminal ports.


Created in NX5.0.0.

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

Parameters:
multiPortMultiPort whose terminals being unmodelled
terminalPortsTerminal ports being modelled

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