Struct HeatmapMboStatus

Namespace

OFT.Rendering.Heatmap.Mbo

Assembly

OFT.Rendering.dll

State of the MBO (market by order) data of the heatmap for an instrument, as the Status of HeatmapMboDataSnapshot. Check Kind before using the data.

Added in ATAS 8.0.15.

public readonly struct HeatmapMboStatus

Extension Methods

Extensions.ConvertToMyTrade<T>(T, Portfolio, Security, Action<MyTrade, T>)

Constructors

HeatmapMboStatus(HeatmapMboStatusKind, string, bool)

Creates a status.

public HeatmapMboStatus(HeatmapMboStatusKind kind, string message = "", bool isGracePeriod = false)

Parameters

kind HeatmapMboStatusKind

The state of the data.

message string

Text for the user that explains the state; null is stored as an empty string.

isGracePeriod bool

Whether a NoData state is provisional.

Properties

IsGracePeriod

Whether a NoData state is provisional: the history is loaded and empty, and the first live MBO updates may still arrive (the heatmap shows "Waiting for MBO data..." instead of "no data").

public bool IsGracePeriod { get; }

Property Value

bool

Kind

The state of the data.

public HeatmapMboStatusKind Kind { get; }

Property Value

HeatmapMboStatusKind

Message

Text for the user that explains the state (localized, except an error, which is the exception type and message); empty when there is none, for example for Ok, and null in a default value.

public string Message { get; }

Property Value

string

Methods

Equals(HeatmapMboStatus)

public bool Equals(HeatmapMboStatus other)

Parameters

other HeatmapMboStatus

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(HeatmapMboStatus, HeatmapMboStatus)

public static bool operator ==(HeatmapMboStatus left, HeatmapMboStatus right)

Parameters

left HeatmapMboStatus

right HeatmapMboStatus

Returns

bool

operator !=(HeatmapMboStatus, HeatmapMboStatus)

public static bool operator !=(HeatmapMboStatus left, HeatmapMboStatus right)

Parameters

left HeatmapMboStatus

right HeatmapMboStatus

Returns

bool