NX Open C++ Reference Guide
|
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. More... | |
NXString | BomFormatPart () |
Returns the name of the template Routing bill of material part file. More... | |
NXString | DefaultElbowNode () |
Returns the node in the part library to use for searching for the default elbow to place during create path. More... | |
NXOpen::Preferences::RoutingPart::FabricationNumbering | FabricationNumberingFlag () |
Returns the fabrication numbering for the Routing bill of material. More... | |
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. More... | |
NXString | GetPreferredPortName () |
Gets the desired port name for method type NXOpen::Preferences::RoutingPart::PreferredPortMethodName. More... | |
NXString | InvalidSequenceCharacters () |
Returns the list of characters that cannot be used when generating sequences of terminals in qualify part. More... | |
int | Layer () |
Returns the layer to apply to new components. More... | |
int | MaximumSolutions () |
Returns the maximum number of placement solutions to generate when determining placement solutions for a component. More... | |
NXOpen::Preferences::RoutingPartLibrary * | PartLibrary () |
The Routing part library. More... | |
NXOpen::Preferences::RoutingPart::PreferredPortMethod | PreferredPortMethodFlag () |
Returns the current method for determining the preferred placement port. More... | |
void | SetBomDetailLevelFlag (NXOpen::Preferences::RoutingPart::DetailLevel detail) |
Sets the detail level for the Routing bill of material. More... | |
void | SetBomFormatPart (const NXString &bomPart) |
Sets the name of the template Routing bill of material part file. More... | |
void | SetBomFormatPart (const char *bomPart) |
Sets the name of the template Routing bill of material part file. More... | |
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. More... | |
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. More... | |
void | SetFabricationNumberingFlag (NXOpen::Preferences::RoutingPart::FabricationNumbering numbering) |
Sets the fabrication numbering for the Routing bill of material. More... | |
void | SetInvalidSequenceCharacters (const NXString &invalidChars) |
Sets the list of characters that cannot be used when generating sequences of terminals in qualify part. More... | |
void | SetInvalidSequenceCharacters (const char *invalidChars) |
Sets the list of characters that cannot be used when generating sequences of terminals in qualify part. More... | |
void | SetLayer (int layer) |
Sets the layer to apply to new components. More... | |
void | SetMaximumSolutions (int maxSols) |
Sets the maximum number of placement solutions to generate when determining placement solutions for a component. More... | |
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. More... | |
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. More... | |
void | SetPreferredPortName (const NXString &desiredPort) |
Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodName and sets the desired port name. More... | |
void | SetPreferredPortName (const char *desiredPort) |
Sets the method for determining the preferred port to NXOpen::Preferences::RoutingPart::PreferredPortMethodName and sets the desired port name. More... | |
void | SetStockLengthDisplayFlag (NXOpen::Preferences::RoutingPart::StockLengthDisplay display) |
Sets the stock length display for the Routing bill of material. More... | |
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. More... | |
NXOpen::Preferences::RoutingPart::StockLengthDisplay | StockLengthDisplayFlag () |
Returns the stock length display for the Routing bill of material. More... | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
NXOpen::Preferences::RoutingPart::UsePreferredPort | UsePreferredPortFlag () |
Returns whether or not to use the preffered placement port during calcluation of placement solutions during place part. More... | |
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 NXOpen::Preferences::RoutingApplicationView
Created in NX4.0.0.
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")
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.
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")
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")
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")
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")
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")
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")
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")
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")
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")
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")
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")
attributeName | Attribute name on port to match. Must not be NULL and the length of the string must be less than 50. |
attributeValue | Value of the attribute to match. |
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")
attributeName | Attribute name on port to match. Must not be NULL and the length of the string must be less than 50. |
attributeValue | Value of the attribute to match. |
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")
desiredPort | Port name to match. Must not be NULL and the length of the string must be less than 50. |
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")
desiredPort | Port name to match. Must not be NULL and the length of the string must be less than 50. |
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")
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")
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")