RoutingApplicationView Class

class NXOpen.Preferences.RoutingApplicationView

Bases: object

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

New in version NX4.0.0.

Properties

Property	Description
ApplicationType	Returns or sets the given routing application type.
CurrentDiscipline	Returns or sets the current discipline.
CurrentSpecification	Returns or sets the current specification for the current discipline.
Description	Returns the application view description.
Filename	Returns the filename of the current application view.
Name	Returns the application view name.
PartPreferences	Routing preferences related to parts.
CharacteristicPreferences	Preferences related to option/required characteristics.
RoutingStock	Stock preferences structure
RoutingPath	Path preferences structure
RoutingMechanical	Routing mechanical preferences
RoutingLogical	Routing logical preferences
RoutingElectrical	Routing electrical preferences structure
RoutingUserPreferences	Routing user preferences

Methods

Method	Description
GetDisciplines	Returns all of the disciplines available in the current application view.
GetFabricationCharacteristics	Returns fabrication characteristics.
GetOptionalCharacteristics	Returns the intersection of the optional stock characteristics and optional part characteristics for the current discipline of the application view.
GetRequiredCharacteristics	Returns the intersection of the required stock characteristics and required part characteristics for the current discipline of the application view.
GetSpecifications	Returns the specifications available in the current discipline.
LoadAppView	Loads the preferences from an application view file.

Enumerations

RoutingApplicationViewAppType Enumeration

Routing application types

Property Detail

ApplicationType

RoutingApplicationView.ApplicationType

Returns or sets the given routing application type.

This is only used in the context of routing to execute design rules. Application type should be set to:py:class:Preferences.RoutingApplicationViewAppType.None <Preferences.RoutingApplicationViewAppType> before exiting from the routing applications.

-------------------------------------

Getter Method

Signature ApplicationType

Returns: Return type:NXOpen.Preferences.RoutingApplicationViewAppType

New in version NX5.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature ApplicationType

Parameters:appType (NXOpen.Preferences.RoutingApplicationViewAppType) –

New in version NX5.0.0.

License requirements: routing_base (“Routing Basic”)

CurrentDiscipline

RoutingApplicationView.CurrentDiscipline

Returns or sets the current discipline.

A discipline value of “” (the empty string) indicates no current discipline.

-------------------------------------

Getter Method

Signature CurrentDiscipline

Returns: Return type:str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature CurrentDiscipline

Parameters:discipline (str) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

CurrentSpecification

RoutingApplicationView.CurrentSpecification

Returns or sets the current specification for the current discipline.

A specification value of “” (the empty string) indicates no current specification.

-------------------------------------

Getter Method

Signature CurrentSpecification

Returns: Return type:str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature CurrentSpecification

Parameters:currentSpec (str) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

Description

RoutingApplicationView.Description

Returns the application view description.

-------------------------------------

Getter Method

Signature Description

Returns: Return type:str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

Filename

RoutingApplicationView.Filename

Returns the filename of the current application view.

-------------------------------------

Getter Method

Signature Filename

Returns: Return type:str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

Name

RoutingApplicationView.Name

Returns the application view name.

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

PartPreferences

RoutingApplicationView.PartPreferences

Routing preferences related to parts.

Signature PartPreferences

New in version NX3.0.0.

Returns: Return type:NXOpen.Preferences.RoutingPart

CharacteristicPreferences

RoutingApplicationView.CharacteristicPreferences

Preferences related to option/required characteristics.

Signature CharacteristicPreferences

New in version NX3.0.0.

Returns: Return type:NXOpen.Preferences.RoutingCharacteristics

RoutingStock

RoutingApplicationView.RoutingStock

Stock preferences structure

Signature RoutingStock

New in version NX3.0.0.

Returns: Return type:NXOpen.Preferences.RoutingStock

RoutingPath

RoutingApplicationView.RoutingPath

Path preferences structure

Signature RoutingPath

New in version NX3.0.0.

Returns: Return type:NXOpen.Preferences.RoutingPath

RoutingMechanical

RoutingApplicationView.RoutingMechanical

Routing mechanical preferences

Signature RoutingMechanical

New in version NX3.0.0.

Returns: Return type:NXOpen.Preferences.RoutingMechanical

RoutingLogical

RoutingApplicationView.RoutingLogical

Routing logical preferences

Signature RoutingLogical

New in version NX3.0.0.

Returns: Return type:NXOpen.Preferences.RoutingLogical

RoutingElectrical

RoutingApplicationView.RoutingElectrical

Routing electrical preferences structure

Signature RoutingElectrical

New in version NX3.0.0.

Returns: Return type:NXOpen.Preferences.RoutingElectrical

RoutingUserPreferences

RoutingApplicationView.RoutingUserPreferences

Routing user preferences

Signature RoutingUserPreferences

New in version NX11.0.1.

Returns: Return type:NXOpen.Preferences.RoutingUserPreferences

Method Detail

GetDisciplines

RoutingApplicationView.GetDisciplines

Returns all of the disciplines available in the current application view.

Signature GetDisciplines()

Returns: Return type:list of str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

GetFabricationCharacteristics

RoutingApplicationView.GetFabricationCharacteristics

Returns fabrication characteristics.

These characteristics must be set for any fabrication created out of a Routing assembly.

Signature GetFabricationCharacteristics()

Returns: Return type:list of NXOpen.Routing.CharacteristicListCharacteristicInformation_Struct

New in version NX9.0.0.

License requirements: routing_base (“Routing Basic”)

GetOptionalCharacteristics

RoutingApplicationView.GetOptionalCharacteristics

Returns the intersection of the optional stock characteristics and optional part characteristics for the current discipline of the application view.

Signature GetOptionalCharacteristics()

Returns: Return type:list of NXOpen.Routing.CharacteristicListCharacteristicInformation_Struct

New in version NX9.0.0.

License requirements: routing_base (“Routing Basic”)

GetRequiredCharacteristics

RoutingApplicationView.GetRequiredCharacteristics

Returns the intersection of the required stock characteristics and required part characteristics for the current discipline of the application view.

Signature GetRequiredCharacteristics()

Returns: Return type:list of NXOpen.Routing.CharacteristicListCharacteristicInformation_Struct

New in version NX9.0.0.

License requirements: routing_base (“Routing Basic”)

GetSpecifications

RoutingApplicationView.GetSpecifications

Returns the specifications available in the current discipline.

Signature GetSpecifications()

Returns: Return type:list of str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

LoadAppView

RoutingApplicationView.LoadAppView

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.

Session.GetSession().Preferences.RoutingApplicationView.LoadAppView ( “ugroute_mech_in.xml” );

Session.GetSession().Preferences.RoutingApplicationView.LoadAppView ( “ugroute_elec_in.xml” );

Session.GetSession().Preferences.RoutingApplicationView.LoadAppView ( “ugroute_mech_in.xml” );

Signature LoadAppView(fileName)

Parameters:fileName (str) – filename of application view.

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)