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

Inheritance diagram for NXOpen::Options::DraftingStandardChangeList:

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	LockValue (const char *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	SetUserComment (const char name, const char comment)
	Sets the user comment.

void	SetUtf8Value (const NXString &name, const NXString &value)
	Sets the value of a Options::OptionTypeUtf8string option.

void	SetUtf8Value (const char name, const char 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 char *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 char *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 char name, const char 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 char *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	SetValue (const char *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	SetValueOrder (const char *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	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.

void	UnlockValue (const NXString &name)
	Unlock option value.

void	UnlockValue (const char *name)
	Unlock option value.

virtual	~DraftingStandardChangeList ()
	Dispose the changes Created in NX5.0.0.

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

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

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

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

Lock option value.

Created in NX5.0.0.

License requirements : None

Parameters

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

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

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

name	Option name. NOTE: The full Unicode character set is not supported for this parameter.
comment	User 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 @link  Options::OptionTypeUtf8string   Options::OptionTypeUtf8string @endlink .

Created in NX6.0.0.

License requirements : None

Parameters

name	Option name. NOTE: The full Unicode character set is not supported for this parameter.
value	Option 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 @link  Options::OptionTypeUtf8string   Options::OptionTypeUtf8string @endlink .

Created in NX6.0.0.

License requirements : None

Parameters

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

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

name	Option name. NOTE: The full Unicode character set is not supported for this parameter.
value	Option 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 @link  Options::OptionTypeReal   Options::OptionTypeReal @endlink .

Created in NX5.0.0.

License requirements : None

Parameters

name	Option name. NOTE: The full Unicode character set is not supported for this parameter.
value	Option 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 @link  Options::OptionTypeReal   Options::OptionTypeReal @endlink .

Created in NX5.0.0.

License requirements : None

Parameters

name	Option name. NOTE: The full Unicode character set is not supported for this parameter.
value	Option 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 @link  Options::OptionTypeString   Options::OptionTypeString @endlink .

Created in NX5.0.0.

License requirements : None

Parameters

name	Option name. NOTE: The full Unicode character set is not supported for this parameter.
value	Option value NOTE: The full Unicode character set is not supported for this parameter.

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 @link  Options::OptionTypeString   Options::OptionTypeString @endlink .

Created in NX5.0.0.

License requirements : None

Parameters

name	Option name. NOTE: The full Unicode character set is not supported for this parameter.
value	Option 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 @link  Options::OptionTypeStringList   Options::OptionTypeStringList @endlink .

Created in NX5.0.0.

License requirements : None

Parameters

name	Option 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 char *	name,
		std::vector< NXString > &	value
	)

Sets the value of a Options::OptionTypeStringList option.

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

Created in NX5.0.0.

License requirements : None

Parameters

name	Option 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 @link  Options::OptionTypeLogical   Options::OptionTypeLogical @endlink .

Created in NX5.0.0.

License requirements : None

Parameters

name	Option name. NOTE: The full Unicode character set is not supported for this parameter.
value	Option 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 @link  Options::OptionTypeLogical   Options::OptionTypeLogical @endlink .

Created in NX5.0.0.

License requirements : None

Parameters

name	Option name. NOTE: The full Unicode character set is not supported for this parameter.
value	Option 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 @link  Options::OptionTypeReorderSelList   Options::OptionTypeReorderSelList @endlink .

Created in NX7.5.0.

License requirements : None

Parameters

name	Option 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::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 @link  Options::OptionTypeReorderSelList   Options::OptionTypeReorderSelList @endlink .

Created in NX7.5.0.

License requirements : None

Parameters

name	Option 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 @link  Options::OptionTypeReorderSelList   Options::OptionTypeReorderSelList @endlink .

Created in NX7.5.0.

License requirements : None

Parameters

name	Option name. NOTE: The full Unicode character set is not supported for this parameter.
selection	the selection bit
value	NOTE: The full Unicode character set is not supported for this parameter.

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 @link  Options::OptionTypeReorderSelList   Options::OptionTypeReorderSelList @endlink .

Created in NX7.5.0.

License requirements : None

Parameters

name	Option name. NOTE: The full Unicode character set is not supported for this parameter.
selection	the selection bit
value	NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Options::DraftingStandardChangeList::UnlockValue ( const NXString & name )

Unlock option value.

Created in NX5.0.0.

License requirements : None

Parameters

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

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

Unlock option value.

Created in NX5.0.0.

License requirements : None

Parameters

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

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

Options_DraftingStandardChangeList.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation