Lean  $LEAN_TAG$
QuantConnect.Orders.Fees.OrderFee Class Reference

Defines the result for IFeeModel.GetOrderFee More...

Inheritance diagram for QuantConnect.Orders.Fees.OrderFee:
[legend]

Public Member Functions

 OrderFee (CashAmount orderFee)
 Initializes a new instance of the OrderFee class More...
 
virtual void ApplyToPortfolio (SecurityPortfolioManager portfolio, OrderEvent fill)
 Applies the order fee to the given portfolio More...
 
override string ToString ()
 This is for backward compatibility with old 'decimal' order fee More...
 

Static Public Member Functions

static implicit operator decimal (OrderFee m)
 This is for backward compatibility with old 'decimal' order fee More...
 

Static Public Attributes

static readonly OrderFee Zero
 Gets an instance of OrderFee that represents zero. More...
 

Properties

CashAmount Value [get, set]
 Gets the order fee More...
 

Detailed Description

Defines the result for IFeeModel.GetOrderFee

Definition at line 25 of file OrderFee.cs.

Constructor & Destructor Documentation

◆ OrderFee()

QuantConnect.Orders.Fees.OrderFee.OrderFee ( CashAmount  orderFee)

Initializes a new instance of the OrderFee class

Parameters
orderFeeThe order fee

Definition at line 37 of file OrderFee.cs.

Member Function Documentation

◆ ApplyToPortfolio()

virtual void QuantConnect.Orders.Fees.OrderFee.ApplyToPortfolio ( SecurityPortfolioManager  portfolio,
OrderEvent  fill 
)
virtual

Applies the order fee to the given portfolio

Parameters
portfolioThe portfolio instance
fillThe order fill event

Reimplemented in QuantConnect.Orders.Fees.ModifiedFillQuantityOrderFee.

Definition at line 49 of file OrderFee.cs.

Here is the caller graph for this function:

◆ ToString()

override string QuantConnect.Orders.Fees.OrderFee.ToString ( )

This is for backward compatibility with old 'decimal' order fee

Definition at line 57 of file OrderFee.cs.

◆ operator decimal()

static implicit QuantConnect.Orders.Fees.OrderFee.operator decimal ( OrderFee  m)
static

This is for backward compatibility with old 'decimal' order fee

Definition at line 65 of file OrderFee.cs.

Member Data Documentation

◆ Zero

readonly OrderFee QuantConnect.Orders.Fees.OrderFee.Zero
static
Initial value:
=
new OrderFee(new CashAmount(0, Currencies.NullCurrency))

Gets an instance of OrderFee that represents zero.

Definition at line 73 of file OrderFee.cs.

Property Documentation

◆ Value

CashAmount QuantConnect.Orders.Fees.OrderFee.Value
getset

Gets the order fee

Definition at line 31 of file OrderFee.cs.


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