Contains the preferences related to placing/finding/adding parts and generating the Routing bill of materials. More...

Public Types
enum	DetailLevel { DetailLevelSummary, DetailLevelItemized }
	The detail levels available for the Routing bill of material. More...

enum	FabricationNumbering { FabricationNumberingSequence, FabricationNumberingOriginal }
	The fabrication numbering methods available for the Routing bill of material. More...

enum	PreferredPortMethod { PreferredPortMethodAttribute, PreferredPortMethodName }
	Available methods for determining which port is the preferredport during calculation of placement solutions. More...

enum	StockLengthDisplay { StockLengthDisplaySum, StockLengthDisplayItem }
	The stock length display options available for the Routing bill of material. More...

enum	UsePreferredPort { UsePreferredPortFalse, UsePreferredPortTrue }
	Whether or not use the preferred port when determining placement solutions. More...

Public Member Functions
NXOpen::Preferences::RoutingPart::DetailLevel	BomDetailLevelFlag ()
	Returns the detail level for the Routing bill of material.

NXString	BomFormatPart ()
	Returns the name of the template Routing bill of material part file.

NXString	DefaultElbowNode ()
	Returns the node in the part library to use for searching for the default elbow to place during create path.

NXOpen::Preferences::RoutingPart::FabricationNumbering	FabricationNumberingFlag ()
	Returns the fabrication numbering for the Routing bill of material.

void	GetPreferredPortAttribute (NXString attributeName, NXString attributeValue)
	Gets the attribute and it's value for determining the preferred port for method type NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute Created in NX4.0.0.

NXString	GetPreferredPortName ()
	Gets the desired port name for method type NXOpen::Preferences::RoutingPart::PreferredPortMethodName.

NXString	InvalidSequenceCharacters ()
	Returns the list of characters that cannot be used when generating sequences of terminals in qualify part.

int	Layer ()
	Returns the layer to apply to new components.

int	MaximumSolutions ()
	Returns the maximum number of placement solutions to generate when determining placement solutions for a component.

NXOpen::Preferences::RoutingPartLibrary *	PartLibrary ()
	The Routing part library.

NXOpen::Preferences::RoutingPart::PreferredPortMethod	PreferredPortMethodFlag ()
	Returns the current method for determining the preferred placement port.

void	SetBomDetailLevelFlag (NXOpen::Preferences::RoutingPart::DetailLevel detail)
	Sets the detail level for the Routing bill of material.

void	SetBomFormatPart (const NXString &bomPart)
	Sets the name of the template Routing bill of material part file.

void	SetBomFormatPart (const char *bomPart)
	Sets the name of the template Routing bill of material part file.

void	SetDefaultElbowNode (const NXString &elbowNode)
	Sets the node in the part library to use for searching for the default elbow to place during create path.

void	SetDefaultElbowNode (const char *elbowNode)
	Sets the node in the part library to use for searching for the default elbow to place during create path.

void	SetFabricationNumberingFlag (NXOpen::Preferences::RoutingPart::FabricationNumbering numbering)
	Sets the fabrication numbering for the Routing bill of material.

void	SetInvalidSequenceCharacters (const NXString &invalidChars)
	Sets the list of characters that cannot be used when generating sequences of terminals in qualify part.

void	SetInvalidSequenceCharacters (const char *invalidChars)
	Sets the list of characters that cannot be used when generating sequences of terminals in qualify part.

void	SetLayer (int layer)
	Sets the layer to apply to new components.

void	SetMaximumSolutions (int maxSols)
	Sets the maximum number of placement solutions to generate when determining placement solutions for a component.

void	SetPreferredPortAttribute (const NXString &attributeName, const NXString &attributeValue)
	Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute and sets the desired port attribute and it's value.

void	SetPreferredPortAttribute (const char attributeName, const char attributeValue)
	Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute and sets the desired port attribute and it's value.

void	SetPreferredPortName (const NXString &desiredPort)
	Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodName and sets the desired port name.

void	SetPreferredPortName (const char *desiredPort)
	Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodName and sets the desired port name.

void	SetStockLengthDisplayFlag (NXOpen::Preferences::RoutingPart::StockLengthDisplay display)
	Sets the stock length display for the Routing bill of material.

