NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Preferences.RoutingApplicationView Class Reference

The RoutingApplicationView class contains all of the various preferences and options available from the Routing Application View file. More...

Inheritance diagram for NXOpen.Preferences.RoutingApplicationView:
NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  AppType { None, Mechanical, Electrical, Logical }
 Routing application types More...
 

Public Member Functions

unsafe string[] GetDisciplines ()
 Returns all of the disciplines available in the current application view. More...
 
unsafe
NXOpen.Routing.CharacteristicList.CharacteristicInformation[] 
GetFabricationCharacteristics ()
 Returns fabrication characteristics. More...
 
unsafe
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...
 
unsafe
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...
 
unsafe string[] GetSpecifications ()
 Returns the specifications available in the current discipline. More...
 
unsafe void LoadAppView (string fileName)
 Loads the preferences from an application view file. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.Preferences.RoutingApplicationView.AppType 
ApplicationType [get, set]
 Returns or sets the given routing application type. More...
 
NXOpen.Preferences.RoutingCharacteristics CharacteristicPreferences [get]
 Preferences related to option/required characteristics. More...
 
unsafe string CurrentDiscipline [get, set]
 Returns or sets the current discipline. More...
 
unsafe string CurrentSpecification [get, set]
 Returns or sets the current specification for the current discipline. More...
 
unsafe string Description [get]
 Returns the application view description. More...
 
unsafe string Filename [get]
 Returns the filename of the current application view. More...
 
unsafe string Name [get]
 Returns the application view name. More...
 
NXOpen.Preferences.RoutingPart PartPreferences [get]
 Routing preferences related to parts. More...
 
NXOpen.Preferences.RoutingElectrical RoutingElectrical [get]
 Routing electrical preferences structure More...
 
NXOpen.Preferences.RoutingLogical RoutingLogical [get]
 Routing logical preferences More...
 
NXOpen.Preferences.RoutingMechanical RoutingMechanical [get]
 Routing mechanical preferences More...
 
NXOpen.Preferences.RoutingPath RoutingPath [get]
 Path preferences structure More...
 
NXOpen.Preferences.RoutingStock RoutingStock [get]
 Stock preferences structure More...
 
NXOpen.Preferences.RoutingUserPreferences RoutingUserPreferences [get]
 Routing user preferences More...
 
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Detailed Description

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

Member Enumeration Documentation

Routing application types

Enumerator
None 

Not currently in any of the routing applications.

Mechanical 

In routing mechanical application.

Electrical 

In routing electrical application.

Logical 

In routing logical application.

Member Function Documentation

unsafe string [] NXOpen.Preferences.RoutingApplicationView.GetDisciplines ( )
inline

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

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.Routing.CharacteristicList.CharacteristicInformation [] NXOpen.Preferences.RoutingApplicationView.GetFabricationCharacteristics ( )
inline

Returns fabrication characteristics.

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

Created in NX9.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.Routing.CharacteristicList.CharacteristicInformation [] NXOpen.Preferences.RoutingApplicationView.GetOptionalCharacteristics ( )
inline

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

Created in NX9.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.Routing.CharacteristicList.CharacteristicInformation [] NXOpen.Preferences.RoutingApplicationView.GetRequiredCharacteristics ( )
inline

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

Created in NX9.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe string [] NXOpen.Preferences.RoutingApplicationView.GetSpecifications ( )
inline

Returns the specifications available in the current discipline.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe void NXOpen.Preferences.RoutingApplicationView.LoadAppView ( string  fileName)
inline

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" );

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters
fileNamefilename of application view.

Property Documentation

unsafe NXOpen.Preferences.RoutingApplicationView.AppType NXOpen.Preferences.RoutingApplicationView.ApplicationType
getset

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 toPreferences.RoutingApplicationView.AppType.None before exiting from the routing applications.

Created in NX5.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

NXOpen.Preferences.RoutingCharacteristics NXOpen.Preferences.RoutingApplicationView.CharacteristicPreferences
get

Preferences related to option/required characteristics.

Created in NX3.0.0

unsafe string NXOpen.Preferences.RoutingApplicationView.CurrentDiscipline
getset

Returns or sets the current discipline.

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

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe string NXOpen.Preferences.RoutingApplicationView.CurrentSpecification
getset

Returns or 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 to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe string NXOpen.Preferences.RoutingApplicationView.Description
get

Returns the application view description.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

unsafe string NXOpen.Preferences.RoutingApplicationView.Filename
get

Returns the filename of the current application view.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

unsafe string NXOpen.Preferences.RoutingApplicationView.Name
get

Returns the application view name.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

NXOpen.Preferences.RoutingPart NXOpen.Preferences.RoutingApplicationView.PartPreferences
get

Routing preferences related to parts.

Created in NX3.0.0

NXOpen.Preferences.RoutingElectrical NXOpen.Preferences.RoutingApplicationView.RoutingElectrical
get

Routing electrical preferences structure

Created in NX3.0.0

NXOpen.Preferences.RoutingLogical NXOpen.Preferences.RoutingApplicationView.RoutingLogical
get

Routing logical preferences

Created in NX3.0.0

NXOpen.Preferences.RoutingMechanical NXOpen.Preferences.RoutingApplicationView.RoutingMechanical
get

Routing mechanical preferences

Created in NX3.0.0

NXOpen.Preferences.RoutingPath NXOpen.Preferences.RoutingApplicationView.RoutingPath
get

Path preferences structure

Created in NX3.0.0

NXOpen.Preferences.RoutingStock NXOpen.Preferences.RoutingApplicationView.RoutingStock
get

Stock preferences structure

Created in NX3.0.0

NXOpen.Preferences.RoutingUserPreferences NXOpen.Preferences.RoutingApplicationView.RoutingUserPreferences
get

Routing user preferences

Created in NX11.0.1

Tag NXOpen.Preferences.RoutingApplicationView.Tag
get

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.