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

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::ArcSegmentCollection *	ArcSegments ()
	Arc Segment collection Created in NX3.0.0.

NXOpen::Routing::ISegment *	CreateConstrainedSegment (NXOpen::Routing::ControlPoint startRcp, NXOpen::Routing::ControlPoint endRcp)
	Creates a constrained line Routing::ISegment object with input Routing::ControlPoint as ends.

NXOpen::Routing::HealPath *	CreateHealPath ()
	Creates a new empty Routing::HealPath object that can be used as an input to Routing::SegmentManager::CreateHealSpline .

NXOpen::Routing::ISegment *	CreateHealSpline (NXOpen::DisplayableObject startObject, NXOpen::DisplayableObject endObject, NXOpen::Routing::HealPath *healPath)
	Creates a spline Routing::ISegment object with input Routing::ControlPoint as ends.

NXOpen::Routing::ISegment *	CreateSegment (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::ISegment *	CreateSegment (NXOpen::Routing::ControlPoint startRcp, NXOpen::Routing::ControlPoint endRcp)
	Creates a line Routing::ISegment object with input Routing::ControlPoint as ends.

NXOpen::Routing::LineSegmentCollection *	LineSegments ()
	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	ModelTerminals (NXOpen::Routing::Port multiPort, double cutBackLength, const char 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::ISegmentCollection *	Segments ()
	All Segment types collection Created in NX7.5.1.

NXOpen::Routing::ISegment *	SetFollowCurve (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::SplineSegmentCollection *	SplineSegments ()
	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)
	Un-model 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.

<br> To obtain an instance of this class, refer to @link Part  Part @endlink  <br>

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::Routing::SegmentManager::SubdivideSpacing

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

NXOpen::Routing::ArcSegmentCollection* NXOpen::Routing::SegmentManager::ArcSegments ( )

Arc Segment collection
Created in NX3.0.0.

NXOpen::Routing::ISegment* NXOpen::Routing::SegmentManager::CreateConstrainedSegment	(	NXOpen::Routing::ControlPoint *	startRcp,
		NXOpen::Routing::ControlPoint *	endRcp
	)

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 @link Positioning::Constraint Positioning::Constraint@endlink  objects to constraint components 
        and geometry.  This is a new method for creating segments in NX5 and 
        should be used instead of @link Routing::SegmentManager::CreateSegment Routing::SegmentManager::CreateSegment@endlink  
        for all line segments.
        @return  Created segment

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

startRcp	Start Routing::ControlPoint of the segment
endRcp	End Routing::ControlPoint of the segment

NXOpen::Routing::HealPath* NXOpen::Routing::SegmentManager::CreateHealPath ( )

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

     @return

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::ISegment* NXOpen::Routing::SegmentManager::CreateHealSpline	(	NXOpen::DisplayableObject *	startObject,
		NXOpen::DisplayableObject *	endObject,
		NXOpen::Routing::HealPath *	healPath
	)

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

        @return  Created segment

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

startObject	Start DisplayableObject of the segment, ideally it should be Routing::Port
endObject	End DisplayableObject of the segment, ideally it should be Routing::Port
healPath	heal path

NXOpen::Routing::ISegment* NXOpen::Routing::SegmentManager::CreateSegment	(	NXOpen::Curve *	followCurve,
		NXOpen::Routing::ControlPoint *	startRcp,
		NXOpen::Routing::ControlPoint *	endRcp,
		NXOpen::Routing::UserDefined	userDefined
	)

Creates a Routing::ISegment object following a curve.

Returns: Created segment
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

followCurve	Curve to follow
startRcp	Start Routing::ControlPoint of the segment
endRcp	End Routing::ControlPoint of the segment
userDefined	Is segment user defined?

NXOpen::Routing::ISegment* NXOpen::Routing::SegmentManager::CreateSegment	(	NXOpen::Routing::ControlPoint *	startRcp,
		NXOpen::Routing::ControlPoint *	endRcp
	)

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

Returns: Created segment
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

startRcp	Start Routing::ControlPoint of the segment
endRcp	End Routing::ControlPoint of the segment

NXOpen::Routing::LineSegmentCollection* NXOpen::Routing::SegmentManager::LineSegments ( )

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_base ("Routing Basic")

Parameters

multiPort	MultiPort whose terminals are modeled
cutBackLength	Length of cut back path connected to multiport.
extensionString	Length of terminal segments which extends parallel to terminal ports NOTE: The full Unicode character set is not supported for this parameter.
overrideCharx	if TRUE: extension_string determines all terminal extensions
terminalPorts	Terminal ports from which terminals are modeled

void NXOpen::Routing::SegmentManager::ModelTerminals	(	NXOpen::Routing::Port *	multiPort,
		double	cutBackLength,
		const char *	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_base ("Routing Basic")

Parameters

multiPort	MultiPort whose terminals are modeled
cutBackLength	Length of cut back path connected to multiport.
extensionString	Length of terminal segments which extends parallel to terminal ports NOTE: The full Unicode character set is not supported for this parameter.
overrideCharx	if TRUE: extension_string determines all terminal extensions
terminalPorts	Terminal ports from which terminals are modeled

void NXOpen::Routing::SegmentManager::ProcessBuiltInPaths ( NXOpen::Assemblies::Component * partOcc )

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

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

partOcc part occ

NXOpen::Routing::ISegmentCollection* NXOpen::Routing::SegmentManager::Segments ( )

All Segment types collection
Created in NX7.5.1.

NXOpen::Routing::ISegment* NXOpen::Routing::SegmentManager::SetFollowCurve	(	NXOpen::Routing::ISegment *	segment,
		NXOpen::Curve *	followCurve
	)

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 example: 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_base ("Routing Basic")

Parameters

segment	Segment to set follow curve on
followCurve	Follow 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_base ("Routing Basic")

Parameters

segments	segments to combine
doUpdate	Fires update if True
newSegments	resulting segments

NXOpen::Routing::SplineSegmentCollection* NXOpen::Routing::SegmentManager::SplineSegments ( )

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_base ("Routing Basic")

Parameters

segment	Segment to subdivide
subdivideOption	subdivide option
subdivideSegments	resulting segments

tag_t NXOpen::Routing::SegmentManager::Tag ( ) const

Returns the tag of this object.

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

Un-model terminals and update connection list routes for specified terminal ports.

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

multiPort	MultiPort whose terminals being un-modeled
terminalPorts	Terminal ports being modeled

The documentation for this class was generated from the following file:

Routing_SegmentManager.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation