Lean  $LEAN_TAG$
QuantConnect.Messages.CashBuyingPowerModel Class Reference

Provides user-facing messages for the Securities.CashBuyingPowerModel class and its consumers or related classes More...

Static Public Member Functions

static string UnsupportedSecurity (Securities.Security security)
 Returns a string message saying: The security is not supported by this cash model. It also mentioned that currently just crypt and forex securities are supported More...
 
static string SellOrderShortHoldingsNotSupported (decimal totalQuantity, decimal openOrdersReservedQuantity, decimal orderQuantity, IBaseCurrencySymbol baseCurrency)
 Returns a string message saying Cash Modeling trading does not permit short holdings as well as portfolio holdings and an advise to ensure the user is selling only what it has More...
 
static string BuyOrderQuantityGreaterThanMaxForBuyingPower (decimal totalQuantity, decimal maximumQuantity, decimal openOrdersReservedQuantity, decimal orderQuantity, IBaseCurrencySymbol baseCurrency, Securities.Security security, Orders.Order order)
 Returns a string message containing the portfolio holdings, the buy order and the maximum buying power More...
 
static string NoDataInInternalCashFeedYet (Securities.Security security, Securities.SecurityPortfolioManager portfolio)
 Returns a string message saying the internal cash feed required for converting the quote currency, from the given security, to the target account currency, from the given portfolio, does not have any data More...
 
static string ZeroContractMultiplier (Securities.Security security)
 Returns a string mesasge saying the contract multiplier for the given security is zero More...
 
static string OrderQuantityLessThanLotSize (Securities.Security security)
 Returns a string message saying the order quantity is less than the lot size for the given security More...
 
static string OrderQuantityLessThanLotSizeOrderDetails (decimal targetOrderValue, decimal orderQuantity, decimal orderFees)
 Returns a string message containing information about the target order value, the order fees and the order quantity More...
 
static string FailedToConvergeOnTargetOrderValue (decimal targetOrderValue, decimal currentOrderValue, decimal orderQuantity, decimal orderFees, Securities.Security security)
 Returns a string message saying GetMaximumOrderQuantityForTargetBuyingPower failed to converge to the given target order value More...
 

Static Public Attributes

static string UnsupportedLeverage = "CashBuyingPowerModel does not allow setting leverage. Cash accounts have no leverage."
 String message saying: CashBuyingPowerModel does not allow setting leverage. Cash accounts have no leverage More...
 
static string GetMaximumOrderQuantityForDeltaBuyingPowerNotImplemented
 String message saying: The CashBuyingPowerModel does not require GetMaximumOrderQuantityForDeltaBuyingPower More...
 
static string ShortingNotSupported = "The cash model does not allow shorting."
 String message saying: The cash model does not allow shorting More...
 
static string InvalidSecurity = $"The security type must be {nameof(SecurityType.Crypto)}or {nameof(SecurityType.Forex)}."
 String message saying: The security type must be Crypto or Forex More...
 

Detailed Description

Provides user-facing messages for the Securities.CashBuyingPowerModel class and its consumers or related classes

Definition at line 328 of file Messages.Securities.cs.

Member Function Documentation

◆ UnsupportedSecurity()

static string QuantConnect.Messages.CashBuyingPowerModel.UnsupportedSecurity ( Securities.Security  security)
static

Returns a string message saying: The security is not supported by this cash model. It also mentioned that currently just crypt and forex securities are supported

Definition at line 357 of file Messages.Securities.cs.

Here is the caller graph for this function:

◆ SellOrderShortHoldingsNotSupported()

static string QuantConnect.Messages.CashBuyingPowerModel.SellOrderShortHoldingsNotSupported ( decimal  totalQuantity,
decimal  openOrdersReservedQuantity,
decimal  orderQuantity,
IBaseCurrencySymbol  baseCurrency 
)
static

Returns a string message saying Cash Modeling trading does not permit short holdings as well as portfolio holdings and an advise to ensure the user is selling only what it has

Definition at line 368 of file Messages.Securities.cs.

Here is the caller graph for this function:

◆ BuyOrderQuantityGreaterThanMaxForBuyingPower()

