nxopen.routing

Interface SegmentManager

All Superinterfaces:

Remote

public interface SegmentManager
extends Remote

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SegmentManager.SubdivideOption Contains subdivide segment method information.
static class	SegmentManager.SubdivideSpacing Specifies spacing option for subdivide segment.

Method Summary

Modifier and Type	Method and Description
ArcSegmentCollection	arcSegments() Arc Segment collection .
ISegment	createConstrainedSegment(ControlPoint startRcp, ControlPoint endRcp) Creates a constrained line ISegment object with input ControlPoint as ends.
HealPath	createHealPath() Creates a new empty HealPath object that can be used as an input to createHealSpline(nxopen.DisplayableObject, nxopen.DisplayableObject, nxopen.routing.HealPath) .
ISegment	createHealSpline(DisplayableObject startObject, DisplayableObject endObject, HealPath healPath) Creates a spline ISegment object with input ControlPoint as ends.
ISegment	createSegment(ControlPoint startRcp, ControlPoint endRcp) Creates a line ISegment object with input ControlPoint as ends.
ISegment	createSegment(Curve followCurve, ControlPoint startRcp, ControlPoint endRcp, UserDefined userDefined) Creates a ISegment object following a curve.
ISegment[]	getShortestPathBetweenControlPoints(ControlPoint controlPoint1, ControlPoint controlPoint2) Returns the shortest connected segments (i.e. the path) linking the two ControlPoint s, if any.
LineSegmentCollection	lineSegments() Line Segment collection .
void	modelTerminals(Port multiPort, double cutBackLength, String extensionString, boolean overrideCharx, Port[] terminalPorts) Models spline paths to to specified terminals.
void	processBuiltInPaths(Component partOcc) Create segments of BuiltInPath objects present in this Component object.
ISegmentCollection	segments() All Segment types collection .
ISegment	setFollowCurve(ISegment segment, Curve followCurve) Set segment follow curve.
ISegment[]	simplifySegments(ISegment[] segments, boolean doUpdate) Combine segments that are collinear and whose intermediate RCPs do not branch License requirements: routing_base ("Routing Basic") .
SplineSegmentCollection	splineSegments() Spline Segment collection .
ISegment[]	subdivide(ISegment segment, SegmentManager.SubdivideOption subdivideOption) Subdivide a routing path segment License requirements: routing_base ("Routing Basic") .
void	unmodelTerminals(Port multiPort, Port[] terminalPorts) Un-model terminals and update connection list routes for specified terminal ports.

Method Detail

segments

ISegmentCollection segments()
                     throws RemoteException

All Segment types collection .
Created in NX7.5.1

Throws:

RemoteException

lineSegments

LineSegmentCollection lineSegments()
                            throws RemoteException

Line Segment collection .
Created in NX3.0.0

Throws:

RemoteException

arcSegments

ArcSegmentCollection arcSegments()
                          throws RemoteException

Arc Segment collection .
Created in NX3.0.0

Throws:

RemoteException

splineSegments

SplineSegmentCollection splineSegments()
                                throws RemoteException

Spline Segment collection .
Created in NX3.0.0

Throws:

RemoteException

createSegment

ISegment createSegment(Curve followCurve,
                       ControlPoint startRcp,
                       ControlPoint endRcp,
                       UserDefined userDefined)
                throws NXException,
                       RemoteException

Creates a ISegment object following a curve.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

followCurve - Curve to follow

startRcp - Start ControlPoint of the segment

endRcp - End ControlPoint of the segment

userDefined - Is segment user defined?

Returns:

Created segment

Throws:

NXException

RemoteException

createSegment

ISegment createSegment(ControlPoint startRcp,
                       ControlPoint endRcp)
                throws NXException,
                       RemoteException

Creates a line ISegment object with input ControlPoint as ends.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

startRcp - Start ControlPoint of the segment

endRcp - End ControlPoint of the segment

Returns:

Created segment

Throws:

NXException

RemoteException

setFollowCurve

ISegment setFollowCurve(ISegment segment,
                        Curve followCurve)
                 throws NXException,
                        RemoteException

Set segment follow curve. Segment can change type to mirror the type of the follow curve being set.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

segment - Segment to set follow curve on

followCurve - Follow curve of segment

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.

Throws:

NXException

