public interface BranchPathNumberingBuilder extends Builder
RouteManager.createBranchPathNumberingBuilder()
Modifier and Type | Interface and Description |
---|---|
static class |
BranchPathNumberingBuilder.Sequence
Specifies the sequence method
|
Modifier and Type | Method and Description |
---|---|
boolean |
displayOnSegments()
Returns the toggle specified in the UI on whether to display the labels
License requirements: routing_hvac ("Routing HVAC") . |
String |
firstBranchID()
Returns 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"
License requirements: routing_hvac ("Routing HVAC") . |
String |
nextBranchID()
Returns 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"
License requirements: routing_hvac ("Routing HVAC") . |
String |
prefix()
Returns the prefix specified in the UI for the labels
License requirements: routing_hvac ("Routing HVAC") . |
boolean |
reassignOnSegments()
Returns the toggle specified in the UI on whether to reassign the labels
License requirements: routing_hvac ("Routing HVAC") . |
BranchPathNumberingBuilder.Sequence |
sequenceMethod()
Returns the sequence method specified in the UI for the labels
License requirements: routing_hvac ("Routing HVAC") . |
void |
setControlPoint(ControlPoint controlPoint)
Set the control point for the start of the labeling sequence
License requirements: routing_hvac ("Routing HVAC") . |
void |
setControlPointFromSegment(ISegment controlPoint)
Set the control point for the start of the labeling sequence
License requirements: routing_hvac ("Routing HVAC") . |
void |
setDisplayOnSegments(boolean displayOnSegments)
License requirements: routing_hvac ("Routing HVAC") . |
void |
setFirstBranchID(String numberingFirstBranchID)
License requirements: routing_hvac ("Routing HVAC") . |
void |
setNextBranchID(String nextBranchID)
License requirements: routing_hvac ("Routing HVAC") . |
void |
setPrefix(String prefix)
License requirements: routing_hvac ("Routing HVAC") . |
void |
setReassignOnSegments(boolean reassignOnSegments)
License requirements: routing_hvac ("Routing HVAC") . |
void |
setSequenceMethod(BranchPathNumberingBuilder.Sequence sequenceMethod)
License requirements: routing_hvac ("Routing HVAC") . |
void |
setStartValue(String startValue)
Deprecated.
Deprecated in NX8.5.2. Use
Routing.BranchPathNumberingBuilder#setSetStartValueForNumbers , Routing.BranchPathNumberingBuilder#setSetStartValueForUpperCase , or Routing.BranchPathNumberingBuilder#setSetStartValueForLowerCase instead.
|
void |
setStartValueForLowerCase(String startValueForLowerCase)
License requirements: routing_hvac ("Routing HVAC") . |
void |
setStartValueForNumbers(String startValueForNumbers)
License requirements: routing_hvac ("Routing HVAC") . |
void |
setStartValueForUpperCase(String startValueForUpperCase)
License requirements: routing_hvac ("Routing HVAC") . |
void |
setSuffix(String suffix)
License requirements: routing_hvac ("Routing HVAC") . |
String |
startValue()
Deprecated.
Deprecated in NX8.5.2. Use
Routing.BranchPathNumberingBuilder#startValueForNumbers , Routing.BranchPathNumberingBuilder#startValueForUpperCase , or Routing.BranchPathNumberingBuilder#startValueForLowerCase instead.
|
String |
startValueForLowerCase()
Returns the start value for lower case alphabet.
|
String |
startValueForNumbers()
Returns the start value for numbers.
|
String |
startValueForUpperCase()
Returns the start value for upper case alphabet.
|
String |
suffix()
Returns the suffix specified in the UI for the labels
License requirements: routing_hvac ("Routing HVAC") . |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
void setControlPoint(ControlPoint controlPoint) throws NXException, RemoteException
controlPoint
- NXException
RemoteException
void setControlPointFromSegment(ISegment controlPoint) throws NXException, RemoteException
controlPoint
- NXException
RemoteException
String prefix() throws NXException, RemoteException
NXException
RemoteException
void setPrefix(String prefix) throws NXException, RemoteException
prefix
- NXException
RemoteException
String suffix() throws NXException, RemoteException
NXException
RemoteException
void setSuffix(String suffix) throws NXException, RemoteException
suffix
- NXException
RemoteException
BranchPathNumberingBuilder.Sequence sequenceMethod() throws NXException, RemoteException
NXException
RemoteException
void setSequenceMethod(BranchPathNumberingBuilder.Sequence sequenceMethod) throws NXException, RemoteException
sequenceMethod
- NXException
RemoteException
String startValue() throws NXException, RemoteException
Routing.BranchPathNumberingBuilder#startValueForNumbers
, Routing.BranchPathNumberingBuilder#startValueForUpperCase
, or Routing.BranchPathNumberingBuilder#startValueForLowerCase
instead.
NXException
RemoteException
void setStartValue(String startValue) throws NXException, RemoteException
Routing.BranchPathNumberingBuilder#setSetStartValueForNumbers
, Routing.BranchPathNumberingBuilder#setSetStartValueForUpperCase
, or Routing.BranchPathNumberingBuilder#setSetStartValueForLowerCase
instead.
startValue
- NXException
RemoteException
String firstBranchID() throws NXException, RemoteException
NXException
RemoteException
void setFirstBranchID(String numberingFirstBranchID) throws NXException, RemoteException
numberingFirstBranchID
- NXException
RemoteException
String nextBranchID() throws NXException, RemoteException
NXException
RemoteException
void setNextBranchID(String nextBranchID) throws NXException, RemoteException
nextBranchID
- NXException
RemoteException
boolean displayOnSegments() throws NXException, RemoteException
NXException
RemoteException
void setDisplayOnSegments(boolean displayOnSegments) throws NXException, RemoteException
displayOnSegments
- NXException
RemoteException
boolean reassignOnSegments() throws NXException, RemoteException
NXException
RemoteException
void setReassignOnSegments(boolean reassignOnSegments) throws NXException, RemoteException
reassignOnSegments
- NXException
RemoteException
String startValueForNumbers() throws NXException, RemoteException
NXException
RemoteException
void setStartValueForNumbers(String startValueForNumbers) throws NXException, RemoteException
startValueForNumbers
- NXException
RemoteException
String startValueForUpperCase() throws NXException, RemoteException
NXException
RemoteException
void setStartValueForUpperCase(String startValueForUpperCase) throws NXException, RemoteException
startValueForUpperCase
- NXException
RemoteException
String startValueForLowerCase() throws NXException, RemoteException
NXException
RemoteException
void setStartValueForLowerCase(String startValueForLowerCase) throws NXException, RemoteException
startValueForLowerCase
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.