Lean  $LEAN_TAG$
QuantConnect.Securities.CurrencyConversion.ICurrencyConversion Interface Reference

Represents a type capable of calculating the conversion rate between two currencies More...

Inheritance diagram for QuantConnect.Securities.CurrencyConversion.ICurrencyConversion:
[legend]

Public Member Functions

void Update ()
 Updates the internal conversion rate based on the latest data, and returns the new conversion rate More...
 

Properties

string SourceCurrency [get]
 The currency this conversion converts from More...
 
string DestinationCurrency [get]
 The currency this conversion converts to More...
 
decimal ConversionRate [get, set]
 The current conversion rate between SourceCurrency and DestinationCurrency More...
 
IEnumerable< SecurityConversionRateSecurities [get]
 The securities which the conversion rate is based on More...
 

Events

EventHandler< decimal > ConversionRateUpdated
 Event fired when the conversion rate is updated More...
 

Detailed Description

Represents a type capable of calculating the conversion rate between two currencies

Definition at line 25 of file ICurrencyConversion.cs.

Member Function Documentation

◆ Update()

void QuantConnect.Securities.CurrencyConversion.ICurrencyConversion.Update ( )

Updates the internal conversion rate based on the latest data, and returns the new conversion rate

Returns
The new conversion rate

Implemented in QuantConnect.Securities.CurrencyConversion.SecurityCurrencyConversion, and QuantConnect.Securities.CurrencyConversion.ConstantCurrencyConversion.

Here is the caller graph for this function:

Property Documentation

◆ SourceCurrency

string QuantConnect.Securities.CurrencyConversion.ICurrencyConversion.SourceCurrency
get

The currency this conversion converts from

Definition at line 35 of file ICurrencyConversion.cs.

◆ DestinationCurrency

string QuantConnect.Securities.CurrencyConversion.ICurrencyConversion.DestinationCurrency
get

The currency this conversion converts to

Definition at line 40 of file ICurrencyConversion.cs.

◆ ConversionRate

decimal QuantConnect.Securities.CurrencyConversion.ICurrencyConversion.ConversionRate
getset

The current conversion rate between SourceCurrency and DestinationCurrency

Definition at line 45 of file ICurrencyConversion.cs.

◆ ConversionRateSecurities

IEnumerable<Security> QuantConnect.Securities.CurrencyConversion.ICurrencyConversion.ConversionRateSecurities
get

The securities which the conversion rate is based on

Definition at line 50 of file ICurrencyConversion.cs.

Event Documentation

◆ ConversionRateUpdated

EventHandler<decimal> QuantConnect.Securities.CurrencyConversion.ICurrencyConversion.ConversionRateUpdated

Event fired when the conversion rate is updated

Definition at line 30 of file ICurrencyConversion.cs.


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