NXOpen::Preferences::RoutingUserPreferences Class Reference

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

Public Member Functions
bool	GetDoubleArrayPreference (const NXString &name, std::vector< double > &values)
	Returns the values of the named double array user preference from the Application View file. More...
bool	GetDoubleArrayPreference (const char *name, std::vector< double > &values)
	Returns the values of the named double array user preference from the Application View file. More...
bool	GetDoublePreference (const NXString &name, double *value)
	Returns the value of the named double user preference from the Application View file. More...
bool	GetDoublePreference (const char *name, double *value)
	Returns the value of the named double user preference from the Application View file. More...
bool	GetIntegerArrayPreference (const NXString &name, std::vector< int > &values)
	Returns the values of the named integer array user preference from the Application View file. More...
bool	GetIntegerArrayPreference (const char *name, std::vector< int > &values)
	Returns the values of the named integer array user preference from the Application View file. More...
bool	GetIntegerPreference (const NXString &name, int *value)
	Returns the value of the named integer user preference from the Application View file. More...
bool	GetIntegerPreference (const char *name, int *value)
	Returns the value of the named integer user preference from the Application View file. More...
bool	GetStringArrayPreference (const NXString &name, std::vector< NXString > &values)
	Returns the values of the named string array user preference from the Application View file. More...
bool	GetStringArrayPreference (const char *name, std::vector< NXString > &values)
	Returns the values of the named string array user preference from the Application View file. More...
bool	GetStringPreference (const NXString &name, NXString *value)
	Returns the value of the named string user preference from the Application View file. More...
bool	GetStringPreference (const char *name, NXString *value)
	Returns the value of the named string user preference from the Application View file. More...
void	SetDoubleArrayPreference (const NXString &name, const std::vector< double > &values)
	Sets the values of the named double array user preference in the current NX session. More...
void	SetDoubleArrayPreference (const char *name, const std::vector< double > &values)
	Sets the values of the named double array user preference in the current NX session. More...
void	SetDoublePreference (const NXString &name, double value)
	Sets the value of the named double user preference in the current NX session. More...
void	SetDoublePreference (const char *name, double value)
	Sets the value of the named double user preference in the current NX session. More...
void	SetIntegerArrayPreference (const NXString &name, const std::vector< int > &values)
	Sets the values of the named integer array user preference in the current NX session. More...
void	SetIntegerArrayPreference (const char *name, const std::vector< int > &values)
	Sets the values of the named integer array user preference in the current NX session. More...
void	SetIntegerPreference (const NXString &name, int value)
	Sets the value of the named integer user preference in the current NX session. More...
void	SetIntegerPreference (const char *name, int value)
	Sets the value of the named integer user preference in the current NX session. More...
void	SetStringArrayPreference (const NXString &name, std::vector< NXString > &values)
	Sets the values of the named string array user preference in the current NX session. More...
void	SetStringArrayPreference (const char *name, std::vector< NXString > &values)
	Sets the values of the named string array user preference in the current NX session. More...
void	SetStringPreference (const NXString &name, const NXString &value)
	Sets the value of the named string user preference in the current NX session. More...
void	SetStringPreference (const char *name, const char *value)
	Sets the value of the named string user preference in the current NX session. More...
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

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

Created in NX11.0.1.

Member Function Documentation

bool NXOpen::Preferences::RoutingUserPreferences::GetDoubleArrayPreference	(	const NXString &	name,
		std::vector< double > &	values
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference, if found.

bool NXOpen::Preferences::RoutingUserPreferences::GetDoubleArrayPreference	(	const char *	name,
		std::vector< double > &	values
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference, if found.

bool NXOpen::Preferences::RoutingUserPreferences::GetDoublePreference	(	const NXString &	name,
		double *	value
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference, if found.

bool NXOpen::Preferences::RoutingUserPreferences::GetDoublePreference	(	const char *	name,
		double *	value
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference, if found.

bool NXOpen::Preferences::RoutingUserPreferences::GetIntegerArrayPreference	(	const NXString &	name,
		std::vector< int > &	values
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference, if found.

bool NXOpen::Preferences::RoutingUserPreferences::GetIntegerArrayPreference	(	const char *	name,
		std::vector< int > &	values
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference, if found.

bool NXOpen::Preferences::RoutingUserPreferences::GetIntegerPreference	(	const NXString &	name,
		int *	value
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference, if found.

bool NXOpen::Preferences::RoutingUserPreferences::GetIntegerPreference	(	const char *	name,
		int *	value
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference, if found.

bool NXOpen::Preferences::RoutingUserPreferences::GetStringArrayPreference	(	const NXString &	name,
		std::vector< NXString > &	values
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference, if found.

bool NXOpen::Preferences::RoutingUserPreferences::GetStringArrayPreference	(	const char *	name,
		std::vector< NXString > &	values
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference, if found.

bool NXOpen::Preferences::RoutingUserPreferences::GetStringPreference	(	const NXString &	name,
		NXString *	value
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference, if found.

bool NXOpen::Preferences::RoutingUserPreferences::GetStringPreference	(	const char *	name,
		NXString *	value
	)

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

Returns

Was the preference found in the Application View file?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference, if found.

void NXOpen::Preferences::RoutingUserPreferences::SetDoubleArrayPreference	(	const NXString &	name,
		const std::vector< double > &	values
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference. Overwrites any existing values.

void NXOpen::Preferences::RoutingUserPreferences::SetDoubleArrayPreference	(	const char *	name,
		const std::vector< double > &	values
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference. Overwrites any existing values.

void NXOpen::Preferences::RoutingUserPreferences::SetDoublePreference	(	const NXString &	name,
		double	value
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference. Overwrites any existing values.

void NXOpen::Preferences::RoutingUserPreferences::SetDoublePreference	(	const char *	name,
		double	value
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference. Overwrites any existing values.

void NXOpen::Preferences::RoutingUserPreferences::SetIntegerArrayPreference	(	const NXString &	name,
		const std::vector< int > &	values
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference. Overwrites any existing values.

void NXOpen::Preferences::RoutingUserPreferences::SetIntegerArrayPreference	(	const char *	name,
		const std::vector< int > &	values
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference. Overwrites any existing values.

void NXOpen::Preferences::RoutingUserPreferences::SetIntegerPreference	(	const NXString &	name,
		int	value
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference. Overwrites any existing values.

void NXOpen::Preferences::RoutingUserPreferences::SetIntegerPreference	(	const char *	name,
		int	value
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference. Overwrites any existing values.

void NXOpen::Preferences::RoutingUserPreferences::SetStringArrayPreference	(	const NXString &	name,
		std::vector< NXString > &	values
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference. Overwrites any existing values.

void NXOpen::Preferences::RoutingUserPreferences::SetStringArrayPreference	(	const char *	name,
		std::vector< NXString > &	values
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
values	The values of the preference. Overwrites any existing values.

void NXOpen::Preferences::RoutingUserPreferences::SetStringPreference	(	const NXString &	name,
		const NXString &	value
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference. Overwrites any existing value.

void NXOpen::Preferences::RoutingUserPreferences::SetStringPreference	(	const char *	name,
		const char *	value
	)

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

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the user preference.
value	The value of the preference. Overwrites any existing value.

tag_t NXOpen::Preferences::RoutingUserPreferences::Tag

(

)

const

Returns the tag of this object.

---

The documentation for this class was generated from the following file:

• Preferences_RoutingUserPreferences.hxx