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

Records changes to option values at the specified level. More...

Inheritance diagram for NXOpen::Options::DraftingStandardChangeList:
NXOpen::TransientObject

List of all members.

Public Member Functions

NXOpen::Options::LevelType CurrentLevel ()
 Returns the current level of options
Created in NX5.0.0.
void Load ()
 Load the drafting standard defaults at the current level.
void LockValue (const NXString &name)
 Lock option value.
void Save ()
 Saves the drafting standard defaults at the current level.
void SetUserComment (const NXString &name, const NXString &comment)
 Sets the user comment.
void SetUtf8Value (const NXString &name, const NXString &value)
 Sets the value of a Options::OptionTypeUtf8string option.
void SetValue (const NXString &name, int value)
 Sets the value of an Options::OptionTypeInt option.
void SetValue (const NXString &name, double value)
 Sets the value of a Options::OptionTypeReal option.
void SetValue (const NXString &name, const NXString &value)
 Sets the value of a Options::OptionTypeString option.
void SetValue (const NXString &name, std::vector< NXString > &value)
 Sets the value of a Options::OptionTypeStringList option.
void SetValue (const NXString &name, bool value)
 Sets the value of a Options::OptionTypeLogical option.
void SetValueOrder (const NXString &name, std::vector< NXString > &value)
 Sets the value of a Options::OptionTypeReorderSelList option for which the list entries can be reordered.
void SetValueSelection (const NXString &name, const std::vector< bool > &selection, std::vector< NXString > &value)
 Sets the value of a Options::OptionTypeReorderSelList option for which the list entries can be reordered as well as selected.
void UnlockValue (const NXString &name)
 Unlock option value.
virtual ~DraftingStandardChangeList ()
 Dispose the changes
Created in NX5.0.0.

Detailed Description

Records changes to option values at the specified level.


A DraftingStandardChangeList is created with a given level, and all of the edit operations apply to that level for drafting standard defaults. Each method for setting a value throws an error if the option value is locked at a higher level, or the specified value is not valid.

All methods in this class use an option name as a unique identifier for accessing individual options and throw an error if an option with the given name is not found. All existing option names and their allowed values are described in the Online Documentation.

Use Options::OptionsManager::NewOptionsDraftingStandardChangeList to create a new instance of this class

Created in NX5.0.0.


Constructor & Destructor Documentation

Dispose the changes
Created in NX5.0.0.



License requirements : None


Member Function Documentation

Returns the current level of options
Created in NX5.0.0.



License requirements : None

Load the drafting standard defaults at the current level.


Created in NX5.0.0.

License requirements : None

Lock option value.


Created in NX5.0.0.

License requirements : None

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

Saves the drafting standard defaults at the current level.


Created in NX5.0.0.

License requirements : None

Sets the user comment.

Throws an error if the value does not exist at this level.
Created in NX5.0.0.

License requirements : None

Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
commentUser comment text.

Sets the value of a Options::OptionTypeUtf8string option.

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


Created in NX6.0.0.

License requirements : None

Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
valueOption value
void NXOpen::Options::DraftingStandardChangeList::SetValue ( const NXString name,
int  value 
)

Sets the value of an Options::OptionTypeInt option.

If the option is of type Options::OptionTypeReal then the value parameter is converted to double. Throws an error if the option type is not Options::OptionTypeInt or Options::OptionTypeReal .
Created in NX5.0.0.

License requirements : None

Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
valueOption value.
void NXOpen::Options::DraftingStandardChangeList::SetValue ( const NXString name,
double  value 
)

Sets the value of a Options::OptionTypeReal option.

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


Created in NX5.0.0.

License requirements : None

Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
valueOption value.
void NXOpen::Options::DraftingStandardChangeList::SetValue ( const NXString name,
const NXString value 
)

Sets the value of a Options::OptionTypeString option.

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


Created in NX5.0.0.

License requirements : None

Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
valueOption value
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Options::DraftingStandardChangeList::SetValue ( const NXString name,
std::vector< NXString > &  value 
)

Sets the value of a Options::OptionTypeStringList option.

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


Created in NX5.0.0.

License requirements : None

Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
value
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Options::DraftingStandardChangeList::SetValue ( const NXString name,
bool  value 
)

Sets the value of a Options::OptionTypeLogical option.

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


Created in NX5.0.0.

License requirements : None

Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
valueOption value
void NXOpen::Options::DraftingStandardChangeList::SetValueOrder ( const NXString name,
std::vector< NXString > &  value 
)

Sets the value of a Options::OptionTypeReorderSelList option for which the list entries can be reordered.

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


Created in NX7.5.0.

License requirements : None

Parameters:
nameOption name.
NOTE: The full Unicode character set is not supported for this parameter.
value
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Options::DraftingStandardChangeList::SetValueSelection ( const NXString name,
const std::vector< bool > &  selection,
std::vector< NXString > &  value 
)

Sets the value of a Options::OptionTypeReorderSelList option for which the list entries can be reordered as well as selected.

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


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
value
NOTE: The full Unicode character set is not supported for this parameter.

Unlock option value.


Created in NX5.0.0.

License requirements : None

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

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