hyperx.api.ToolingConstraint Class Reference

Tooling constraints are a feature of Design Properties for Zones. More...

Inheritance diagram for hyperx.api.ToolingConstraint:

Public Member Functions
	__init__ (self, _api.ToolingConstraint toolingConstraint)
None	SetToAnyValue (self)
	Change the hyperx.api.ToolingConstraint.ToolingSelectionType to hyperx.api.types.ToolingSelectionType.AnyValue.
None	SetToInequality (self, float value)
	Set the tooling constraint to an inequality if the constraint type is an inequality.
None	SetToRange (self, float min, float max)
	Set the tooling constraint to a range if the constraint type is a range.
None	SetToValue (self, float value)
	Set the tooling constraint to a 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
	ConstraintMax = property
	The max constraint bound for the range constraint type.
	ConstraintMin = property
	The min constraint bound for the range constraint type.
	ConstraintValue = property
	The value for this hyperx.api.ToolingConstraint.
	ToolingSelectionType = property
	Defines which hyperx.api.types.ToolingSelectionType a given tooling constraint is currently set to.
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

Tooling constraints are a feature of Design Properties for Zones.

Constructor & Destructor Documentation

__init__()

hyperx.api.ToolingConstraint.__init__	(		self,
		_api.ToolingConstraint	toolingConstraint )

Member Function Documentation

SetToAnyValue()

None hyperx.api.ToolingConstraint.SetToAnyValue

(

self

)

Change the hyperx.api.ToolingConstraint.ToolingSelectionType to hyperx.api.types.ToolingSelectionType.AnyValue.

SetToInequality()

None hyperx.api.ToolingConstraint.SetToInequality	(		self,
		float	value )

Set the tooling constraint to an inequality if the constraint type is an inequality.

Sets the hyperx.api.ToolingConstraint.ToolingSelectionType to hyperx.api.types.ToolingSelectionType.SpecifiedLimitOrRange.

Exceptions

InvalidOperationException

If the constraint type is not an inequality.

SetToRange()

None hyperx.api.ToolingConstraint.SetToRange	(		self,
		float	min,
		float	max )

Set the tooling constraint to a range if the constraint type is a range.

Sets the hyperx.api.ToolingConstraint.ToolingSelectionType to hyperx.api.types.ToolingSelectionType.SpecifiedLimitOrRange.

Exceptions

InvalidOperationException

If the constraint type is not .

SetToValue()

None hyperx.api.ToolingConstraint.SetToValue	(		self,
		float	value )

Set the tooling constraint to a value.

Sets the hyperx.api.ToolingConstraint.ToolingSelectionType to hyperx.api.types.ToolingSelectionType.SpecifiedValue.

Exceptions

InvalidOperationException

Property Documentation

ConstraintMax

hyperx.api.ToolingConstraint.ConstraintMax = property

static

The max constraint bound for the range constraint type.

ConstraintMin

hyperx.api.ToolingConstraint.ConstraintMin = property

static

The min constraint bound for the range constraint type.

ConstraintValue

hyperx.api.ToolingConstraint.ConstraintValue = property

static

The value for this hyperx.api.ToolingConstraint.

Use hyperx.api.ToolingConstraint.ToolingSelectionType to determine how this value is used.

ToolingSelectionType

hyperx.api.ToolingConstraint.ToolingSelectionType = property

static

Defines which hyperx.api.types.ToolingSelectionType a given tooling constraint is currently set to.

---

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

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