Table of Contents

Class PlatformModuleInstrumentInfo

Namespace
ATAS.Indicators.Modules
Assembly
ATAS.Indicators.dll

An instrument the platform knows, as FindInstruments(string, int) returns it: what to show to the user and the Id that names exactly this instrument for AddInstrument(string, string?, bool).

Not in ATAS 8.0.15 yet: available from the next version.

public sealed class PlatformModuleInstrumentInfo
Inheritance
object
PlatformModuleInstrumentInfo
Extension Methods

Remarks

The code and the exchange alone do not always name one instrument: a delayed data source lists the same contract (same code, same exchange) next to the real-time one. The Id tells them apart.

Constructors

PlatformModuleInstrumentInfo(string, string, string, string, decimal, bool)

Creates the description of an instrument (the platform does it; a module needs it only in its own tests).

public PlatformModuleInstrumentInfo(string id, string code, string exchange, string name, decimal tickSize, bool isDelayed)

Parameters

id string
code string
exchange string
name string
tickSize decimal
isDelayed bool

Properties

Code

The code of the instrument as the platform shows it (for example ESZ6, BTCUSDT).

public string Code { get; }

Property Value

string

Exchange

The code of the exchange (for example CME), or an empty text when unknown.

public string Exchange { get; }

Property Value

string

Id

The identifier of the instrument in the platform: an opaque text that stays the same between runs of the platform. Save it in the settings of the module and pass it to AddInstrument(string, string?, bool). Do not parse it and do not show it to the user.

public string Id { get; }

Property Value

string

IsDelayed

True for an instrument of a delayed data source (its data comes with a delay, typically 15 minutes).

public bool IsDelayed { get; }

Property Value

bool

Name

The description of the instrument, or an empty text when the data source gives none.

public string Name { get; }

Property Value

string

TickSize

The minimal price step.

public decimal TickSize { get; }

Property Value

decimal

Methods

ToString()

Returns the instrument as code@exchange, or the code alone when the exchange is unknown.

public override string ToString()

Returns

string

The text.