NX Open C++ Reference Guide
Public Member Functions
NXOpen::Options::OptionsManager Class Reference

Manages options. More...

List of all members.

Public Member Functions

std::vector< NXStringGetAllOptions ()
 Gets the names of all available options.
int GetIntValue (const NXString &name)
 Gets the value of an Options::OptionTypeInt option.
int GetIntValue (const NXString &name, NXOpen::Options::LevelType level)
 Gets the value of an Options::OptionTypeInt option at the specified level.
bool GetLogicalValue (const NXString &name)
 Gets the value of a Options::OptionTypeLogical option.
bool GetLogicalValue (const NXString &name, NXOpen::Options::LevelType level)
 Gets the value of a Options::OptionTypeLogical option at the specified level.
NXOpen::Options::OptionType GetOptionType (const NXString &name)
 Returns an option's type.
double GetRealValue (const NXString &name)
 Gets the value of a Options::OptionTypeReal option.
double GetRealValue (const NXString &name, NXOpen::Options::LevelType level)
 Gets the value of a Options::OptionTypeReal option at the specified level.
std::vector< NXStringGetReorderSelectableStringListValue (const NXString &name, std::vector< bool > &selection)
 Gets the value of a Options::OptionTypeReorderSelList option.
std::vector< NXStringGetReorderSelectableStringListValue (const NXString &name, NXOpen::Options::LevelType level, std::vector< bool > &selection)
 Gets the value of a Options::OptionTypeReorderSelList option at the specified level.
std::vector< NXStringGetStringListValue (const NXString &name)
 Gets the value of a Options::OptionTypeStringList option.
std::vector< NXStringGetStringListValue (const NXString &name, NXOpen::Options::LevelType level)
 Gets the value of a Options::OptionTypeStringList option at the specified level.
NXString GetStringValue (const NXString &name)
 Gets the value of a Options::OptionTypeString option.
NXString GetStringValue (const NXString &name, NXOpen::Options::LevelType level)
 Gets the value of a Options::OptionTypeString option at the specified level.
NXString GetUserComment (const NXString &name, NXOpen::Options::LevelType level)
 Returns then user comment at the specified level.
NXString GetUtf8stringValue (const NXString &name)
 Gets the value of a Options::OptionTypeUtf8string option.
NXString GetUtf8stringValue (const NXString &name, NXOpen::Options::LevelType level)
 Gets the value of a Options::OptionTypeUtf8string option at the specified level.
bool IsLevelLockedByDefault (NXOpen::Options::LevelType level)
 Returns true if the option's values at the specified level are locked by default.
bool IsValueLocked (const NXString &name, NXOpen::Options::LevelType level)
 Returns true if the option value is locked at the specified level.
bool IsValueSet (const NXString &name, NXOpen::Options::LevelType level)
 Returns true if the option value exists at the specified level.
NXOpen::Options::ChangeListNewOptionsChangeList (NXOpen::Options::LevelType level, NXOpen::Options::LevelLockedByDefault lockedByDefault)
 Creates an instance of Options::ChangeList class, in order to edit a set of options.
NXOpen::Options::DraftingStandardChangeListNewOptionsDraftingStandardChangeList (NXOpen::Options::LevelType level, const NXString &filename)
 Creates an instance of Options::DraftingStandardChangeList class, in order to edit a set of options.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

Manages options.


OptionsManager methods use an option name as a unique identifier for accessing individual options and throw an error if an option with a given name is not found. All existing option names are listed in the Online Documentation.

If a level parameter is not supplied to a query method then the option value effective in current session is returned. If a level parameter is supplied then then value that is stored at the specified level is returned. This may not be the same as the value effective in the current session and may take effect only after the session is restarted.

To obtain an instance of this class, refer to Session

Created in NX4.0.0.


Member Function Documentation

Gets the names of all available options.

Returns:
List of names of all available options.
Created in NX4.0.0.

License requirements : None

Gets the value of an Options::OptionTypeInt option.

Throws an error if option type is not Options::OptionTypeInt .

Returns:
Option value
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.

Gets the value of an Options::OptionTypeInt option at the specified level.

Throws an error if the option is not of type Options::OptionTypeInt .

Returns:
Option value
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
levelOptions level.

Gets the value of a Options::OptionTypeLogical option.

Throws an error if the option is not of type Options::OptionTypeLogical .

Returns:
Option value.
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.

Gets the value of a Options::OptionTypeLogical option at the specified level.

