NXOpen::Options::OptionsManager类 参考

#include <Options_OptionsManager.hxx>

Public 成员函数
std::vector< NXString >	GetAllOptions ()
int	GetIntValue (const char *name)
int	GetIntValue (const char *name, NXOpen::Options::LevelType level)
int	GetIntValue (const NXString &name)
int	GetIntValue (const NXString &name, NXOpen::Options::LevelType level)
bool	GetLogicalValue (const char *name)
bool	GetLogicalValue (const char *name, NXOpen::Options::LevelType level)
bool	GetLogicalValue (const NXString &name)
bool	GetLogicalValue (const NXString &name, NXOpen::Options::LevelType level)
NXOpen::Options::OptionType	GetOptionType (const char *name)
NXOpen::Options::OptionType	GetOptionType (const NXString &name)
double	GetRealValue (const char *name)
double	GetRealValue (const char *name, NXOpen::Options::LevelType level)
double	GetRealValue (const NXString &name)
double	GetRealValue (const NXString &name, NXOpen::Options::LevelType level)
std::vector< NXString >	GetReorderSelectableStringListValue (const char *name, NXOpen::Options::LevelType level, std::vector< bool > &selection)
std::vector< NXString >	GetReorderSelectableStringListValue (const char *name, std::vector< bool > &selection)
std::vector< NXString >	GetReorderSelectableStringListValue (const NXString &name, NXOpen::Options::LevelType level, std::vector< bool > &selection)
std::vector< NXString >	GetReorderSelectableStringListValue (const NXString &name, std::vector< bool > &selection)
NXOpen::Options::OptionsScope	GetScope (const char *name)
NXOpen::Options::OptionsScope	GetScope (const NXString &name)
std::vector< NXString >	GetStringListValue (const char *name)
std::vector< NXString >	GetStringListValue (const char *name, NXOpen::Options::LevelType level)
std::vector< NXString >	GetStringListValue (const NXString &name)
std::vector< NXString >	GetStringListValue (const NXString &name, NXOpen::Options::LevelType level)
NXString	GetStringValue (const char *name)
NXString	GetStringValue (const char *name, NXOpen::Options::LevelType level)
NXString	GetStringValue (const NXString &name)
NXString	GetStringValue (const NXString &name, NXOpen::Options::LevelType level)
NXString	GetUserComment (const char *name, NXOpen::Options::LevelType level)
NXString	GetUserComment (const NXString &name, NXOpen::Options::LevelType level)
NXString	GetUtf8stringValue (const char *name)
NXString	GetUtf8stringValue (const char *name, NXOpen::Options::LevelType level)
NXString	GetUtf8stringValue (const NXString &name)
NXString	GetUtf8stringValue (const NXString &name, NXOpen::Options::LevelType level)
bool	IsLevelLockedByDefault (NXOpen::Options::LevelType level)
bool	IsValueLocked (const char *name, NXOpen::Options::LevelType level)
bool	IsValueLocked (const NXString &name, NXOpen::Options::LevelType level)
bool	IsValueSet (const char *name, NXOpen::Options::LevelType level)
bool	IsValueSet (const NXString &name, NXOpen::Options::LevelType level)
NXOpen::Options::ChangeList *	NewOptionsChangeList (NXOpen::Options::LevelType level, NXOpen::Options::LevelLockedByDefault lockedByDefault)
NXOpen::Options::DraftingStandardChangeList *	NewOptionsDraftingStandardChangeList (NXOpen::Options::LevelType level, const char *filename)
NXOpen::Options::DraftingStandardChangeList *	NewOptionsDraftingStandardChangeList (NXOpen::Options::LevelType level, const NXString &filename)
tag_t	Tag () const

详细描述

管理选项。
OptionsManager方法使用选项名作为唯一标识符来访问单个选项，若未找到指定名称的选项则抛出错误。所有现有选项名称请查阅在线文档。

如果查询方法未提供级别参数，则返回当前会话中生效的选项值。如果提供了级别参数，则返回存储在指定级别的值。该值可能与当前会话中生效的值不同，可能需要重启会话后才会生效。

获取此类实例请参考 NXOpen::Session

创建于NX4.0.0版本。

成员函数说明

GetAllOptions()

std::vector< NXString > NXOpen::Options::OptionsManager::GetAllOptions

(

)

获取所有可用选项的名称。

返回

所有可用选项的名称列表。
创建于NX4.0.0。

