Loading...
Searching...
No Matches
ATAS.Indicators.IVolumeValuation Interface Reference

Values traded volumes of one instrument in money (PLAT-5080). Provided by the platform through IInstrumentInfo.Valuation. More...

Public Member Functions

bool TryGetFactor (string? currency, out VolumeValueFactor factor)
 Gets the factor that converts the instrument's volume into money of currency .
 

Properties

string? InstrumentCurrency [get]
 Currency the instrument's notional value is denominated in (USDT for BTCUSDT, USD for ES, EUR for FDAX); null when the platform cannot value the instrument.
 
string? DisplayCurrency [get]
 Currency selected in the platform settings for money values; null means the instrument currency.
 
decimal? ReferencePrice [get]
 Last known price of the instrument, used to show volume thresholds in money and back; null when unknown.
 
int Version [get]
 Incremented whenever an exchange rate, the display currency or the instrument model changes. Lets callers cache factors cheaply.
 

Events

EventHandler? Changed
 Raised after Version changes. May be raised on any thread.
 

Detailed Description

Values traded volumes of one instrument in money (PLAT-5080). Provided by the platform through IInstrumentInfo.Valuation.

Member Function Documentation

◆ TryGetFactor()

bool ATAS.Indicators.IVolumeValuation.TryGetFactor ( string?  currency,
out VolumeValueFactor  factor 
)

Gets the factor that converts the instrument's volume into money of currency .

Parameters
currencyTarget currency code; null or empty means the instrument currency (no exchange rate).
factorThe factor when available.
Returns
False when the instrument cannot be valued or no exchange rate to the currency is known.

Property Documentation

◆ DisplayCurrency

string? ATAS.Indicators.IVolumeValuation.DisplayCurrency
get

Currency selected in the platform settings for money values; null means the instrument currency.

◆ InstrumentCurrency

string? ATAS.Indicators.IVolumeValuation.InstrumentCurrency
get

Currency the instrument's notional value is denominated in (USDT for BTCUSDT, USD for ES, EUR for FDAX); null when the platform cannot value the instrument.

◆ ReferencePrice

decimal? ATAS.Indicators.IVolumeValuation.ReferencePrice
get

Last known price of the instrument, used to show volume thresholds in money and back; null when unknown.

◆ Version

int ATAS.Indicators.IVolumeValuation.Version
get

Incremented whenever an exchange rate, the display currency or the instrument model changes. Lets callers cache factors cheaply.

Event Documentation

◆ Changed

EventHandler? ATAS.Indicators.IVolumeValuation.Changed

Raised after Version changes. May be raised on any thread.


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