Throws an error if the option is not of type Options::OptionTypeLogical .

Returns:
Option value
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
levelOptions level.

Returns an option's type.

Returns:
Option type
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name
NOTE: The full Unicode character set is not supported for this parameter.

Gets the value of a Options::OptionTypeReal option.

Throws an error if the option is not of type Options::OptionTypeReal .

Returns:
Option value.
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.

Gets the value of a Options::OptionTypeReal option at the specified level.

Throws an error if the option is not of type Options::OptionTypeReal .

Returns:
Option value
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
levelOptions level.
std::vector<NXString> NXOpen::Options::OptionsManager::GetReorderSelectableStringListValue ( const NXString name,
std::vector< bool > &  selection 
)

Gets the value of a Options::OptionTypeReorderSelList option.

Throws an error if the option is not of type Options::OptionTypeReorderSelList .

Returns:
Option value
Created in NX7.5.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
selectionthe selection bit
std::vector<NXString> NXOpen::Options::OptionsManager::GetReorderSelectableStringListValue ( const NXString name,
NXOpen::Options::LevelType  level,
std::vector< bool > &  selection 
)

Gets the value of a Options::OptionTypeReorderSelList option at the specified level.

Throws an error if the option is not of type Options::OptionTypeReorderSelList .

Returns:
Option value
Created in NX7.5.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
levelOptions level.
selectionthe selection bit

Gets the value of a Options::OptionTypeStringList option.

Throws an error if the option is not of type Options::OptionTypeStringList .

Returns:
Option value.
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.

Gets the value of a Options::OptionTypeStringList option at the specified level.

Throws an error if the option is not of type Options::OptionTypeStringList .

Returns:
Option value
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
levelOptions level.

Gets the value of a Options::OptionTypeString option.

Throws an error if the option is not of type Options::OptionTypeString .

Returns:
Option value.
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.

Gets the value of a Options::OptionTypeString option at the specified level.

Throws an error if the option is not of type Options::OptionTypeString .

Returns:
Option value
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
levelOptions level.

Returns then user comment at the specified level.

User comments are not supported at the Options::LevelTypeShipped level.

Returns:
User comment text.
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name
NOTE: The full Unicode character set is not supported for this parameter.
levelOptions level.

Gets the value of a Options::OptionTypeUtf8string option.

Throws an error if the option is not of type Options::OptionTypeUtf8string .

Returns:
Option utf8 value.
Created in NX6.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.

Gets the value of a Options::OptionTypeUtf8string option at the specified level.

Throws an error if the option is not of type Options::OptionTypeString .

Returns:
Option value
Created in NX6.0.0.

License requirements : None
Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
levelOptions level.

Returns true if the option's values at the specified level are locked by default.

Locked by default means that if an option value does not exist at this level, then it is locked.

Returns:
True if options values are locked by default
Created in NX4.0.0.

License requirements : None
Parameters:
levelOptions level.

Returns true if the option value is locked at the specified level.

Locks are not supported at Options::LevelTypeUser and Options::LevelTypeShipped levels.

Returns:
Lock status
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name
NOTE: The full Unicode character set is not supported for this parameter.
levelOptions level.

Returns true if the option value exists at the specified level.

Always true for the Options::LevelTypeShipped level.

Returns:
True if value is set
Created in NX4.0.0.

License requirements : None
Parameters:
nameOption name
NOTE: The full Unicode character set is not supported for this parameter.
levelOptions level.

Creates an instance of Options::ChangeList class, in order to edit a set of options.

It is not possible to create an instance of Options::ChangeList for Options::LevelTypeShipped level, or for a level that is not defined or is not writeable.

Returns:
An instanse of Options::ChangeList class
Created in NX4.0.0.

License requirements : None
Parameters:
levelOptions level.
lockedByDefaultSpecifies whether Options level is locked by default. Ignored at Options::LevelTypeUser level as locks at Options::LevelTypeUser level are not supported. If specified default lock status is different from the current one, then all exisitng locks are cleared.

Creates an instance of Options::DraftingStandardChangeList class, in order to edit a set of options.

It is not possible to create an instance of Options::DraftingStandardChangeList for Options::LevelTypeShipped level, or for a level that is not defined or is not writeable.

Returns:
An instanse of Options::DraftingStandardChangeList class
Created in NX5.0.0.

License requirements : None
Parameters:
levelOptions level.
filenameSpecifies the filename to save/save as.
NOTE: The full Unicode character set is not supported for this parameter.

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.