许可要求：无

GetIntValue() [1/4]

int NXOpen::Options::OptionsManager::GetIntValue

(

const char *

name

)

获取Options::OptionTypeInt 类型选项的值。 若选项类型不是Options::OptionTypeInt 则抛出错误。

返回

选项值
版本：NX4.0.0

许可要求：无

参数

name

选项名称。

GetIntValue() [2/4]

int NXOpen::Options::OptionsManager::GetIntValue	(	const char *	name,
		NXOpen::Options::LevelType	level )

获取指定层级下Options::OptionTypeInt 类型选项的值。 若选项类型不是Options::OptionTypeInt 则抛出错误。

返回

选项值
创建于NX4.0.0。

许可证要求：无

参数

name	选项名称。
level	选项层级。

GetIntValue() [3/4]

int NXOpen::Options::OptionsManager::GetIntValue

(

const NXString &

name

)

获取Options::OptionTypeInt 类型选项的值。 若选项类型不是Options::OptionTypeInt 则抛出错误。

返回

选项值
版本：NX4.0.0

许可要求：无

参数

name

选项名称。

GetIntValue() [4/4]

int NXOpen::Options::OptionsManager::GetIntValue	(	const NXString &	name,
		NXOpen::Options::LevelType	level )

获取指定层级下Options::OptionTypeInt 类型选项的值。 若选项类型不是Options::OptionTypeInt 则抛出错误。

返回

选项值
创建于NX4.0.0。

许可证要求：无

参数

name	选项名称。
level	选项层级。

GetLogicalValue() [1/4]

bool NXOpen::Options::OptionsManager::GetLogicalValue

(

const char *

name

)

获取Options::OptionTypeLogical 类型选项的值。 若选项类型不是Options::OptionTypeLogical 则抛出错误。

返回

选项值。
创建于NX4.0.0。

许可证要求：无

参数

name

选项名称。

GetLogicalValue() [2/4]

bool NXOpen::Options::OptionsManager::GetLogicalValue	(	const char *	name,
		NXOpen::Options::LevelType	level )

获取指定层级下类型为Options::OptionTypeLogical 的选项值。 若选项类型不是Options::OptionTypeLogical 则抛出错误。

返回

选项值
创建于NX4.0.0。

许可要求：无

参数

name	选项名称。
level	选项层级。

GetLogicalValue() [3/4]

bool NXOpen::Options::OptionsManager::GetLogicalValue

(

const NXString &

name

)

获取Options::OptionTypeLogical 类型选项的值。 若选项类型不是Options::OptionTypeLogical 则抛出错误。

返回

选项值。
创建于NX4.0.0。

许可证要求：无

参数

name

选项名称。

GetLogicalValue() [4/4]

bool NXOpen::Options::OptionsManager::GetLogicalValue	(	const NXString &	name,
		NXOpen::Options::LevelType	level )

获取指定层级下类型为Options::OptionTypeLogical 的选项值。 若选项类型不是Options::OptionTypeLogical 则抛出错误。

返回

选项值
创建于NX4.0.0。

许可要求：无

参数

name	选项名称。
level	选项层级。

GetOptionType() [1/2]

NXOpen::Options::OptionType NXOpen::Options::OptionsManager::GetOptionType

(

const char *

name

)

获取选项的类型。

返回

选项类型
创建于NX4.0.0。

许可要求：无

参数

name

选项名称

GetOptionType() [2/2]

NXOpen::Options::OptionType NXOpen::Options::OptionsManager::GetOptionType

(

const NXString &

name

)

获取选项的类型。

返回

选项类型
创建于NX4.0.0。

许可要求：无

参数

name

选项名称

GetRealValue() [1/4]

double NXOpen::Options::OptionsManager::GetRealValue

(

const char *

name

)

获取Options::OptionTypeReal 类型选项的值。 若选项类型不是Options::OptionTypeReal 则抛出错误。

返回

选项值。
版本：NX4.0.0

许可要求：无

参数

name

选项名称。

GetRealValue() [2/4]

double NXOpen::Options::OptionsManager::GetRealValue	(	const char *	name,
		NXOpen::Options::LevelType	level )

获取指定层级下Options::OptionTypeReal 类型选项的值。 若选项类型不是Options::OptionTypeReal 则抛出错误。

返回

选项值
创建于NX4.0.0。

许可证要求：无

参数

name	选项名称。
level	选项层级。

GetRealValue() [3/4]

