BranchPathNumberingBuilder Class¶
-
class
NXOpen.Routing.
BranchPathNumberingBuilder
¶ Bases:
NXOpen.Builder
Builder class for Branch Path Numbering.
To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreateBranchPathNumberingBuilder()
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
DisplayOnSegments | Returns or sets the toggle specified in the UI on whether to display the labels |
FirstBranchID | Returns or sets the formula specified in the UI to compute the first branch ID for the labeling sequence in order to be valid, the formula must be blank OR contain the phrase PARENT_BRANCH_ID |
NextBranchID | Returns or sets the formula specified in the UI to compute the next branch ID for the labeling sequence in order to be valid, the formula must be blank OR contain the phrase PREVIOUS_BRANCH_ID |
Prefix | Returns or sets the prefix specified in the UI for the labels |
ReassignOnSegments | Returns or sets the toggle specified in the UI on whether to reassign the labels |
SequenceMethod | Returns or sets the sequence method specified in the UI for the labels |
StartValue | Returns or sets the start value specified in the UI for the labeling sequence |
StartValueForLowerCase | Returns or sets the start value for lower case alphabet. |
StartValueForNumbers | Returns or sets the start value for numbers. |
StartValueForUpperCase | Returns or sets the start value for upper case alphabet. |
Suffix | Returns or sets the suffix specified in the UI for the labels |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
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. |
SetControlPoint | Set the control point for the start of the labeling sequence |
SetControlPointFromSegment | Set the control point for the start of the labeling sequence |
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¶
BranchPathNumberingBuilderSequence Enumeration | Specifies the sequence method |
Property Detail¶
DisplayOnSegments¶
-
BranchPathNumberingBuilder.
DisplayOnSegments
¶ Returns or sets the toggle specified in the UI on whether to display the labels
-------------------------------------
Getter Method
Signature
DisplayOnSegments
Returns: Return type: bool New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
DisplayOnSegments
Parameters: displayOnSegments (bool) – New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
FirstBranchID¶
-
BranchPathNumberingBuilder.
FirstBranchID
¶ Returns or sets the formula specified in the UI to compute the first branch ID for the labeling sequence in order to be valid, the formula must be blank OR contain the phrase “PARENT_BRANCH_ID”
-------------------------------------
Getter Method
Signature
FirstBranchID
Returns: Return type: str New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
FirstBranchID
Parameters: numberingFirstBranchID (str) – New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
NextBranchID¶
-
BranchPathNumberingBuilder.
NextBranchID
¶ Returns or sets the formula specified in the UI to compute the next branch ID for the labeling sequence in order to be valid, the formula must be blank OR contain the phrase “PREVIOUS_BRANCH_ID”
-------------------------------------
Getter Method
Signature
NextBranchID
Returns: Return type: str New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
NextBranchID
Parameters: nextBranchID (str) – New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
Prefix¶
-
BranchPathNumberingBuilder.
Prefix
¶ Returns or sets the prefix specified in the UI for the labels
-------------------------------------
Getter Method
Signature
Prefix
Returns: Return type: str New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
Prefix
Parameters: prefix (str) – New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
ReassignOnSegments¶
-
BranchPathNumberingBuilder.
ReassignOnSegments
¶ Returns or sets the toggle specified in the UI on whether to reassign the labels
-------------------------------------
Getter Method
Signature
ReassignOnSegments
Returns: Return type: bool New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
ReassignOnSegments
Parameters: reassignOnSegments (bool) – New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
SequenceMethod¶
-
BranchPathNumberingBuilder.
SequenceMethod
¶ Returns or sets the sequence method specified in the UI for the labels
-------------------------------------
Getter Method
Signature
SequenceMethod
Returns: Return type: NXOpen.Routing.BranchPathNumberingBuilderSequence
New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
SequenceMethod
Parameters: sequenceMethod ( NXOpen.Routing.BranchPathNumberingBuilderSequence
) –New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
StartValue¶
-
BranchPathNumberingBuilder.
StartValue
¶ Returns or sets the start value specified in the UI for the labeling sequence
-------------------------------------
Getter Method
Signature
StartValue
Returns: Return type: str New in version NX8.5.1.
Deprecated since version NX8.5.2: Use
Routing.BranchPathNumberingBuilder.StartValueForNumbers()
,Routing.BranchPathNumberingBuilder.StartValueForUpperCase()
, orRouting.BranchPathNumberingBuilder.StartValueForLowerCase()
instead.License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
StartValue
Parameters: startValue (str) – New in version NX8.5.1.
Deprecated since version NX8.5.2: Use
Routing.BranchPathNumberingBuilder.StartValueForNumbers()
,Routing.BranchPathNumberingBuilder.StartValueForUpperCase()
, orRouting.BranchPathNumberingBuilder.StartValueForLowerCase()
instead.License requirements: routing_hvac (“Routing HVAC”)
StartValueForLowerCase¶
-
BranchPathNumberingBuilder.
StartValueForLowerCase
¶ Returns or sets the start value for lower case alphabet.
The default value is “a” if the customer does not call this method
-------------------------------------
Getter Method
Signature
StartValueForLowerCase
Returns: Return type: str New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
StartValueForLowerCase
Parameters: startValueForLowerCase (str) – New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
StartValueForNumbers¶
-
BranchPathNumberingBuilder.
StartValueForNumbers
¶ Returns or sets the start value for numbers.
The default value is “1” if the customer does not call this method
-------------------------------------
Getter Method
Signature
StartValueForNumbers
Returns: Return type: str New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
StartValueForNumbers
Parameters: startValueForNumbers (str) – New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
StartValueForUpperCase¶
-
BranchPathNumberingBuilder.
StartValueForUpperCase
¶ Returns or sets the start value for upper case alphabet.
The default value is “A” if the customer does not call this method
-------------------------------------
Getter Method
Signature
StartValueForUpperCase
Returns: Return type: str New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
StartValueForUpperCase
Parameters: startValueForUpperCase (str) – New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
Suffix¶
-
BranchPathNumberingBuilder.
Suffix
¶ Returns or sets the suffix specified in the UI for the labels
-------------------------------------
Getter Method
Signature
Suffix
Returns: Return type: str New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
-------------------------------------
Setter Method
Signature
Suffix
Parameters: suffix (str) – New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
Method Detail¶
SetControlPoint¶
-
BranchPathNumberingBuilder.
SetControlPoint
¶ Set the control point for the start of the labeling sequence
Signature
SetControlPoint(controlPoint)
Parameters: controlPoint ( NXOpen.Routing.ControlPoint
) –New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
SetControlPointFromSegment¶
-
BranchPathNumberingBuilder.
SetControlPointFromSegment
¶ Set the control point for the start of the labeling sequence
Signature
SetControlPointFromSegment(controlPoint)
Parameters: controlPoint ( NXOpen.Routing.ISegment
) –New in version NX8.5.1.
License requirements: routing_hvac (“Routing HVAC”)
Validate¶
-
BranchPathNumberingBuilder.
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.