hyperx.api.BackdoorSetting Class Reference

Public Member Functions
	__init__ (self, _api.BackdoorSetting backdoorSetting)
None	ResetGlobalValueToDefaultValue (self)
None	ResetProjectValueToGlobalValue (self)

Protected Attributes
	_Entity = backdoorSetting

Properties
	BackdoorId = property
	Identifier of the setting.
	BackdoorType = property
	Indicates the data type of the setting.
	Description = property
	GlobalBoolValue = property
	Gets and sets the database level setting value for boolean type settings.
	GlobalDoubleValue = property
	Gets and sets the database level setting value for double type settings.
	GlobalIntValue = property
	Gets and sets the database level setting value for integer type settings.
	GlobalStringValue = property
	Gets and sets the database level setting value for string type settings.
	ProjectBoolValue = property
	Gets and sets the project level setting value for boolean type settings.
	ProjectDoubleValue = property
	Gets and sets the project level setting value for double type settings.
	ProjectIntValue = property
	Gets and sets the project level setting value for integer type settings.
	ProjectStringValue = property
	Gets and sets the project level setting value for string type settings.

Constructor & Destructor Documentation

__init__()

hyperx.api.BackdoorSetting.__init__	(		self,
		_api.BackdoorSetting	backdoorSetting )

Member Function Documentation

ResetGlobalValueToDefaultValue()

None hyperx.api.BackdoorSetting.ResetGlobalValueToDefaultValue

(

self

)

ResetProjectValueToGlobalValue()

None hyperx.api.BackdoorSetting.ResetProjectValueToGlobalValue

(

self

)

Member Data Documentation

_Entity

hyperx.api.BackdoorSetting._Entity = backdoorSetting

protected

Property Documentation

BackdoorId

hyperx.api.BackdoorSetting.BackdoorId = property

static

Identifier of the setting.

BackdoorType

hyperx.api.BackdoorSetting.BackdoorType = property

static

Indicates the data type of the setting.

Use this to determine which property to use for getting and setting the setting value.

Description

hyperx.api.BackdoorSetting.Description = property

static

GlobalBoolValue

hyperx.api.BackdoorSetting.GlobalBoolValue = property

static

Gets and sets the database level setting value for boolean type settings.

Use if hyperx.api.BackdoorSetting.BackdoorType is hyperx.api.types.BackdoorTypeId.Boolean.

GlobalDoubleValue

hyperx.api.BackdoorSetting.GlobalDoubleValue = property

static

Gets and sets the database level setting value for double type settings.

Use if hyperx.api.BackdoorSetting.BackdoorType is hyperx.api.types.BackdoorTypeId.Double.

GlobalIntValue

hyperx.api.BackdoorSetting.GlobalIntValue = property

static

Gets and sets the database level setting value for integer type settings.

Use if hyperx.api.BackdoorSetting.BackdoorType is hyperx.api.types.BackdoorTypeId.Integer.

GlobalStringValue

hyperx.api.BackdoorSetting.GlobalStringValue = property

static

Gets and sets the database level setting value for string type settings.

Use if hyperx.api.BackdoorSetting.BackdoorType is hyperx.api.types.BackdoorTypeId.String, hyperx.api.types.BackdoorTypeId.IntegerList, or hyperx.api.types.BackdoorTypeId.DoubleList.

ProjectBoolValue

hyperx.api.BackdoorSetting.ProjectBoolValue = property

static

Gets and sets the project level setting value for boolean type settings.

Use if hyperx.api.BackdoorSetting.BackdoorType is hyperx.api.types.BackdoorTypeId.Boolean.

ProjectDoubleValue

hyperx.api.BackdoorSetting.ProjectDoubleValue = property

static

Gets and sets the project level setting value for double type settings.

Use if hyperx.api.BackdoorSetting.BackdoorType is hyperx.api.types.BackdoorTypeId.Double.

ProjectIntValue

hyperx.api.BackdoorSetting.ProjectIntValue = property

static

Gets and sets the project level setting value for integer type settings.

Use if hyperx.api.BackdoorSetting.BackdoorType is hyperx.api.types.BackdoorTypeId.Integer.

ProjectStringValue

hyperx.api.BackdoorSetting.ProjectStringValue = property

static

Gets and sets the project level setting value for string type settings.

Use if hyperx.api.BackdoorSetting.BackdoorType is hyperx.api.types.BackdoorTypeId.String, hyperx.api.types.BackdoorTypeId.IntegerList, or hyperx.api.types.BackdoorTypeId.DoubleList.

---

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

• C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py