Builder class for Branch Path Numbering. More...

Inheritance diagram for NXOpen::Routing::BranchPathNumberingBuilder:

Public Types
enum	Sequence { SequenceNumbers, SequenceUpperCase, SequenceLowerCase }
	Specifies the sequence method. More...

Public Member Functions
bool	DisplayOnSegments ()
	Returns the toggle specified in the UI on whether to display the labels Created in NX8.5.1.

NXString	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".

NXString	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".

NXString	Prefix ()
	Returns the prefix specified in the UI for the labels Created in NX8.5.1.

bool	ReassignOnSegments ()
	Returns the toggle specified in the UI on whether to reassign the labels Created in NX8.5.1.

NXOpen::Routing::BranchPathNumberingBuilder::Sequence	SequenceMethod ()
	Returns the sequence method specified in the UI for the labels.

void	SetControlPoint (NXOpen::Routing::ControlPoint *controlPoint)
	Set the control point for the start of the labeling sequence Created in NX8.5.1.

void	SetControlPointFromSegment (NXOpen::Routing::ISegment *controlPoint)
	Set the control point for the start of the labeling sequence Created in NX8.5.1.

void	SetDisplayOnSegments (bool displayOnSegments)
	Sets the toggle specified in the UI on whether to display the labels Created in NX8.5.1.

void	SetFirstBranchID (const NXString &numberingFirstBranchID)
	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".

void	SetFirstBranchID (const char *numberingFirstBranchID)
	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".

void	SetNextBranchID (const NXString &nextBranchID)
	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".

void	SetNextBranchID (const char *nextBranchID)
	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".

void	SetPrefix (const NXString &prefix)
	Sets the prefix specified in the UI for the labels Created in NX8.5.1.

void	SetPrefix (const char *prefix)
	Sets the prefix specified in the UI for the labels Created in NX8.5.1.

void	SetReassignOnSegments (bool reassignOnSegments)
	Sets the toggle specified in the UI on whether to reassign the labels Created in NX8.5.1.

void	SetSequenceMethod (NXOpen::Routing::BranchPathNumberingBuilder::Sequence sequenceMethod)
	Sets the sequence method specified in the UI for the labels.

void	SetStartValue (const NXString &startValue)
	Sets the start value specified in the UI for the labeling sequence

void	SetStartValue (const char *startValue)
	Sets the start value specified in the UI for the labeling sequence

void	SetStartValueForLowerCase (const NXString &startValueForLowerCase)
	Sets the start value for lower case alphabet.

void	SetStartValueForLowerCase (const char *startValueForLowerCase)
	Sets the start value for lower case alphabet.

void	SetStartValueForNumbers (const NXString &startValueForNumbers)
	Sets the start value for numbers.

void	SetStartValueForNumbers (const char *startValueForNumbers)
	Sets the start value for numbers.

void	SetStartValueForUpperCase (const NXString &startValueForUpperCase)
	Sets the start value for upper case alphabet.

void	SetStartValueForUpperCase (const char *startValueForUpperCase)
	Sets the start value for upper case alphabet.

void	SetSuffix (const NXString &suffix)
	Sets the suffix specified in the UI for the labels Created in NX8.5.1.

void	SetSuffix (const char *suffix)
	Sets the suffix specified in the UI for the labels Created in NX8.5.1.

NXString	StartValue ()
	Returns the start value specified in the UI for the labeling sequence

NXString	StartValueForLowerCase ()
	Returns the start value for lower case alphabet.

NXString	StartValueForNumbers ()
	Returns the start value for numbers.

NXString	StartValueForUpperCase ()
	Returns the start value for upper case alphabet.

NXString	Suffix ()
	Returns the suffix specified in the UI for the labels Created in NX8.5.1.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Builder class for Branch Path Numbering.

<br> To create a new instance of this class, use @link Routing::RouteManager::CreateBranchPathNumberingBuilder  Routing::RouteManager::CreateBranchPathNumberingBuilder @endlink  <br>

