NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Options::DraftingStandardChangeList Class Reference

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

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

Public Member Functions

NXOpen::Options::LevelType CurrentLevel ()
 Returns the current level of options
Created in NX5.0.0. More...
 
void Load ()
 Load the drafting standard defaults at the current level. More...
 
void LockValue (const NXString &name)
 Lock option value. More...
 
void LockValue (const char *name)
 Lock option value. More...
 
void Save ()
 Saves the drafting standard defaults at the current level. More...
 
void SetUserComment (const NXString &name, const NXString &comment)
 Sets the user comment. More...
 
void SetUserComment (const char *name, const char *comment)
 Sets the user comment. More...
 
void SetUtf8Value (const NXString &name, const NXString &value)
 Sets the value of a Options::OptionTypeUtf8string option. More...
 
void SetUtf8Value (const char *name, const char *value)
 Sets the value of a Options::OptionTypeUtf8string option. More...
 
void SetValue (const NXString &name, int value)
 Sets the value of an Options::OptionTypeInt option. More...
 
void SetValue (const char *name, int value)
 Sets the value of an Options::OptionTypeInt option. More...
 
void SetValue (const NXString &name, double value)
 Sets the value of a Options::OptionTypeReal option. More...
 
void SetValue (const char *name, double value)
 Sets the value of a Options::OptionTypeReal option. More...
 
void SetValue (const NXString &name, const NXString &value)
 Sets the value of a Options::OptionTypeString option. More...
 
void SetValue (const char *name, const char *value)
 Sets the value of a Options::OptionTypeString option. More...
 
void SetValue (const NXString &name, std::vector< NXString > &value)
 Sets the value of a Options::OptionTypeStringList option. More...
 
void SetValue (const char *name, std::vector< NXString > &value)
 Sets the value of a Options::OptionTypeStringList option. More...
 
void SetValue (const NXString &name, bool value)
 Sets the value of a Options::OptionTypeLogical option. More...
 
void SetValue (const char *name, bool value)
 Sets the value of a Options::OptionTypeLogical option. More...
 
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. More...
 
void SetValueOrder (const char *name, std::vector< NXString > &value)
 Sets the value of a Options::OptionTypeReorderSelList option for which the list entries can be reordered. More...
 
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. More...
 
void SetValueSelection (const char *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. More...
 
void UnlockValue (const NXString &name)
 Unlock option value. More...
 
void UnlockValue (const char *name)
 Unlock option value. More...
 
virtual ~DraftingStandardChangeList ()
 Dispose the changes
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

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

virtual NXOpen::Options::DraftingStandardChangeList::~DraftingStandardChangeList ( )
virtual

Dispose the changes
Created in NX5.0.0.



License requirements : None

Member Function Documentation

NXOpen::Options::LevelType NXOpen::Options::DraftingStandardChangeList::CurrentLevel ( )

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



License requirements : None

void NXOpen::Options::DraftingStandardChangeList::Load ( )

Load the drafting standard defaults at the current level.


Created in NX5.0.0.

License requirements : None

void NXOpen::Options::DraftingStandardChangeList::LockValue ( const NXString name)

Lock option value.


Created in NX5.0.0.

License requirements : None

Parameters
nameOption name
void NXOpen::Options::DraftingStandardChangeList::LockValue ( const char *  name)

Lock option value.


Created in NX5.0.0.

License requirements : None

Parameters
nameOption name
void NXOpen::Options::DraftingStandardChangeList::Save ( )

Saves the drafting standard defaults at the current level.


Created in NX5.0.0.

License requirements : None

void NXOpen::Options::DraftingStandardChangeList::SetUserComment ( const NXString name,
const NXString comment 
)

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.
commentUser comment text.
void NXOpen::Options::DraftingStandardChangeList::SetUserComment ( const char *  name,
const char *  comment 
)

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.
commentUser comment text.
void NXOpen::Options::DraftingStandardChangeList::SetUtf8Value ( const NXString name,
const NXString value 
)

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.
valueOption value
void NXOpen::Options::DraftingStandardChangeList::SetUtf8Value ( const char *  name,
const char *  value 
)

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.
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.
valueOption value.
void NXOpen::Options::DraftingStandardChangeList::SetValue ( const char *  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.
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.
valueOption value.
void NXOpen::Options::DraftingStandardChangeList::SetValue ( const char *  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.
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.
valueOption value
void NXOpen::Options::DraftingStandardChangeList::SetValue ( const char *  name,
const char *  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.
valueOption value
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.
valuevalue
void NXOpen::Options::DraftingStandardChangeList::SetValue ( const char *  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.
valuevalue
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.
valueOption value
void NXOpen::Options::DraftingStandardChangeList::SetValue ( const char *  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.
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.
valuevalue
void NXOpen::Options::DraftingStandardChangeList::SetValueOrder ( const char *  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.
valuevalue
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.
selectionthe selection bit
valuevalue
void NXOpen::Options::DraftingStandardChangeList::SetValueSelection ( const char *  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.
selectionthe selection bit
valuevalue
void NXOpen::Options::DraftingStandardChangeList::UnlockValue ( const NXString name)

Unlock option value.


Created in NX5.0.0.

License requirements : None

Parameters
nameOption name
void NXOpen::Options::DraftingStandardChangeList::UnlockValue ( const char *  name)

Unlock option value.


Created in NX5.0.0.

License requirements : None

Parameters
nameOption name

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