NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Preferences::RoutingApplicationView Class Reference

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

List of all members.

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.
NXOpen::Preferences::RoutingCharacteristicsCharacteristicPreferences ()
 Preferences related to option/required characteristics.
NXString CurrentDiscipline ()
 Returns the current discipline.
NXString CurrentSpecification ()
 Returns the current specification for the current discipline.
NXString Description ()
 Returns the application view description.
NXString Filename ()
 Returns the filename of the current application view.
std::vector< NXStringGetDisciplines ()
 Returns all of the disciplines available in the current application view.
std::vector< NXStringGetSpecifications ()
 Returns the specifications available in the current discipline.
void LoadAppView (const NXString &fileName)
 Loads the preferences from an application view file.
NXString Name ()
 Returns the application view name.
NXOpen::Preferences::RoutingPartPartPreferences ()
 Routing preferences related to parts.
NXOpen::Preferences::RoutingElectricalRoutingElectrical ()
 Routing electrical preferences structure
Created in NX3.0.0.
NXOpen::Preferences::RoutingLogicalRoutingLogical ()
 Routing logical preferences
Created in NX3.0.0.
NXOpen::Preferences::RoutingMechanicalRoutingMechanical ()
 Routing mechanical preferences
Created in NX3.0.0.
NXOpen::Preferences::RoutingPathRoutingPath ()
 Path preferences structure
Created in NX3.0.0.
NXOpen::Preferences::RoutingStockRoutingStock ()
 Stock preferences structure
Created in NX3.0.0.
void SetApplicationType (NXOpen::Preferences::RoutingApplicationView::AppType appType)
 Sets the given routing application type.
void SetCurrentDiscipline (const NXString &discipline)
 Sets the current discipline.
void SetCurrentSpecification (const NXString &currentSpec)
 Sets the current specification for the current discipline.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

The RoutingApplicationView class contians 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 Preferences::SessionPreferences

Created in NX4.0.0.


Member Enumeration Documentation

Routing application types.

Enumerator:
AppTypeNone 

Not currently in any of the routing applications.

AppTypeMechanical 

In routing mechanical application.

AppTypeElectrical 

In routing electrical application.

AppTypeLogical 

In routing logical application.


Member Function Documentation

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Preferences related to option/required characteristics.


Created in NX3.0.0.

Returns the current discipline.

A discipline value of "" (the empty string) indicates no current discipline.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the current specification for the current discipline.

A specification value of "" (the empty string) indiciates no current specification.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the application view description.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the filename of the current application view.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the specifications available in the current discipline.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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 Adminstrator 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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
fileNamefilename of application view.
NOTE: The full Unicode character set is not supported for this parameter.

Returns the application view name.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Routing preferences related to parts.


Created in NX3.0.0.

Routing electrical preferences structure
Created in NX3.0.0.


Routing logical preferences
Created in NX3.0.0.


Routing mechanical preferences
Created in NX3.0.0.


Path preferences structure
Created in NX3.0.0.


Stock preferences structure
Created in NX3.0.0.


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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
appTypeapp type

Sets the current discipline.

A discipline value of "" (the empty string) indicates no current discipline.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
disciplinediscipline

Sets the current specification for the current discipline.

A specification value of "" (the empty string) indiciates no current specification.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
currentSpeccurrent spec

Returns the tag of this object.


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