Created in NX8.5.0.

Member Enumeration Documentation

enum NXOpen::Routing::BranchPathNumberingBuilder::Sequence

Specifies the sequence method.

Enumerator:

SequenceNumbers	1, 2, 3,....
SequenceUpperCase	A, B, C,....
SequenceLowerCase	a, b, c,....

Member Function Documentation

bool NXOpen::Routing::BranchPathNumberingBuilder::DisplayOnSegments ( )

Returns the toggle specified in the UI on whether to display the labels
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

NXString NXOpen::Routing::BranchPathNumberingBuilder::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".

Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

NXString NXOpen::Routing::BranchPathNumberingBuilder::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".

Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

NXString NXOpen::Routing::BranchPathNumberingBuilder::Prefix ( )

Returns the prefix specified in the UI for the labels
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

bool NXOpen::Routing::BranchPathNumberingBuilder::ReassignOnSegments ( )

Returns the toggle specified in the UI on whether to reassign the labels
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

NXOpen::Routing::BranchPathNumberingBuilder::Sequence NXOpen::Routing::BranchPathNumberingBuilder::SequenceMethod ( )

Returns the sequence method specified in the UI for the labels.

Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

void NXOpen::Routing::BranchPathNumberingBuilder::SetControlPoint ( NXOpen::Routing::ControlPoint * controlPoint )

Set the control point for the start of the labeling sequence
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

controlPoint controlpoint

void NXOpen::Routing::BranchPathNumberingBuilder::SetControlPointFromSegment ( NXOpen::Routing::ISegment * controlPoint )

Set the control point for the start of the labeling sequence
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

controlPoint controlpoint

void NXOpen::Routing::BranchPathNumberingBuilder::SetDisplayOnSegments ( bool displayOnSegments )

Sets the toggle specified in the UI on whether to display the labels
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

displayOnSegments displayonsegments

void NXOpen::Routing::BranchPathNumberingBuilder::SetFirstBranchID ( const NXString & numberingFirstBranchID )

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".

Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

numberingFirstBranchID numberingfirstbranchid

void NXOpen::Routing::BranchPathNumberingBuilder::SetFirstBranchID ( const char * numberingFirstBranchID )

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".

Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

numberingFirstBranchID numberingfirstbranchid

void NXOpen::Routing::BranchPathNumberingBuilder::SetNextBranchID ( const NXString & nextBranchID )

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".

Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

nextBranchID nextbranchid

void NXOpen::Routing::BranchPathNumberingBuilder::SetNextBranchID ( const char * nextBranchID )

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".

Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

nextBranchID nextbranchid

void NXOpen::Routing::BranchPathNumberingBuilder::SetPrefix ( const NXString & prefix )

Sets the prefix specified in the UI for the labels
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

prefix prefix

void NXOpen::Routing::BranchPathNumberingBuilder::SetPrefix ( const char * prefix )

Sets the prefix specified in the UI for the labels
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

prefix prefix

void NXOpen::Routing::BranchPathNumberingBuilder::SetReassignOnSegments ( bool reassignOnSegments )

Sets the toggle specified in the UI on whether to reassign the labels
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

reassignOnSegments reassignonsegments

void NXOpen::Routing::BranchPathNumberingBuilder::SetSequenceMethod ( NXOpen::Routing::BranchPathNumberingBuilder::Sequence sequenceMethod )

Sets the sequence method specified in the UI for the labels.

Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

sequenceMethod sequencemethod

void NXOpen::Routing::BranchPathNumberingBuilder::SetStartValue ( const NXString & startValue )

Sets the start value specified in the UI for the labeling sequence

Deprecated:: Deprecated in NX8.5.2.

Use Routing::BranchPathNumberingBuilder::SetSetStartValueForNumbers , Routing::BranchPathNumberingBuilder::SetSetStartValueForUpperCase , or Routing::BranchPathNumberingBuilder::SetSetStartValueForLowerCase instead.

Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

