Represents a Margin result. More...

Inheritance diagram for HyperX.Scripting.Margin:

Public Member Functions
int	CompareTo (Margin other)
	Compare margins to determine which is more critical.

Properties
float?	AdjustedMargin `[get]`
	The adjusted margin for this Margin, if present. This value may be `null` when the Margin has a code (see: MarginCode).
bool	IsFailureCode `[get]`
	Indicates whether the code is a failure code or not. If `true`, IsInformationalCode should return `false`.
bool	IsInformationalCode `[get]`
	Indicates whether the code is an informational code or not. If `true`, IsFailureCode should return `false`.
MarginCode	MarginCode `[get]`
	Returns a failure code when IsFailureCode is `true`, returns an informational code when IsInformationalCode is `true`, or returns MarginCode.Value when the AdjustedMargin has a value.

Detailed Description

Represents a Margin result.

Member Function Documentation

int HyperX.Scripting.Margin.CompareTo ( Margin 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.

float? HyperX.Scripting.Margin.AdjustedMargin

get

The adjusted margin for this Margin, if present. This value may be null when the Margin has a code (see: MarginCode).

bool HyperX.Scripting.Margin.IsFailureCode

get

Indicates whether the code is a failure code or not. If true, IsInformationalCode should return false.

bool HyperX.Scripting.Margin.IsInformationalCode

get

Indicates whether the code is an informational code or not. If true, IsFailureCode should return false.

MarginCode HyperX.Scripting.Margin.MarginCode

get

Returns a failure code when IsFailureCode is true, returns an informational code when IsInformationalCode is true, or returns MarginCode.Value when the AdjustedMargin has a value.

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