Lean  $LEAN_TAG$
QuantConnect.Securities.Positions.GetMaximumLotsResult Class Reference

Result type for IPositionGroupBuyingPowerModel.GetMaximumLotsForDeltaBuyingPower and IPositionGroupBuyingPowerModel.GetMaximumLotsForTargetBuyingPower More...

Public Member Functions

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

Properties

decimal NumberOfLots [get]
 Returns the maximum number of lots of the position group that can be ordered. This is a whole number and is the IPositionGroup.Quantity 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

Constructor & Destructor Documentation

◆ GetMaximumLotsResult() [1/2]

QuantConnect.Securities.Positions.GetMaximumLotsResult.GetMaximumLotsResult ( decimal  numberOfLots,
string  reason = null 
)

Initializes a new instance of the GetMaximumOrderQuantityResult class

Parameters
numberOfLotsReturns the maximum number of lots of the position group that can be ordered
reasonThe reason for which the maximum order quantity is zero

Definition at line 45 of file GetMaximumLotsResult.cs.

◆ GetMaximumLotsResult() [2/2]

QuantConnect.Securities.Positions.GetMaximumLotsResult.GetMaximumLotsResult ( decimal  numberOfLots,
string  reason,
bool  isError = true 
)

Initializes a new instance of the GetMaximumOrderQuantityResult class

Parameters
numberOfLotsReturns the maximum number of lots of the position group that can be ordered
reasonThe reason for which the maximum order quantity is zero
isErrorTrue if the zero order quantity is an error condition

Definition at line 58 of file GetMaximumLotsResult.cs.

Property Documentation

◆ NumberOfLots

decimal QuantConnect.Securities.Positions.GetMaximumLotsResult.NumberOfLots
get

Returns the maximum number of lots of the position group that can be ordered. This is a whole number and is the IPositionGroup.Quantity

Definition at line 28 of file GetMaximumLotsResult.cs.

◆ Reason

string QuantConnect.Securities.Positions.GetMaximumLotsResult.Reason
get

Returns the reason for which the maximum order quantity is zero

Definition at line 33 of file GetMaximumLotsResult.cs.

◆ IsError

bool QuantConnect.Securities.Positions.GetMaximumLotsResult.IsError
get

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

Definition at line 38 of file GetMaximumLotsResult.cs.


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