void	SetUsePreferredPortFlag (NXOpen::Preferences::RoutingPart::UsePreferredPort useFlag)
	Sets whether or not to use the preffered placement port during calcluation of placement solutions during place part.

NXOpen::Preferences::RoutingPart::StockLengthDisplay	StockLengthDisplayFlag ()
	Returns the stock length display for the Routing bill of material.

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

NXOpen::Preferences::RoutingPart::UsePreferredPort	UsePreferredPortFlag ()
	Returns whether or not to use the preffered placement port during calcluation of placement solutions during place part.

Detailed Description

Contains the preferences related to placing/finding/adding parts and generating the Routing bill of materials.

To obtain an instance of this class, refer to Preferences::RoutingApplicationView

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::Preferences::RoutingPart::DetailLevel

The detail levels available for the Routing bill of material.

Enumerator:

DetailLevelSummary	summary
DetailLevelItemized	itemized

enum NXOpen::Preferences::RoutingPart::FabricationNumbering

The fabrication numbering methods available for the Routing bill of material.

Enumerator:

FabricationNumberingSequence	Sequential numbering of fabrications in the parts list.
FabricationNumberingOriginal	Use the fabrication number in the parts list.

enum NXOpen::Preferences::RoutingPart::PreferredPortMethod

Available methods for determining which port is the preferredport during calculation of placement solutions.

Enumerator:

PreferredPortMethodAttribute	Examine an attribute applied to the port, and match it's value to a desired value.
PreferredPortMethodName	Compare the ports name with a desired value.

enum NXOpen::Preferences::RoutingPart::StockLengthDisplay

The stock length display options available for the Routing bill of material.

Enumerator:

StockLengthDisplaySum	Display single sum for each type of stock.
StockLengthDisplayItem	Display length of each stock individually.

enum NXOpen::Preferences::RoutingPart::UsePreferredPort

Whether or not use the preferred port when determining placement solutions.

Enumerator:

UsePreferredPortFalse	false
UsePreferredPortTrue	true

Member Function Documentation

NXOpen::Preferences::RoutingPart::DetailLevel NXOpen::Preferences::RoutingPart::BomDetailLevelFlag ( )

Returns the detail level for the Routing bill of material.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXString NXOpen::Preferences::RoutingPart::BomFormatPart ( )

Returns the name of the template Routing bill of material part file.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXString NXOpen::Preferences::RoutingPart::DefaultElbowNode ( )

Returns the node in the part library to use for searching for the default elbow to place during create path.

The part library node must have a type of NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable . A NULL node indicates no default elbow part table.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Preferences::RoutingPart::FabricationNumbering NXOpen::Preferences::RoutingPart::FabricationNumberingFlag ( )

Returns the fabrication numbering for the Routing bill of material.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Preferences::RoutingPart::GetPreferredPortAttribute	(	NXString *	attributeName,
		NXString *	attributeValue
	)

Gets the attribute and it's value for determining the preferred port for method type NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

attributeName	NULL if method is not NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute
attributeValue	NULL if method is not NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute

NXString NXOpen::Preferences::RoutingPart::GetPreferredPortName ( )

Gets the desired port name for method type NXOpen::Preferences::RoutingPart::PreferredPortMethodName.

Returns: NULL if method is not NXOpen::Preferences::RoutingPart::PreferredPortMethodName
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXString NXOpen::Preferences::RoutingPart::InvalidSequenceCharacters ( )

Returns the list of characters that cannot be used when generating sequences of terminals in qualify part.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

int NXOpen::Preferences::RoutingPart::Layer ( )

Returns the layer to apply to new components.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

int NXOpen::Preferences::RoutingPart::MaximumSolutions ( )

Returns the maximum number of placement solutions to generate when determining placement solutions for a component.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Preferences::RoutingPartLibrary* NXOpen::Preferences::RoutingPart::PartLibrary ( )

The Routing part library.

Created in NX3.0.0.

NXOpen::Preferences::RoutingPart::PreferredPortMethod NXOpen::Preferences::RoutingPart::PreferredPortMethodFlag ( )

Returns the current method for determining the preferred placement port.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Preferences::RoutingPart::SetBomDetailLevelFlag ( NXOpen::Preferences::RoutingPart::DetailLevel detail )