double NXOpen::Options::OptionsManager::GetRealValue

(

const NXString &

name

)

获取Options::OptionTypeReal 类型选项的值。 若选项类型不是Options::OptionTypeReal 则抛出错误。

返回

选项值。
版本：NX4.0.0

许可要求：无

参数

name

选项名称。

GetRealValue() [4/4]

double NXOpen::Options::OptionsManager::GetRealValue	(	const NXString &	name,
		NXOpen::Options::LevelType	level )

获取指定层级下Options::OptionTypeReal 类型选项的值。 若选项类型不是Options::OptionTypeReal 则抛出错误。

返回

选项值
创建于NX4.0.0。

许可证要求：无

参数

name	选项名称。
level	选项层级。

GetReorderSelectableStringListValue() [1/4]

std::vector< NXString > NXOpen::Options::OptionsManager::GetReorderSelectableStringListValue	(	const char *	name,
		NXOpen::Options::LevelType	level,
		std::vector< bool > &	selection )

获取指定层级下类型为Options::OptionTypeReorderSelList 的选项值。 若选项类型不是Options::OptionTypeReorderSelList 则抛出错误。

返回

选项值
创建于NX7.5.0。

许可要求：无

参数

name	选项名称。
level	选项层级。
selection	选择标识位

GetReorderSelectableStringListValue() [2/4]

std::vector< NXString > NXOpen::Options::OptionsManager::GetReorderSelectableStringListValue	(	const char *	name,
		std::vector< bool > &	selection )

获取Options::OptionTypeReorderSelList 类型选项的值。 若选项类型不是Options::OptionTypeReorderSelList 则抛出错误。

返回

选项值
创建于NX7.5.0。

许可证要求：无

参数

name	选项名称。
selection	选择位

GetReorderSelectableStringListValue() [3/4]

std::vector< NXString > NXOpen::Options::OptionsManager::GetReorderSelectableStringListValue	(	const NXString &	name,
		NXOpen::Options::LevelType	level,
		std::vector< bool > &	selection )

获取指定层级下类型为Options::OptionTypeReorderSelList 的选项值。 若选项类型不是Options::OptionTypeReorderSelList 则抛出错误。

返回

选项值
创建于NX7.5.0。

许可要求：无

参数

name	选项名称。
level	选项层级。
selection	选择标识位

GetReorderSelectableStringListValue() [4/4]

std::vector< NXString > NXOpen::Options::OptionsManager::GetReorderSelectableStringListValue	(	const NXString &	name,
		std::vector< bool > &	selection )

获取Options::OptionTypeReorderSelList 类型选项的值。 若选项类型不是Options::OptionTypeReorderSelList 则抛出错误。

返回

选项值
版本：NX7.5.0

许可要求：无

参数

name	选项名称。
selection	选择标记位

GetScope() [1/2]

NXOpen::Options::OptionsScope NXOpen::Options::OptionsManager::GetScope

(

const char *

name

)

获取选项的作用域。

返回

选项作用域
创建于NX12.0.0。

许可要求：无

参数

name

选项名称

GetScope() [2/2]

NXOpen::Options::OptionsScope NXOpen::Options::OptionsManager::GetScope

(

const NXString &

name

)

获取选项的作用域。

返回

选项作用域
创建于NX12.0.0。

许可要求：无

参数

name

选项名称

GetStringListValue() [1/4]

std::vector< NXString > NXOpen::Options::OptionsManager::GetStringListValue

(

const char *

name

)

获取Options::OptionTypeStringList 类型选项的值。 若选项类型不是Options::OptionTypeStringList 则抛出错误。

返回

选项值。
版本：NX4.0.0

许可要求：无

参数

name

选项名称。

GetStringListValue() [2/4]

std::vector< NXString > NXOpen::Options::OptionsManager::GetStringListValue	(	const char *	name,
		NXOpen::Options::LevelType	level )

获取指定层级下类型为Options::OptionTypeStringList 的选项值。 若选项类型不是Options::OptionTypeStringList 则抛出错误。

返回

选项值
创建于NX4.0.0。

许可要求：无

参数

name	选项名称。
level	选项层级。

GetStringListValue() [3/4]

std::vector< NXString > NXOpen::Options::OptionsManager::GetStringListValue

(

const NXString &

name

)

获取Options::OptionTypeStringList 类型选项的值。 若选项类型不是Options::OptionTypeStringList 则抛出错误。

返回

