Lean  $LEAN_TAG$
QuantConnect.Securities.IdentityCurrencyConverter Class Reference

Provides an implementation of ICurrencyConverter that does NOT perform conversions. This implementation will throw if the specified cashAmount is not in units of account currency. More...

Inheritance diagram for QuantConnect.Securities.IdentityCurrencyConverter:
[legend]

Public Member Functions

 IdentityCurrencyConverter (string accountCurrency)
 Initializes a new instance of the ICurrencyConverter class More...
 
CashAmount ConvertToAccountCurrency (CashAmount cashAmount)
 Converts a cash amount to the account currency. This implementation can only handle cash amounts in units of the account currency. More...
 

Properties

string AccountCurrency [get]
 Gets account currency More...
 
- Properties inherited from QuantConnect.Securities.ICurrencyConverter
string AccountCurrency [get]
 Gets account currency More...
 

Detailed Description

Provides an implementation of ICurrencyConverter that does NOT perform conversions. This implementation will throw if the specified cashAmount is not in units of account currency.

Definition at line 24 of file IdentityCurrencyConverter.cs.

Constructor & Destructor Documentation

◆ IdentityCurrencyConverter()

QuantConnect.Securities.IdentityCurrencyConverter.IdentityCurrencyConverter ( string  accountCurrency)

Initializes a new instance of the ICurrencyConverter class

Parameters
accountCurrencyThe algorithm's account currency

Definition at line 35 of file IdentityCurrencyConverter.cs.

Member Function Documentation

◆ ConvertToAccountCurrency()

CashAmount QuantConnect.Securities.IdentityCurrencyConverter.ConvertToAccountCurrency ( CashAmount  cashAmount)

Converts a cash amount to the account currency. This implementation can only handle cash amounts in units of the account currency.

Parameters
cashAmountThe CashAmount instance to convert
Returns
A new CashAmount instance denominated in the account currency

Implements QuantConnect.Securities.ICurrencyConverter.

Definition at line 46 of file IdentityCurrencyConverter.cs.

Property Documentation

◆ AccountCurrency

string QuantConnect.Securities.IdentityCurrencyConverter.AccountCurrency
get

Gets account currency

Definition at line 29 of file IdentityCurrencyConverter.cs.


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