Lean  $LEAN_TAG$
Public Member Functions | Properties | List of all members
QuantConnect.Securities.GetMaximumOrderQuantityResult Class Reference

Contains the information returned by IBuyingPowerModel.GetMaximumOrderQuantityForTargetBuyingPower and IBuyingPowerModel.GetMaximumOrderQuantityForDeltaBuyingPower More...

Public Member Functions

 GetMaximumOrderQuantityResult (decimal quantity, string reason=null)
 Initializes a new instance of the GetMaximumOrderQuantityResult class More...
 
 GetMaximumOrderQuantityResult (decimal quantity, string reason, bool isError=true)
 Initializes a new instance of the GetMaximumOrderQuantityResult class More...
 

Properties

decimal Quantity [get]
 Returns the maximum quantity for the order More...
 
string Reason [get]
 Returns the reason for which the maximum order quantity is zero More...
 
bool IsError [get]
 Returns true if the zero order quantity is an error condition and will be shown to the user. More...
 

Detailed Description

Contains the information returned by IBuyingPowerModel.GetMaximumOrderQuantityForTargetBuyingPower and IBuyingPowerModel.GetMaximumOrderQuantityForDeltaBuyingPower

Definition at line 22 of file GetMaximumOrderQuantityResult.cs.

Constructor & Destructor Documentation

◆ GetMaximumOrderQuantityResult() [1/2]

QuantConnect.Securities.GetMaximumOrderQuantityResult.GetMaximumOrderQuantityResult ( decimal  quantity,
string  reason = null 
)

Initializes a new instance of the GetMaximumOrderQuantityResult class

Parameters
quantityReturns the maximum quantity for the order
reasonThe reason for which the maximum order quantity is zero

Definition at line 44 of file GetMaximumOrderQuantityResult.cs.

◆ GetMaximumOrderQuantityResult() [2/2]

QuantConnect.Securities.GetMaximumOrderQuantityResult.GetMaximumOrderQuantityResult ( decimal  quantity,
string  reason,
bool  isError = true 
)

Initializes a new instance of the GetMaximumOrderQuantityResult class

Parameters
quantityReturns the maximum quantity for the order
reasonThe reason for which the maximum order quantity is zero
isErrorTrue if the zero order quantity is an error condition

Definition at line 57 of file GetMaximumOrderQuantityResult.cs.

Property Documentation

◆ Quantity

decimal QuantConnect.Securities.GetMaximumOrderQuantityResult.Quantity
get

Returns the maximum quantity for the order

Definition at line 27 of file GetMaximumOrderQuantityResult.cs.

◆ Reason

string QuantConnect.Securities.GetMaximumOrderQuantityResult.Reason
get

Returns the reason for which the maximum order quantity is zero

Definition at line 32 of file GetMaximumOrderQuantityResult.cs.

◆ IsError

bool QuantConnect.Securities.GetMaximumOrderQuantityResult.IsError
get

Returns true if the zero order quantity is an error condition and will be shown to the user.

Definition at line 37 of file GetMaximumOrderQuantityResult.cs.

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