选项值。
版本：NX4.0.0

许可要求：无

参数

name

选项名称。

GetStringListValue() [4/4]

std::vector< NXString > NXOpen::Options::OptionsManager::GetStringListValue	(	const NXString &	name,
		NXOpen::Options::LevelType	level )

获取指定层级下类型为Options::OptionTypeStringList 的选项值。 若选项类型不是Options::OptionTypeStringList 则抛出错误。

返回

选项值
创建于NX4.0.0。

许可要求：无

参数

name	选项名称。
level	选项层级。

GetStringValue() [1/4]

NXString NXOpen::Options::OptionsManager::GetStringValue

(

const char *

name

)

获取Options::OptionTypeString 类型选项的值。 若选项类型不是Options::OptionTypeString 则抛出错误。

返回

选项值。
版本：NX4.0.0

许可要求：无

参数

name

选项名称。

GetStringValue() [2/4]

NXString NXOpen::Options::OptionsManager::GetStringValue	(	const char *	name,
		NXOpen::Options::LevelType	level )

获取指定层级下Options::OptionTypeString 类型选项的值。 若选项类型不是Options::OptionTypeString 则抛出错误。

返回

选项值
创建于NX4.0.0。

许可证要求：无

参数

name	选项名称。
level	选项层级。

GetStringValue() [3/4]

NXString NXOpen::Options::OptionsManager::GetStringValue

(

const NXString &

name

)

获取Options::OptionTypeString 类型选项的值。 若选项类型不是Options::OptionTypeString 则抛出错误。

返回

选项值。
版本：NX4.0.0

许可要求：无

参数

name

选项名称。

GetStringValue() [4/4]

NXString NXOpen::Options::OptionsManager::GetStringValue	(	const NXString &	name,
		NXOpen::Options::LevelType	level )

获取指定层级下Options::OptionTypeString 类型选项的值。 若选项类型不是Options::OptionTypeString 则抛出错误。

返回

选项值
创建于NX4.0.0。

许可证要求：无

参数

name	选项名称。
level	选项层级。

GetUserComment() [1/2]

NXString NXOpen::Options::OptionsManager::GetUserComment	(	const char *	name,
		NXOpen::Options::LevelType	level )

获取指定层级的用户注释。Options::LevelTypeShipped层级不支持用户注释。

返回

用户注释文本。
创建于NX4.0.0。

许可要求：无

参数

name	选项名称
level	选项层级。

GetUserComment() [2/2]

NXString NXOpen::Options::OptionsManager::GetUserComment	(	const NXString &	name,
		NXOpen::Options::LevelType	level )

获取指定层级的用户注释。Options::LevelTypeShipped层级不支持用户注释。

返回

用户注释文本。
创建于NX4.0.0。

许可要求：无

参数

name	选项名称
level	选项层级。

GetUtf8stringValue() [1/4]

NXString NXOpen::Options::OptionsManager::GetUtf8stringValue

(

const char *

name

)

获取Options::OptionTypeUtf8string 类型选项的值。 若选项类型不是Options::OptionTypeUtf8string 则抛出错误。

返回

选项的utf8值。
版本：NX6.0.0

许可要求：无

参数

name

选项名称。

GetUtf8stringValue() [2/4]

NXString NXOpen::Options::OptionsManager::GetUtf8stringValue	(	const char *	name,
		NXOpen::Options::LevelType	level )

获取指定层级下Options::OptionTypeUtf8string 类型选项的值。 若选项类型不是Options::OptionTypeString 则抛出错误。

返回

选项值
创建于NX6.0.0。

许可证要求：无

参数

name	选项名称。
level	选项层级。

GetUtf8stringValue() [3/4]

NXString NXOpen::Options::OptionsManager::GetUtf8stringValue

(

const NXString &

name

)

获取Options::OptionTypeUtf8string 类型选项的值。 若选项类型不是Options::OptionTypeUtf8string 则抛出错误。

返回

选项的utf8值。
版本：NX6.0.0

许可要求：无

参数

name

选项名称。

GetUtf8stringValue() [4/4]

NXString NXOpen::Options::OptionsManager::GetUtf8stringValue	(	const NXString &	name,
		NXOpen::Options::LevelType	level )

获取指定层级下Options::OptionTypeUtf8string 类型选项的值。 若选项类型不是Options::OptionTypeString 则抛出错误。

返回

选项值
创建于NX6.0.0。

许可证要求：无