RemoteException

simplifySegments

ISegment[] simplifySegments(ISegment[] segments,
                            boolean doUpdate)
                     throws NXException,
                            RemoteException

Combine segments that are collinear and whose intermediate RCPs do not branch
License requirements: routing_base ("Routing Basic")
.
Created in NX5.0.0

Parameters:

segments - segments to combine

doUpdate - Fires update if True

Throws:

NXException

RemoteException

subdivide

ISegment[] subdivide(ISegment segment,
                     SegmentManager.SubdivideOption subdivideOption)
              throws NXException,
                     RemoteException

Subdivide a routing path segment
License requirements: routing_base ("Routing Basic")
.
Created in NX5.0.0

Parameters:

segment - Segment to subdivide

subdivideOption -

Throws:

NXException

RemoteException

createConstrainedSegment

ISegment createConstrainedSegment(ControlPoint startRcp,
                                  ControlPoint endRcp)
                           throws NXException,
                                  RemoteException

Creates a constrained line ISegment object with input ControlPoint as ends. Only use this method when building segments in a part that use Constraint objects to constraint components and geometry. This is a new method for creating segments in NX5 and should be used instead of createSegment(nxopen.Curve, nxopen.routing.ControlPoint, nxopen.routing.ControlPoint, nxopen.routing.UserDefined) for all line segments.
License requirements: routing_base ("Routing Basic")

Created in NX5.0.0

Parameters:

startRcp - Start ControlPoint of the segment

endRcp - End ControlPoint of the segment

Returns:

Created segment

Throws:

NXException

RemoteException

createHealSpline

ISegment createHealSpline(DisplayableObject startObject,
                          DisplayableObject endObject,
                          HealPath healPath)
                   throws NXException,
                          RemoteException

Creates a spline ISegment object with input ControlPoint as ends.
License requirements: routing_base ("Routing Basic")

Created in NX5.0.0

Parameters:

startObject - Start DisplayableObject of the segment, ideally it should be Port

endObject - End DisplayableObject of the segment, ideally it should be Port

healPath -

Returns:

Created segment

Throws:

NXException

RemoteException

createHealPath

HealPath createHealPath()
                 throws NXException,
                        RemoteException

Creates a new empty HealPath object that can be used as an input to createHealSpline(nxopen.DisplayableObject, nxopen.DisplayableObject, nxopen.routing.HealPath) .
License requirements: routing_base ("Routing Basic")

Created in NX5.0.0

Throws:

NXException

RemoteException

modelTerminals

void modelTerminals(Port multiPort,
                    double cutBackLength,
                    String extensionString,
                    boolean overrideCharx,
                    Port[] terminalPorts)
             throws NXException,
                    RemoteException

Models spline paths to to specified terminals. Updates connection list to reflect changes to wire lengths of referencing connections.
License requirements: routing_base ("Routing Basic")

Created in NX5.0.0

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

overrideCharx - if TRUE: extension_string determines all terminal extensions

terminalPorts - Terminal ports from which terminals are modeled

Throws:

NXException

RemoteException

unmodelTerminals

void unmodelTerminals(Port multiPort,
                      Port[] terminalPorts)
               throws NXException,
                      RemoteException

Un-model terminals and update connection list routes for specified terminal ports.
License requirements: routing_base ("Routing Basic")

Created in NX5.0.0

Parameters:

multiPort - MultiPort whose terminals being un-modeled

terminalPorts - Terminal ports being modeled

Throws:

NXException

RemoteException

processBuiltInPaths

void processBuiltInPaths(Component partOcc)
                  throws NXException,
                         RemoteException

Create segments of BuiltInPath objects present in this Component object.
License requirements: routing_base ("Routing Basic")

Created in NX5.0.0

Parameters:

partOcc -

Throws:

NXException

RemoteException

getShortestPathBetweenControlPoints

ISegment[] getShortestPathBetweenControlPoints(ControlPoint controlPoint1,
                                               ControlPoint controlPoint2)
                                        throws NXException,
                                               RemoteException

Returns the shortest connected segments (i.e. the path) linking the two ControlPoint s, if any.
License requirements: routing_base ("Routing Basic")

Created in NX11.0.1

Parameters:

controlPoint1 -

controlPoint2 -

Throws:

NXException

RemoteException