startValue startvalue

void NXOpen::Routing::BranchPathNumberingBuilder::SetStartValue ( const char * startValue )

Sets the start value specified in the UI for the labeling sequence

Deprecated:: Deprecated in NX8.5.2.

Use Routing::BranchPathNumberingBuilder::SetSetStartValueForNumbers , Routing::BranchPathNumberingBuilder::SetSetStartValueForUpperCase , or Routing::BranchPathNumberingBuilder::SetSetStartValueForLowerCase instead.

Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

startValue startvalue

void NXOpen::Routing::BranchPathNumberingBuilder::SetStartValueForLowerCase ( const NXString & startValueForLowerCase )

Sets the start value for lower case alphabet.

The default value is "a" if the customer does not call this method
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

startValueForLowerCase startvalueforlowercase

void NXOpen::Routing::BranchPathNumberingBuilder::SetStartValueForLowerCase ( const char * startValueForLowerCase )

Sets the start value for lower case alphabet.

The default value is "a" if the customer does not call this method
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

startValueForLowerCase startvalueforlowercase

void NXOpen::Routing::BranchPathNumberingBuilder::SetStartValueForNumbers ( const NXString & startValueForNumbers )

Sets the start value for numbers.

The default value is "1" if the customer does not call this method
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

startValueForNumbers startvaluefornumbers

void NXOpen::Routing::BranchPathNumberingBuilder::SetStartValueForNumbers ( const char * startValueForNumbers )

Sets the start value for numbers.

The default value is "1" if the customer does not call this method
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

startValueForNumbers startvaluefornumbers

void NXOpen::Routing::BranchPathNumberingBuilder::SetStartValueForUpperCase ( const NXString & startValueForUpperCase )

Sets the start value for upper case alphabet.

The default value is "A" if the customer does not call this method
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

startValueForUpperCase startvalueforuppercase

void NXOpen::Routing::BranchPathNumberingBuilder::SetStartValueForUpperCase ( const char * startValueForUpperCase )

Sets the start value for upper case alphabet.

The default value is "A" if the customer does not call this method
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

startValueForUpperCase startvalueforuppercase

void NXOpen::Routing::BranchPathNumberingBuilder::SetSuffix ( const NXString & suffix )

Sets the suffix specified in the UI for the labels
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

suffix suffix

void NXOpen::Routing::BranchPathNumberingBuilder::SetSuffix ( const char * suffix )

Sets the suffix specified in the UI for the labels
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

Parameters

suffix suffix

NXString NXOpen::Routing::BranchPathNumberingBuilder::StartValue ( )

Returns the start value specified in the UI for the labeling sequence

Deprecated:: Deprecated in NX8.5.2.

Use Routing::BranchPathNumberingBuilder::StartValueForNumbers , Routing::BranchPathNumberingBuilder::StartValueForUpperCase , or Routing::BranchPathNumberingBuilder::StartValueForLowerCase instead.

Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

NXString NXOpen::Routing::BranchPathNumberingBuilder::StartValueForLowerCase ( )

Returns the start value for lower case alphabet.

The default value is "a" if the customer does not call this method
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

NXString NXOpen::Routing::BranchPathNumberingBuilder::StartValueForNumbers ( )

Returns the start value for numbers.

The default value is "1" if the customer does not call this method
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

NXString NXOpen::Routing::BranchPathNumberingBuilder::StartValueForUpperCase ( )

Returns the start value for upper case alphabet.

The default value is "A" if the customer does not call this method
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

NXString NXOpen::Routing::BranchPathNumberingBuilder::Suffix ( )

Returns the suffix specified in the UI for the labels
Created in NX8.5.1.

License requirements : routing_hvac ("Routing HVAC")

The documentation for this class was generated from the following file:

Routing_BranchPathNumberingBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation