hyperx.api.FailureSetting Class Reference

Setting for a Failure Mode or a Failure Criteria. More...

Inheritance diagram for hyperx.api.FailureSetting:

Public Member Functions
	__init__ (self, _api.FailureSetting failureSetting)
None	SetBoolValue (self, bool value)
None	SetFloatValue (self, float value)
None	SetIntValue (self, int value)
None	SetSelectionValue (self, int index)
	Set enum value by index.
None	SetStringValue (self, str value)
Public Member Functions inherited from hyperx.api.IdNameEntity
	__init__ (self, _api.IdNameEntity idNameEntity)
Public Member Functions inherited from hyperx.api.IdEntity
	__init__ (self, _api.IdEntity idEntity)

Properties
	CategoryId = property
	DataType = property
	DefaultValue = property
	Description = property
	EnumValues = property
	PackageId = property
	PackageSettingId = property
	UID = property
	Value = property
Properties inherited from hyperx.api.IdNameEntity
	Name = property
Properties inherited from hyperx.api.IdEntity
	Id = property

Additional Inherited Members
Protected Attributes inherited from hyperx.api.IdEntity
	_Entity = idEntity

Detailed Description

Setting for a Failure Mode or a Failure Criteria.

Constructor & Destructor Documentation

__init__()

hyperx.api.FailureSetting.__init__	(		self,
		_api.FailureSetting	failureSetting )

Member Function Documentation

SetBoolValue()

None hyperx.api.FailureSetting.SetBoolValue	(		self,
		bool	value )

SetFloatValue()

None hyperx.api.FailureSetting.SetFloatValue	(		self,
		float	value )

SetIntValue()

None hyperx.api.FailureSetting.SetIntValue	(		self,
		int	value )

SetSelectionValue()

None hyperx.api.FailureSetting.SetSelectionValue	(		self,
		int	index )

Set enum value by index.

SetStringValue()

None hyperx.api.FailureSetting.SetStringValue	(		self,
		str	value )

Property Documentation

CategoryId

hyperx.api.FailureSetting.CategoryId = property

static

DataType

hyperx.api.FailureSetting.DataType = property

static

DefaultValue

hyperx.api.FailureSetting.DefaultValue = property

static

Description

hyperx.api.FailureSetting.Description = property

static

EnumValues

hyperx.api.FailureSetting.EnumValues = property

static

PackageId

hyperx.api.FailureSetting.PackageId = property

static

PackageSettingId

hyperx.api.FailureSetting.PackageSettingId = property

static

UID

hyperx.api.FailureSetting.UID = property

static

Value

hyperx.api.FailureSetting.Value = property

static

---

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

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