RoutingUserPreferences Class

class NXOpen.Preferences.RoutingUserPreferences

Bases: object

Allows access to the User Preferences section of the Routing Application View file.

To obtain an instance of this class, refer to NXOpen.Preferences.RoutingApplicationView

New in version NX11.0.1.

Methods

Method	Description
GetDoubleArrayPreference	Returns the values of the named double array user preference from the Application View file.
GetDoublePreference	Returns the value of the named double user preference from the Application View file.
GetIntegerArrayPreference	Returns the values of the named integer array user preference from the Application View file.
GetIntegerPreference	Returns the value of the named integer user preference from the Application View file.
GetStringArrayPreference	Returns the values of the named string array user preference from the Application View file.
GetStringPreference	Returns the value of the named string user preference from the Application View file.
SetDoubleArrayPreference	Sets the values of the named double array user preference in the current NX session.
SetDoublePreference	Sets the value of the named double user preference in the current NX session.
SetIntegerArrayPreference	Sets the values of the named integer array user preference in the current NX session.
SetIntegerPreference	Sets the value of the named integer user preference in the current NX session.
SetStringArrayPreference	Sets the values of the named string array user preference in the current NX session.
SetStringPreference	Sets the value of the named string user preference in the current NX session.

Method Detail

GetDoubleArrayPreference

RoutingUserPreferences.GetDoubleArrayPreference

Returns the values of the named double array user preference from the Application View file.

Signature GetDoubleArrayPreference(name)

Parameters:name (str) – The name of the user preference. Returns:a tuple Return type:A tuple consisting of (isFound, values) isFound is a bool. Was the preference found in the Application View file? values is a list of float. The values of the preference, if found.

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

GetDoublePreference

RoutingUserPreferences.GetDoublePreference

Returns the value of the named double user preference from the Application View file.

Signature GetDoublePreference(name)

Parameters:name (str) – The name of the user preference. Returns:a tuple Return type:A tuple consisting of (isFound, value) isFound is a bool. Was the preference found in the Application View file? value is a float. The value of the preference, if found.

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

GetIntegerArrayPreference

RoutingUserPreferences.GetIntegerArrayPreference

Returns the values of the named integer array user preference from the Application View file.

Signature GetIntegerArrayPreference(name)

Parameters:name (str) – The name of the user preference. Returns:a tuple Return type:A tuple consisting of (isFound, values) isFound is a bool. Was the preference found in the Application View file? values is a list of int. The values of the preference, if found.

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

GetIntegerPreference

RoutingUserPreferences.GetIntegerPreference

Returns the value of the named integer user preference from the Application View file.

Signature GetIntegerPreference(name)

Parameters:name (str) – The name of the user preference. Returns:a tuple Return type:A tuple consisting of (isFound, value) isFound is a bool. Was the preference found in the Application View file? value is a int. The value of the preference, if found.

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

GetStringArrayPreference

RoutingUserPreferences.GetStringArrayPreference

Returns the values of the named string array user preference from the Application View file.

Signature GetStringArrayPreference(name)

Parameters:name (str) – The name of the user preference. Returns:a tuple Return type:A tuple consisting of (isFound, values) isFound is a bool. Was the preference found in the Application View file? values is a list of str. The values of the preference, if found.

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

GetStringPreference

RoutingUserPreferences.GetStringPreference

Returns the value of the named string user preference from the Application View file.

Signature GetStringPreference(name)

Parameters:name (str) – The name of the user preference. Returns:a tuple Return type:A tuple consisting of (isFound, value) isFound is a bool. Was the preference found in the Application View file? value is a str. The value of the preference, if found.

New in version NX11.0.1.

License requirements: routing_base (“Routing Basic”)

SetDoubleArrayPreference

RoutingUserPreferences.SetDoubleArrayPreference

Sets the values of the named double array user preference in the current NX session.

Signature SetDoubleArrayPreference(name, values)

Parameters:

• name (str) – The name of the user preference.
• values (list of float) – The values of the preference. Overwrites any existing values.

New in version NX11.0.2.

License requirements: routing_base (“Routing Basic”)

SetDoublePreference

RoutingUserPreferences.SetDoublePreference

Sets the value of the named double user preference in the current NX session.

Signature SetDoublePreference(name, value)

Parameters:

• name (str) – The name of the user preference.
• value (float) – The value of the preference. Overwrites any existing values.

New in version NX11.0.2.

License requirements: routing_base (“Routing Basic”)

SetIntegerArrayPreference

RoutingUserPreferences.SetIntegerArrayPreference

Sets the values of the named integer array user preference in the current NX session.

Signature SetIntegerArrayPreference(name, values)

Parameters:

• name (str) – The name of the user preference.
• values (list of int) – The values of the preference. Overwrites any existing values.

New in version NX11.0.2.

License requirements: routing_base (“Routing Basic”)

SetIntegerPreference

RoutingUserPreferences.SetIntegerPreference

Sets the value of the named integer user preference in the current NX session.

Signature SetIntegerPreference(name, value)

Parameters:

• name (str) – The name of the user preference.
• value (int) – The value of the preference. Overwrites any existing values.

New in version NX11.0.2.

License requirements: routing_base (“Routing Basic”)

SetStringArrayPreference

RoutingUserPreferences.SetStringArrayPreference

Sets the values of the named string array user preference in the current NX session.

Signature SetStringArrayPreference(name, values)

Parameters:

• name (str) – The name of the user preference.
• values (list of str) – The values of the preference. Overwrites any existing values.

New in version NX11.0.2.

License requirements: routing_base (“Routing Basic”)

SetStringPreference

RoutingUserPreferences.SetStringPreference

Sets the value of the named string user preference in the current NX session.

Signature SetStringPreference(name, value)

Parameters:

• name (str) – The name of the user preference.
• value (str) – The value of the preference. Overwrites any existing value.

New in version NX11.0.2.

License requirements: routing_base (“Routing Basic”)