NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::Routing::NamingPatternBuilder Class Reference

Builder for selecting a naming pattern for terminal arrays. More...

Inheritance diagram for NXOpen::Routing::NamingPatternBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PatternTypes { PatternTypesNumber, PatternTypesUpperChar, PatternTypesLowerChar }
 Determines the naming sequence for terminal ports. More...
 

Public Member Functions

NXString EndString ()
 Returns the end string
Created in NX1847.0.0. More...
 
NXOpen::Routing::NamingPatternBuilder::PatternTypes PatternType ()
 Returns the pattern type
Created in NX1847.0.0. More...
 
NXString Prefix ()
 Returns the prefix
Created in NX1847.0.0. More...
 
void SetEndString (const NXString &endString)
 Sets the end string
Created in NX1847.0.0. More...
 
void SetEndString (const char *endString)
 Sets the end string
Created in NX1847.0.0. More...
 
void SetPatternType (NXOpen::Routing::NamingPatternBuilder::PatternTypes patternType)
 Sets the pattern type
Created in NX1847.0.0. More...
 
void SetPrefix (const NXString &prefix)
 Sets the prefix
Created in NX1847.0.0. More...
 
void SetPrefix (const char *prefix)
 Sets the prefix
Created in NX1847.0.0. More...
 
void SetStartString (const NXString &startString)
 Sets the start string
Created in NX1847.0.0. More...
 
void SetStartString (const char *startString)
 Sets the start string
Created in NX1847.0.0. More...
 
void SetSuffix (const NXString &suffix)
 Sets the suffix
Created in NX1847.0.0. More...
 
void SetSuffix (const char *suffix)
 Sets the suffix
Created in NX1847.0.0. More...
 
NXString StartString ()
 Returns the start string
Created in NX1847.0.0. More...
 
NXString Suffix ()
 Returns the suffix
Created in NX1847.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Builder for selecting a naming pattern for terminal arrays.


To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateNamingPatternBuilder

Created in NX1847.0.0.

Member Enumeration Documentation

Determines the naming sequence for terminal ports.

Enumerator
PatternTypesNumber 

number

PatternTypesUpperChar 

upper char

PatternTypesLowerChar 

lower char

Member Function Documentation

NXString NXOpen::Routing::NamingPatternBuilder::EndString ( )

Returns the end string
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Routing::NamingPatternBuilder::PatternTypes NXOpen::Routing::NamingPatternBuilder::PatternType ( )

Returns the pattern type
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXString NXOpen::Routing::NamingPatternBuilder::Prefix ( )

Returns the prefix
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::NamingPatternBuilder::SetEndString ( const NXString endString)

Sets the end string
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
endStringendstring
void NXOpen::Routing::NamingPatternBuilder::SetEndString ( const char *  endString)

Sets the end string
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
endStringendstring
void NXOpen::Routing::NamingPatternBuilder::SetPatternType ( NXOpen::Routing::NamingPatternBuilder::PatternTypes  patternType)

Sets the pattern type
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
patternTypepatterntype
void NXOpen::Routing::NamingPatternBuilder::SetPrefix ( const NXString prefix)

Sets the prefix
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
prefixprefix
void NXOpen::Routing::NamingPatternBuilder::SetPrefix ( const char *  prefix)

Sets the prefix
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
prefixprefix
void NXOpen::Routing::NamingPatternBuilder::SetStartString ( const NXString startString)

Sets the start string
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
startStringstartstring
void NXOpen::Routing::NamingPatternBuilder::SetStartString ( const char *  startString)

Sets the start string
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
startStringstartstring
void NXOpen::Routing::NamingPatternBuilder::SetSuffix ( const NXString suffix)

Sets the suffix
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
suffixsuffix
void NXOpen::Routing::NamingPatternBuilder::SetSuffix ( const char *  suffix)

Sets the suffix
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
suffixsuffix
NXString NXOpen::Routing::NamingPatternBuilder::StartString ( )

Returns the start string
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXString NXOpen::Routing::NamingPatternBuilder::Suffix ( )

Returns the suffix
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.