参数

name	选项名称。
level	选项层级。

IsLevelLockedByDefault()

bool NXOpen::Options::OptionsManager::IsLevelLockedByDefault

(

NXOpen::Options::LevelType

level

)

判断指定层级的选项值是否默认被锁定。 默认锁定指：若该层级不存在选项值，则该值处于锁定状态。

返回

若选项值默认被锁定则返回true
创建于NX4.0.0。

许可要求：无

参数

level

选项层级。

IsValueLocked() [1/2]

bool NXOpen::Options::OptionsManager::IsValueLocked	(	const char *	name,
		NXOpen::Options::LevelType	level )

判断指定层级的选项值是否被锁定。 Options::LevelTypeUser和Options::LevelTypeShipped层级不支持锁定。

返回

锁定状态
创建于NX4.0.0。

许可要求：无

参数

name	选项名称
level	选项层级。

IsValueLocked() [2/2]

bool NXOpen::Options::OptionsManager::IsValueLocked	(	const NXString &	name,
		NXOpen::Options::LevelType	level )

判断指定层级的选项值是否被锁定。 Options::LevelTypeUser和Options::LevelTypeShipped层级不支持锁定。

返回

锁定状态
创建于NX4.0.0。

许可要求：无

参数

name	选项名称
level	选项层级。

IsValueSet() [1/2]

bool NXOpen::Options::OptionsManager::IsValueSet	(	const char *	name,
		NXOpen::Options::LevelType	level )

判断指定层级是否存在选项值。Options::LevelTypeShipped层级始终返回true。

返回

若值已设置则返回true
创建于NX4.0.0。

许可要求：无

参数

name	选项名称
level	选项层级。

IsValueSet() [2/2]

bool NXOpen::Options::OptionsManager::IsValueSet	(	const NXString &	name,
		NXOpen::Options::LevelType	level )

判断指定层级是否存在选项值。Options::LevelTypeShipped层级始终返回true。

返回

若值已设置则返回true
创建于NX4.0.0。

许可要求：无

参数

name	选项名称
level	选项层级。

NewOptionsChangeList()

NXOpen::Options::ChangeList * NXOpen::Options::OptionsManager::NewOptionsChangeList	(	NXOpen::Options::LevelType	level,
		NXOpen::Options::LevelLockedByDefault	lockedByDefault )

创建NXOpen::Options::ChangeList 类的实例，用于编辑一组选项。 无法为Options::LevelTypeShipped 层级、未定义或不可写入的层级创建NXOpen::Options::ChangeList 实例。

返回

NXOpen::Options::ChangeList 类的实例
创建于NX4.0.0。

许可要求：无

参数

level	选项层级。
lockedByDefault	指定选项层级是否默认锁定。 在Options::LevelTypeUser 层级下该参数被忽略，因为该层级不支持锁定。 若指定的默认锁定状态与当前状态不同，则清除所有现有锁定。

NewOptionsDraftingStandardChangeList() [1/2]

NXOpen::Options::DraftingStandardChangeList * NXOpen::Options::OptionsManager::NewOptionsDraftingStandardChangeList	(	NXOpen::Options::LevelType	level,
		const char *	filename )

创建NXOpen::Options::DraftingStandardChangeList 类的实例，用于编辑一组选项。 无法为Options::LevelTypeShipped 层级、未定义或不可写入的层级创建NXOpen::Options::DraftingStandardChangeList 实例。

返回

NXOpen::Options::DraftingStandardChangeList 类的实例
创建于NX5.0.0。

许可要求：无

参数

level	选项层级。
filename	指定保存/另存为的文件名。

NewOptionsDraftingStandardChangeList() [2/2]

NXOpen::Options::DraftingStandardChangeList * NXOpen::Options::OptionsManager::NewOptionsDraftingStandardChangeList	(	NXOpen::Options::LevelType	level,
		const NXString &	filename )

创建NXOpen::Options::DraftingStandardChangeList 类的实例，用于编辑一组选项。 无法为Options::LevelTypeShipped 层级、未定义或不可写入的层级创建NXOpen::Options::DraftingStandardChangeList 实例。

返回

NXOpen::Options::DraftingStandardChangeList 类的实例
创建于NX5.0.0。

许可要求：无

参数

level	选项层级。
filename	指定保存/另存为的文件名。

Tag()

tag_t NXOpen::Options::OptionsManager::Tag

(

)

const

返回此对象的标识。