|
NX Open C++ Reference Guide
|
The RoutingApplicationView class contains all of the various preferences and options available from the Routing Application View file. More...
Public Types | |
| enum | AppType { AppTypeNone, AppTypeMechanical, AppTypeElectrical, AppTypeLogical } |
| Routing application types. More... | |
Public Member Functions | |
| NXOpen::Preferences::RoutingApplicationView::AppType | ApplicationType () |
| Returns the given routing application type. More... | |
| NXOpen::Preferences::RoutingCharacteristics * | CharacteristicPreferences () |
| Preferences related to option/required characteristics. More... | |
| NXString | CurrentDiscipline () |
| Returns the current discipline. More... | |
| NXString | CurrentSpecification () |
| Returns the current specification for the current discipline. More... | |
| NXString | Description () |
| Returns the application view description. More... | |
| NXString | Filename () |
| Returns the filename of the current application view. More... | |
| std::vector< NXString > | GetDisciplines () |
| Returns all of the disciplines available in the current application view. More... | |
| std::vector < NXOpen::Routing::CharacteristicList::CharacteristicInformation > | GetFabricationCharacteristics () |
| Returns fabrication characteristics. More... | |
| std::vector < NXOpen::Routing::CharacteristicList::CharacteristicInformation > | GetOptionalCharacteristics () |
| Returns the intersection of the optional stock characteristics and optional part characteristics for the current discipline of the application view. More... | |
| std::vector < NXOpen::Routing::CharacteristicList::CharacteristicInformation > | GetRequiredCharacteristics () |
| Returns the intersection of the required stock characteristics and required part characteristics for the current discipline of the application view. More... | |
| std::vector< NXString > | GetSpecifications () |
| Returns the specifications available in the current discipline. More... | |
| void | LoadAppView (const NXString &fileName) |
| Loads the preferences from an application view file. More... | |
| void | LoadAppView (const char *fileName) |
| Loads the preferences from an application view file. More... | |
| NXString | Name () |
| Returns the application view name. More... | |
| NXOpen::Preferences::RoutingPart * | PartPreferences () |
| Routing preferences related to parts. More... | |
| NXOpen::Preferences::RoutingElectrical * | RoutingElectrical () |
| Routing electrical preferences structure Created in NX3.0.0. More... | |
| NXOpen::Preferences::RoutingLogical * | RoutingLogical () |
| Routing logical preferences Created in NX3.0.0. More... | |
| NXOpen::Preferences::RoutingMechanical * | RoutingMechanical () |
| Routing mechanical preferences Created in NX3.0.0. More... | |
| NXOpen::Preferences::RoutingPath * | RoutingPath () |
| Path preferences structure Created in NX3.0.0. More... | |
| NXOpen::Preferences::RoutingStock * | RoutingStock () |
| Stock preferences structure Created in NX3.0.0. More... | |
| NXOpen::Preferences::RoutingUserPreferences * | RoutingUserPreferences () |
| Routing user preferences Created in NX11.0.1. More... | |
| void | SetApplicationType (NXOpen::Preferences::RoutingApplicationView::AppType appType) |
| Sets the given routing application type. More... | |
| void | SetCurrentDiscipline (const NXString &discipline) |
| Sets the current discipline. More... | |
| void | SetCurrentDiscipline (const char *discipline) |
| Sets the current discipline. More... | |
| void | SetCurrentSpecification (const NXString ¤tSpec) |
| Sets the current specification for the current discipline. More... | |
| void | SetCurrentSpecification (const char *currentSpec) |
| Sets the current specification for the current discipline. More... | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
The RoutingApplicationView class contains all of the various preferences and options available from the Routing Application View file.
In order to call any of the methods of this class (or it's contained objects), first call Preferences::RoutingApplicationView::LoadAppView to load defaults from the application view file.
To obtain an instance of this class, refer to NXOpen::Preferences::SessionPreferences
Created in NX4.0.0.
| NXOpen::Preferences::RoutingApplicationView::AppType NXOpen::Preferences::RoutingApplicationView::ApplicationType | ( | ) |
Returns the given routing application type.
This is only used in the context of routing to execute design rules. Application type should be set toPreferences::RoutingApplicationView::AppTypeNone before exiting from the routing applications.
Created in NX5.0.0.
License requirements : routing_base ("Routing Basic")
| NXOpen::Preferences::RoutingCharacteristics* NXOpen::Preferences::RoutingApplicationView::CharacteristicPreferences | ( | ) |
Preferences related to option/required characteristics.
Created in NX3.0.0.
| NXString NXOpen::Preferences::RoutingApplicationView::CurrentDiscipline | ( | ) |
Returns the current discipline.
A discipline value of "" (the empty string) indicates no current discipline.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
| NXString NXOpen::Preferences::RoutingApplicationView::CurrentSpecification | ( | ) |
Returns the current specification for the current discipline.
A specification value of "" (the empty string) indicates no current specification.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
| NXString NXOpen::Preferences::RoutingApplicationView::Description | ( | ) |
Returns the application view description.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
| NXString NXOpen::Preferences::RoutingApplicationView::Filename | ( | ) |
Returns the filename of the current application view.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
| std::vector<NXString> NXOpen::Preferences::RoutingApplicationView::GetDisciplines | ( | ) |
Returns all of the disciplines available in the current application view.
| std::vector<NXOpen::Routing::CharacteristicList::CharacteristicInformation> NXOpen::Preferences::RoutingApplicationView::GetFabricationCharacteristics | ( | ) |
Returns fabrication characteristics.
These characteristics must be set for any fabrication created out of a Routing assembly.
| std::vector<NXOpen::Routing::CharacteristicList::CharacteristicInformation> NXOpen::Preferences::RoutingApplicationView::GetOptionalCharacteristics | ( | ) |
Returns the intersection of the optional stock characteristics and optional part characteristics for the current discipline of the application view.
| std::vector<NXOpen::Routing::CharacteristicList::CharacteristicInformation> NXOpen::Preferences::RoutingApplicationView::GetRequiredCharacteristics | ( | ) |
Returns the intersection of the required stock characteristics and required part characteristics for the current discipline of the application view.
| std::vector<NXString> NXOpen::Preferences::RoutingApplicationView::GetSpecifications | ( | ) |
Returns the specifications available in the current discipline.
| void NXOpen::Preferences::RoutingApplicationView::LoadAppView | ( | const NXString & | fileName | ) |
Loads the preferences from an application view file.
This file may be either a legacy application view file (with a .apv extension) or a new XML style application view file (with a .xml extension). See the Routing Administrator documentation for the format of these files. Once an application view file is loaded, it cannot be unloaded. After loading the file the first time in a session, subsequent loads do not pick up changes made to the application view file, but it does set the preferences to the cached values loaded from that file. Here is some example code, after the second call to Preferences::RoutingApplicationView::LoadAppView the current defaults are defaults initially read from the mechanical application view.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
| fileName | filename of application view. |
| void NXOpen::Preferences::RoutingApplicationView::LoadAppView | ( | const char * | fileName | ) |
Loads the preferences from an application view file.
This file may be either a legacy application view file (with a .apv extension) or a new XML style application view file (with a .xml extension). See the Routing Administrator documentation for the format of these files. Once an application view file is loaded, it cannot be unloaded. After loading the file the first time in a session, subsequent loads do not pick up changes made to the application view file, but it does set the preferences to the cached values loaded from that file. Here is some example code, after the second call to Preferences::RoutingApplicationView::LoadAppView the current defaults are defaults initially read from the mechanical application view.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
| fileName | filename of application view. |
| NXString NXOpen::Preferences::RoutingApplicationView::Name | ( | ) |
Returns the application view name.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
| NXOpen::Preferences::RoutingPart* NXOpen::Preferences::RoutingApplicationView::PartPreferences | ( | ) |
Routing preferences related to parts.
Created in NX3.0.0.
| NXOpen::Preferences::RoutingElectrical* NXOpen::Preferences::RoutingApplicationView::RoutingElectrical | ( | ) |
Routing electrical preferences structure
Created in NX3.0.0.
| NXOpen::Preferences::RoutingLogical* NXOpen::Preferences::RoutingApplicationView::RoutingLogical | ( | ) |
Routing logical preferences
Created in NX3.0.0.
| NXOpen::Preferences::RoutingMechanical* NXOpen::Preferences::RoutingApplicationView::RoutingMechanical | ( | ) |
Routing mechanical preferences
Created in NX3.0.0.
| NXOpen::Preferences::RoutingPath* NXOpen::Preferences::RoutingApplicationView::RoutingPath | ( | ) |
Path preferences structure
Created in NX3.0.0.
| NXOpen::Preferences::RoutingStock* NXOpen::Preferences::RoutingApplicationView::RoutingStock | ( | ) |
Stock preferences structure
Created in NX3.0.0.
| NXOpen::Preferences::RoutingUserPreferences* NXOpen::Preferences::RoutingApplicationView::RoutingUserPreferences | ( | ) |
Routing user preferences
Created in NX11.0.1.
| void NXOpen::Preferences::RoutingApplicationView::SetApplicationType | ( | NXOpen::Preferences::RoutingApplicationView::AppType | appType | ) |
Sets the given routing application type.
This is only used in the context of routing to execute design rules. Application type should be set toPreferences::RoutingApplicationView::AppTypeNone before exiting from the routing applications.
Created in NX5.0.0.
License requirements : routing_base ("Routing Basic")
| appType | app type |
| void NXOpen::Preferences::RoutingApplicationView::SetCurrentDiscipline | ( | const NXString & | discipline | ) |
Sets the current discipline.
A discipline value of "" (the empty string) indicates no current discipline.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
| discipline | discipline |
| void NXOpen::Preferences::RoutingApplicationView::SetCurrentDiscipline | ( | const char * | discipline | ) |
Sets the current discipline.
A discipline value of "" (the empty string) indicates no current discipline.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
| discipline | discipline |
| void NXOpen::Preferences::RoutingApplicationView::SetCurrentSpecification | ( | const NXString & | currentSpec | ) |
Sets the current specification for the current discipline.
A specification value of "" (the empty string) indicates no current specification.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
| currentSpec | current spec |
| void NXOpen::Preferences::RoutingApplicationView::SetCurrentSpecification | ( | const char * | currentSpec | ) |
Sets the current specification for the current discipline.
A specification value of "" (the empty string) indicates no current specification.
Created in NX4.0.0.
License requirements : routing_base ("Routing Basic")
| currentSpec | current spec |
| tag_t NXOpen::Preferences::RoutingApplicationView::Tag | ( | ) | const |
Returns the tag of this object.