hyperx.api.Margin Class Reference

Represents a Margin result. More...

Public Member Functions
	__init__ (self, _api.Margin margin)
int	CompareTo (self, other)
	Compare margins to determine which is more critical.

Protected Attributes
	_Entity = margin

Properties
	AdjustedMargin = property
	The adjusted margin for this hyperx.api.Margin, if present.
	IsFailureCode = property
	Indicates whether the code is a failure code or not.
	IsInformationalCode = property
	Indicates whether the code is an informational code or not.
	MarginCode = property
	Returns a failure code when hyperx.api.Margin.IsFailureCode is True, returns an informational code when hyperx.api.Margin.IsInformationalCode is True, or returns hyperx.api.types.MarginCode.Value when the hyperx.api.Margin.AdjustedMargin has a value.

Detailed Description

Represents a Margin result.

Constructor & Destructor Documentation

__init__()

hyperx.api.Margin.__init__	(		self,
		_api.Margin	margin )

Member Function Documentation

CompareTo()

int hyperx.api.Margin.CompareTo	(		self,
			other )

Compare margins to determine which is more critical.

Parameters

other

The margin to compare to

Returns

-1 if this margin is more critical, 0 if the margins are equally critical, or 1 if the other margin is more critical.

Member Data Documentation

_Entity

hyperx.api.Margin._Entity = margin

protected

Property Documentation

AdjustedMargin

hyperx.api.Margin.AdjustedMargin = property

static

The adjusted margin for this hyperx.api.Margin, if present.

This value may be None when the hyperx.api.Margin has a code (see: hyperx.api.Margin.MarginCode).

IsFailureCode

hyperx.api.Margin.IsFailureCode = property

static

Indicates whether the code is a failure code or not.

If True, hyperx.api.Margin.IsInformationalCode should return False.

IsInformationalCode

hyperx.api.Margin.IsInformationalCode = property

static

Indicates whether the code is an informational code or not.

If True, hyperx.api.Margin.IsFailureCode should return False.

MarginCode

hyperx.api.Margin.MarginCode = property

static

Returns a failure code when hyperx.api.Margin.IsFailureCode is True, returns an informational code when hyperx.api.Margin.IsInformationalCode is True, or returns hyperx.api.types.MarginCode.Value when the hyperx.api.Margin.AdjustedMargin has a value.

---

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

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