ATAS.Indicators.Modules.PlatformModuleInstrumentInfo Class Reference

An instrument the platform knows, as IPlatformModuleContext.FindInstruments returns it: what to show to the user and the Id that names exactly this instrument for IPlatformModuleContext.AddInstrument. More...

Public Member Functions
	PlatformModuleInstrumentInfo (string id, string code, string exchange, string name, decimal tickSize, bool isDelayed)
	Creates the description of an instrument (the platform does it; a module needs it only in its own tests).
override string	ToString ()

Properties
string	Id [get]
	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 IPlatformModuleContext.AddInstrument. Do not parse it and do not show it to the user.
string	Code [get]
	The code of the instrument as the platform shows it (for example ESZ6, BTCUSDT).
string	Exchange [get]
	The code of the exchange (for example CME), or an empty text when unknown.
string	Name [get]
	The description of the instrument, or an empty text when the data source gives none.
decimal	TickSize [get]
	The minimal price step.
bool	IsDelayed [get]
	True for an instrument of a delayed data source (its data comes with a delay, typically 15 minutes).

Detailed Description

An instrument the platform knows, as IPlatformModuleContext.FindInstruments returns it: what to show to the user and the Id that names exactly this instrument for IPlatformModuleContext.AddInstrument.

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.

Constructor & Destructor Documentation

PlatformModuleInstrumentInfo()

ATAS.Indicators.Modules.PlatformModuleInstrumentInfo.PlatformModuleInstrumentInfo	(	string	id,
		string	code,
		string	exchange,
		string	name,
		decimal	tickSize,
		bool	isDelayed
	)

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

Member Function Documentation

ToString()

override string ATAS.Indicators.Modules.PlatformModuleInstrumentInfo.ToString

(

)

Property Documentation

Code

string ATAS.Indicators.Modules.PlatformModuleInstrumentInfo.Code

get

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

Exchange

string ATAS.Indicators.Modules.PlatformModuleInstrumentInfo.Exchange

get

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

Id

string ATAS.Indicators.Modules.PlatformModuleInstrumentInfo.Id

get

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 IPlatformModuleContext.AddInstrument. Do not parse it and do not show it to the user.

IsDelayed

bool ATAS.Indicators.Modules.PlatformModuleInstrumentInfo.IsDelayed

get

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

Name

string ATAS.Indicators.Modules.PlatformModuleInstrumentInfo.Name

get

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

TickSize

decimal ATAS.Indicators.Modules.PlatformModuleInstrumentInfo.TickSize

get

The minimal price step.

---

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

• PlatformModuleInstrumentInfo.cs