nxopen.formboard

Interface PathLengthAnnotationBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface PathLengthAnnotationBuilder
extends Builder

TODO Class documentation
To create a new instance of this class, use FormboardManager.createPathLengthAnnotationBuilder(nxopen.annotations.Annotation)
Default values.

Property	Value
ShowLeadersToggle	0
Text.TextBlock.CustomSymbolScale	1.0
Text.TextBlock.SymbolAspectRatio	1.0
Text.TextBlock.SymbolHeight	25.4 (millimeters part), 1.0 (inches part)
Text.TextBlock.SymbolLength	25.4 (millimeters part), 1.0 (inches part)
Text.TextBlock.SymbolPreferences	UseCurrent
Text.TextBlock.SymbolScale	1.0
Text.TextBlock.SymbolSizeMethod	ScaleAndAspectRatio

Created in NX7.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PathLengthAnnotationBuilder.Types TODO: Document the whole type

Method Summary

Modifier and Type	Method and Description
void	createPointsAtRcps(ControlPoint firstEndRcp, ControlPoint secondEndRcp) Create builder end points at the RCP locations License requirements: routing_harness ("Routing Harness") .
String	expressionName() Returns the expression name License requirements: routing_harness ("Routing Harness") .
Point	firstEndPoint() Returns the first end point License requirements: routing_harness ("Routing Harness") .
LeaderBuilder	leader() Returns the leader License requirements: routing_harness ("Routing Harness") .
OriginBuilder	origin() Returns the origin License requirements: routing_harness ("Routing Harness") .
RouteObjectCollector	routeObjectCollector() Returns the route object collector License requirements: routing_harness ("Routing Harness") .
Point	secondEndPoint() Returns the second end point License requirements: routing_harness ("Routing Harness") .
void	setFirstEndPoint(Point firstEndPoint) License requirements: routing_harness ("Routing Harness") .
void	setPathLengthAnnotationEndPoints(Point firstEndPoint, Point secondEndPoint) Create and initialize the Path Length Annotation License requirements: routing_harness ("Routing Harness") .
void	setSecondEndPoint(Point secondEndPoint) License requirements: routing_harness ("Routing Harness") .
void	setShowLeadersToggle(boolean showLeadersToggle) License requirements: routing_harness ("Routing Harness") .
void	setType(PathLengthAnnotationBuilder.Types type) License requirements: routing_harness ("Routing Harness") .
boolean	showLeadersToggle() Returns the show leaders toggle License requirements: routing_harness ("Routing Harness") .
StyleBuilder	style() Returns the style License requirements: routing_harness ("Routing Harness") .
TextWithEditControlsBuilder	text() Returns the u icomp text with symbols0 License requirements: routing_harness ("Routing Harness") .
PathLengthAnnotationBuilder.Types	type() Returns the type License requirements: routing_harness ("Routing Harness") .

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

firstEndPoint

Point firstEndPoint()
             throws NXException,
                    RemoteException

Returns the first end point
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

setFirstEndPoint

void setFirstEndPoint(Point firstEndPoint)
               throws NXException,
                      RemoteException

License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

firstEndPoint -

Throws:

NXException

RemoteException

secondEndPoint

Point secondEndPoint()
              throws NXException,
                     RemoteException

Returns the second end point
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

setSecondEndPoint

void setSecondEndPoint(Point secondEndPoint)
                throws NXException,
                       RemoteException

License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

secondEndPoint -

Throws:

NXException

RemoteException

routeObjectCollector

RouteObjectCollector routeObjectCollector()
                                   throws NXException,
                                          RemoteException

Returns the route object collector
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

origin

OriginBuilder origin()
              throws NXException,
                     RemoteException

Returns the origin
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

leader

LeaderBuilder leader()
              throws NXException,
                     RemoteException

Returns the leader
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

showLeadersToggle

boolean showLeadersToggle()
                   throws NXException,
                          RemoteException

Returns the show leaders toggle
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

setShowLeadersToggle

void setShowLeadersToggle(boolean showLeadersToggle)
                   throws NXException,
                          RemoteException

License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

showLeadersToggle -

Throws:

NXException

RemoteException

text

TextWithEditControlsBuilder text()
                          throws NXException,
                                 RemoteException

Returns the u icomp text with symbols0
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

style

StyleBuilder style()
            throws NXException,
                   RemoteException

Returns the style
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

type

PathLengthAnnotationBuilder.Types type()
                                throws NXException,
                                       RemoteException

Returns the type
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

setType

void setType(PathLengthAnnotationBuilder.Types type)
      throws NXException,
             RemoteException

License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

type -

Throws:

NXException

RemoteException

expressionName

String expressionName()
               throws NXException,
                      RemoteException

Returns the expression name
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

setPathLengthAnnotationEndPoints

void setPathLengthAnnotationEndPoints(Point firstEndPoint,
                                      Point secondEndPoint)
                               throws NXException,
                                      RemoteException

Create and initialize the Path Length Annotation
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

firstEndPoint - First end point for the path length annotation

secondEndPoint - Second end point for the path length annotation

Throws:

NXException

RemoteException

createPointsAtRcps

void createPointsAtRcps(ControlPoint firstEndRcp,
                        ControlPoint secondEndRcp)
                 throws NXException,
                        RemoteException

Create builder end points at the RCP locations
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

firstEndRcp - First Routing control point

secondEndRcp - Second Routing control point

Throws:

NXException

RemoteException