static string QuantConnect.Messages.CashBuyingPowerModel.BuyOrderQuantityGreaterThanMaxForBuyingPower ( decimal  totalQuantity,
decimal  maximumQuantity,
decimal  openOrdersReservedQuantity,
decimal  orderQuantity,
IBaseCurrencySymbol  baseCurrency,
Securities.Security  security,
Orders.Order  order 
)
static

Returns a string message containing the portfolio holdings, the buy order and the maximum buying power

Definition at line 382 of file Messages.Securities.cs.

Here is the caller graph for this function:

◆ NoDataInInternalCashFeedYet()

static string QuantConnect.Messages.CashBuyingPowerModel.NoDataInInternalCashFeedYet ( Securities.Security  security,
Securities.SecurityPortfolioManager  portfolio 
)
static

Returns a string message saying the internal cash feed required for converting the quote currency, from the given security, to the target account currency, from the given portfolio, does not have any data

Definition at line 399 of file Messages.Securities.cs.

Here is the caller graph for this function:

◆ ZeroContractMultiplier()

static string QuantConnect.Messages.CashBuyingPowerModel.ZeroContractMultiplier ( Securities.Security  security)
static

Returns a string mesasge saying the contract multiplier for the given security is zero

Definition at line 409 of file Messages.Securities.cs.

Here is the caller graph for this function:

◆ OrderQuantityLessThanLotSize()

static string QuantConnect.Messages.CashBuyingPowerModel.OrderQuantityLessThanLotSize ( Securities.Security  security)
static

Returns a string message saying the order quantity is less than the lot size for the given security

Definition at line 419 of file Messages.Securities.cs.

Here is the caller graph for this function:

◆ OrderQuantityLessThanLotSizeOrderDetails()

static string QuantConnect.Messages.CashBuyingPowerModel.OrderQuantityLessThanLotSizeOrderDetails ( decimal  targetOrderValue,
decimal  orderQuantity,
decimal  orderFees 
)
static

Returns a string message containing information about the target order value, the order fees and the order quantity

Definition at line 430 of file Messages.Securities.cs.

Here is the caller graph for this function:

◆ FailedToConvergeOnTargetOrderValue()

static string QuantConnect.Messages.CashBuyingPowerModel.FailedToConvergeOnTargetOrderValue ( decimal  targetOrderValue,
decimal  currentOrderValue,
decimal  orderQuantity,
decimal  orderFees,
Securities.Security  security 
)
static

Returns a string message saying GetMaximumOrderQuantityForTargetBuyingPower failed to converge to the given target order value

Definition at line 440 of file Messages.Securities.cs.

Here is the caller graph for this function:

Member Data Documentation

◆ UnsupportedLeverage

string QuantConnect.Messages.CashBuyingPowerModel.UnsupportedLeverage = "CashBuyingPowerModel does not allow setting leverage. Cash accounts have no leverage."
static

String message saying: CashBuyingPowerModel does not allow setting leverage. Cash accounts have no leverage

Definition at line 333 of file Messages.Securities.cs.

◆ GetMaximumOrderQuantityForDeltaBuyingPowerNotImplemented

string QuantConnect.Messages.CashBuyingPowerModel.GetMaximumOrderQuantityForDeltaBuyingPowerNotImplemented
static
Initial value:
=
$@"The {nameof(CashBuyingPowerModel)} does not require '{
nameof(Securities.CashBuyingPowerModel.GetMaximumOrderQuantityForDeltaBuyingPower)}'."

String message saying: The CashBuyingPowerModel does not require GetMaximumOrderQuantityForDeltaBuyingPower

Definition at line 338 of file Messages.Securities.cs.

◆ ShortingNotSupported

string QuantConnect.Messages.CashBuyingPowerModel.ShortingNotSupported = "The cash model does not allow shorting."
static

String message saying: The cash model does not allow shorting

Definition at line 345 of file Messages.Securities.cs.

◆ InvalidSecurity

string QuantConnect.Messages.CashBuyingPowerModel.InvalidSecurity = $"The security type must be {nameof(SecurityType.Crypto)}or {nameof(SecurityType.Forex)}."
static

String message saying: The security type must be Crypto or Forex

Definition at line 350 of file Messages.Securities.cs.


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