Builder for creating terminal arrays in multiports. More...

Inheritance diagram for NXOpen::Routing::PortArraysBuilder:

Public Types
enum	ArrayTypes { ArrayTypesRectangular, ArrayTypesCircular }
	Determines the array type that will be selected. More...

enum	NamingMethods { NamingMethodsClockwise, NamingMethodsCounterclockwise, NamingMethodsAcross, NamingMethodsContinuous, NamingMethodsRowCol }
	Determines the naming method for the terminal ports. More...

enum	StartingCorners { StartingCornersBottomLeft, StartingCornersBottomRight, StartingCornersUpperLeft, StartingCornersUpperRight }
	Determines the starting location for naming terminal ports. More...

enum	StartingDirections { StartingDirectionsHorizontal, StartingDirectionsVertical }
	Determines the starting direction for naming terminal ports. More...

Public Member Functions
NXOpen::Routing::PortArrayListItemBuilderList *	ArrayPatternList ()
	Returns the array pattern list Created in NX1847.0.0. More...

NXOpen::Routing::PortArraysBuilder::ArrayTypes	ArrayType ()
	Returns the array type Created in NX1847.0.0. More...

NXOpen::Routing::PortArraysBuilder::NamingMethods	NamingMethod ()
	Returns the naming method Created in NX1847.0.0. More...

NXOpen::Routing::NamingPatternBuilder *	PatternCol ()
	Returns the naming pattern for the columns of Column/Row rectangular terminal port arrays Created in NX1847.0.0. More...

NXOpen::Routing::NamingPatternBuilder *	PatternRow ()
	Returns the naming pattern for the rows of Column/Row rectangular terminal port arrays Created in NX1847.0.0. More...

bool	ReuseSuppressedNames ()
	Returns the reuse suppressed names Created in NX1847.0.0. More...

void	SetArrayType (NXOpen::Routing::PortArraysBuilder::ArrayTypes arrayType)
	Sets the array type Created in NX1847.0.0. More...

void	SetNamingMethod (NXOpen::Routing::PortArraysBuilder::NamingMethods namingMethod)
	Sets the naming method Created in NX1847.0.0. More...

void	SetPatternCol (NXOpen::Routing::NamingPatternBuilder *patternCol)
	Sets the naming pattern for the columns of Column/Row rectangular terminal port arrays Created in NX1847.0.0. More...

void	SetPatternRow (NXOpen::Routing::NamingPatternBuilder *patternRow)
	Sets the naming pattern for the rows of Column/Row rectangular terminal port arrays Created in NX1847.0.0. More...

void	SetReuseSuppressedNames (bool reuseSuppressedNames)
	Sets the reuse suppressed names Created in NX1847.0.0. More...

void	SetStartingCorner (NXOpen::Routing::PortArraysBuilder::StartingCorners startingCorner)
	Sets the starting corner Created in NX1847.0.0. More...

void	SetStartingDirection (NXOpen::Routing::PortArraysBuilder::StartingDirections startingDirection)
	Sets the starting direction Created in NX1847.0.0. More...

NXOpen::Routing::PortArraysBuilder::StartingCorners	StartingCorner ()
	Returns the starting corner Created in NX1847.0.0. More...

NXOpen::Routing::PortArraysBuilder::StartingDirections	StartingDirection ()
	Returns the starting direction Created in NX1847.0.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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 creating terminal arrays in multiports.

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

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::Routing::PortArraysBuilder::ArrayTypes

Determines the array type that will be selected.

Enumerator
ArrayTypesRectangular	rectangular
ArrayTypesCircular	circular

enum NXOpen::Routing::PortArraysBuilder::NamingMethods

Determines the naming method for the terminal ports.

Enumerator
NamingMethodsClockwise	clockwise
NamingMethodsCounterclockwise	counterclockwise
NamingMethodsAcross	across
NamingMethodsContinuous	continuous
NamingMethodsRowCol	row col

enum NXOpen::Routing::PortArraysBuilder::StartingCorners

Determines the starting location for naming terminal ports.

Enumerator
StartingCornersBottomLeft	bottom left
StartingCornersBottomRight	bottom right
StartingCornersUpperLeft	upper left
StartingCornersUpperRight	upper right

enum NXOpen::Routing::PortArraysBuilder::StartingDirections

Determines the starting direction for naming terminal ports.

Enumerator
StartingDirectionsHorizontal	horizontal
StartingDirectionsVertical	vertical

Member Function Documentation

NXOpen::Routing::PortArrayListItemBuilderList* NXOpen::Routing::PortArraysBuilder::ArrayPatternList ( )

Returns the array pattern list
Created in NX1847.0.0.