Sets the detail level for the Routing bill of material.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

detail detail

void NXOpen::Preferences::RoutingPart::SetBomFormatPart ( const NXString & bomPart )

Sets the name of the template Routing bill of material part file.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

bomPart bom part

void NXOpen::Preferences::RoutingPart::SetBomFormatPart ( const char * bomPart )

Sets the name of the template Routing bill of material part file.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

bomPart bom part

void NXOpen::Preferences::RoutingPart::SetDefaultElbowNode ( const NXString & elbowNode )

Sets the node in the part library to use for searching for the default elbow to place during create path.

The part library node must have a type of NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable . A NULL node indicates no default elbow part table.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

elbowNode elbow node

void NXOpen::Preferences::RoutingPart::SetDefaultElbowNode ( const char * elbowNode )

Sets the node in the part library to use for searching for the default elbow to place during create path.

The part library node must have a type of NXOpen::Preferences::RoutingPartLibrary::NodeTypeTable . A NULL node indicates no default elbow part table.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

elbowNode elbow node

void NXOpen::Preferences::RoutingPart::SetFabricationNumberingFlag ( NXOpen::Preferences::RoutingPart::FabricationNumbering numbering )

Sets the fabrication numbering for the Routing bill of material.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

numbering numbering

void NXOpen::Preferences::RoutingPart::SetInvalidSequenceCharacters ( const NXString & invalidChars )

Sets the list of characters that cannot be used when generating sequences of terminals in qualify part.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

invalidChars invalid chars

void NXOpen::Preferences::RoutingPart::SetInvalidSequenceCharacters ( const char * invalidChars )

Sets the list of characters that cannot be used when generating sequences of terminals in qualify part.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

invalidChars invalid chars

void NXOpen::Preferences::RoutingPart::SetLayer ( int layer )

Sets the layer to apply to new components.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

layer layer

void NXOpen::Preferences::RoutingPart::SetMaximumSolutions ( int maxSols )

Sets the maximum number of placement solutions to generate when determining placement solutions for a component.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

maxSols max sols

void NXOpen::Preferences::RoutingPart::SetPreferredPortAttribute	(	const NXString &	attributeName,
		const NXString &	attributeValue
	)

Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute and sets the desired port attribute and it's value.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

attributeName	Attribute name on port to match. Must not be NULL and the length of the string must be less than 50. NOTE: The full Unicode character set is not supported for this parameter.
attributeValue	Value of the attribute to match. NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingPart::SetPreferredPortAttribute	(	const char *	attributeName,
		const char *	attributeValue
	)

Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodAttribute and sets the desired port attribute and it's value.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

attributeName	Attribute name on port to match. Must not be NULL and the length of the string must be less than 50. NOTE: The full Unicode character set is not supported for this parameter.
attributeValue	Value of the attribute to match. NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingPart::SetPreferredPortName ( const NXString & desiredPort )

Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodName and sets the desired port name.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

desiredPort Port name to match. Must not be NULL and the length of the string must be less than 50.
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingPart::SetPreferredPortName ( const char * desiredPort )

Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodName and sets the desired port name.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

desiredPort Port name to match. Must not be NULL and the length of the string must be less than 50.
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Preferences::RoutingPart::SetStockLengthDisplayFlag ( NXOpen::Preferences::RoutingPart::StockLengthDisplay display )

Sets the stock length display for the Routing bill of material.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

display display

void NXOpen::Preferences::RoutingPart::SetUsePreferredPortFlag ( NXOpen::Preferences::RoutingPart::UsePreferredPort useFlag )

Sets whether or not to use the preffered placement port during calcluation of placement solutions during place part.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

useFlag use flag

NXOpen::Preferences::RoutingPart::StockLengthDisplay NXOpen::Preferences::RoutingPart::StockLengthDisplayFlag ( )

Returns the stock length display for the Routing bill of material.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

tag_t NXOpen::Preferences::RoutingPart::Tag ( ) const

Returns the tag of this object.

NXOpen::Preferences::RoutingPart::UsePreferredPort NXOpen::Preferences::RoutingPart::UsePreferredPortFlag ( )

Returns whether or not to use the preffered placement port during calcluation of placement solutions during place part.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

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

Preferences_RoutingPart.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation