PathLengthAnnotationBuilder Class¶
-
class
NXOpen.Formboard.
PathLengthAnnotationBuilder
¶ Bases:
NXOpen.Builder
TODO Class documentation
To create a new instance of this class, use
NXOpen.Formboard.FormboardManager.CreatePathLengthAnnotationBuilder()
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 New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
ExpressionName | Returns the expression name |
FirstEndPoint | Returns or sets the first end point |
Leader | Returns the leader |
Origin | Returns the origin |
RouteObjectCollector | Returns the route object collector |
SecondEndPoint | Returns or sets the second end point |
ShowLeadersToggle | Returns or sets the show leaders toggle |
Style | Returns the style |
Tag | Returns the Tag for this object. |
Text | Returns the u icomp text with symbols0 |
Type | Returns or sets the type |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreatePointsAtRcps | Create builder end points at the RCP locations |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
SetPathLengthAnnotationEndPoints | Create and initialize the Path Length Annotation |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
PathLengthAnnotationBuilderTypes Enumeration | TODO: Document the whole type |
Property Detail¶
ExpressionName¶
-
PathLengthAnnotationBuilder.
ExpressionName
¶ Returns the expression name
-------------------------------------
Getter Method
Signature
ExpressionName
Returns: Return type: str New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
FirstEndPoint¶
-
PathLengthAnnotationBuilder.
FirstEndPoint
¶ Returns or sets the first end point
-------------------------------------
Getter Method
Signature
FirstEndPoint
Returns: Return type: NXOpen.Point
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------
Setter Method
Signature
FirstEndPoint
Parameters: firstEndPoint ( NXOpen.Point
) –New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
Leader¶
-
PathLengthAnnotationBuilder.
Leader
¶ Returns the leader
-------------------------------------
Getter Method
Signature
Leader
Returns: Return type: NXOpen.Annotations.LeaderBuilder
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
Origin¶
-
PathLengthAnnotationBuilder.
Origin
¶ Returns the origin
-------------------------------------
Getter Method
Signature
Origin
Returns: Return type: NXOpen.Annotations.OriginBuilder
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
RouteObjectCollector¶
-
PathLengthAnnotationBuilder.
RouteObjectCollector
¶ Returns the route object collector
-------------------------------------
Getter Method
Signature
RouteObjectCollector
Returns: Return type: NXOpen.Routing.RouteObjectCollector
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
SecondEndPoint¶
-
PathLengthAnnotationBuilder.
SecondEndPoint
¶ Returns or sets the second end point
-------------------------------------
Getter Method
Signature
SecondEndPoint
Returns: Return type: NXOpen.Point
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------
Setter Method
Signature
SecondEndPoint
Parameters: secondEndPoint ( NXOpen.Point
) –New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
ShowLeadersToggle¶
-
PathLengthAnnotationBuilder.
ShowLeadersToggle
¶ Returns or sets the show leaders toggle
-------------------------------------
Getter Method
Signature
ShowLeadersToggle
Returns: Return type: bool New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------
Setter Method
Signature
ShowLeadersToggle
Parameters: showLeadersToggle (bool) – New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
Style¶
-
PathLengthAnnotationBuilder.
Style
¶ Returns the style
-------------------------------------
Getter Method
Signature
Style
Returns: Return type: NXOpen.Annotations.StyleBuilder
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
Text¶
-
PathLengthAnnotationBuilder.
Text
¶ Returns the u icomp text with symbols0
-------------------------------------
Getter Method
Signature
Text
Returns: Return type: NXOpen.Annotations.TextWithEditControlsBuilder
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
Type¶
-
PathLengthAnnotationBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.Formboard.PathLengthAnnotationBuilderTypes
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.Formboard.PathLengthAnnotationBuilderTypes
) –New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
Method Detail¶
CreatePointsAtRcps¶
-
PathLengthAnnotationBuilder.
CreatePointsAtRcps
¶ Create builder end points at the RCP locations
Signature
CreatePointsAtRcps(firstEndRcp, secondEndRcp)
Parameters: - firstEndRcp (
NXOpen.Routing.ControlPoint
) – First Routing control point - secondEndRcp (
NXOpen.Routing.ControlPoint
) – Second Routing control point
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
- firstEndRcp (
SetPathLengthAnnotationEndPoints¶
-
PathLengthAnnotationBuilder.
SetPathLengthAnnotationEndPoints
¶ Create and initialize the Path Length Annotation
Signature
SetPathLengthAnnotationEndPoints(firstEndPoint, secondEndPoint)
Parameters: - firstEndPoint (
NXOpen.Point
) – First end point for the path length annotation - secondEndPoint (
NXOpen.Point
) – Second end point for the path length annotation
New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
- firstEndPoint (
Validate¶
-
PathLengthAnnotationBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.