Lean  $LEAN_TAG$
Static Public Member Functions | Static Public Attributes | List of all members
QuantConnect.Messages.Symbol Class Reference

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

Static Public Member Functions

static string SecurityTypeNotImplementedYet (SecurityType securityType)
 Returns a string message saying the given security type has not been implemented yet More...
 
static string SecurityTypeCannotBeMapped (SecurityType securityType)
 Returns a string message saying the given security can not be mapped More...
 
static string NoOptionTypeForUnderlying (SecurityType securityType)
 Returns a string message saying no option type exists for the given underlying SecurityType More...
 
static string NoUnderlyingForOption (SecurityType securityType)
 Returns a string message saying no underlying type exists for the given option SecurityType More...
 
static string SidNotForOption (QuantConnect.SecurityIdentifier sid)
 
static string UnderlyingSidDoesNotMatch (QuantConnect.SecurityIdentifier sid, QuantConnect.Symbol underlying)
 

Static Public Attributes

static string InsufficientInformationToCreateFutureOptionSymbol
 Returns a string message saying there is insufficient information for creating certain future option symbol More...
 
static string CanonicalNotDefined
 Returns a string message saying Canonical is only defined for SecurityType.Option, SecurityType.Future, SecurityType.FutureOption More...
 
static string UnexpectedObjectTypeToCompareTo = "Object must be of type Symbol or string."
 Returns a string message saying certain object must be of type Symbol or string More...
 

Detailed Description

Provides user-facing messages for the QuantConnect.Symbol class and its consumers or related classes

Definition at line 754 of file Messages.QuantConnect.cs.

Member Function Documentation

◆ SecurityTypeNotImplementedYet()

static string QuantConnect.Messages.Symbol.SecurityTypeNotImplementedYet ( SecurityType  securityType)
static

Returns a string message saying the given security type has not been implemented yet

Definition at line 777 of file Messages.QuantConnect.cs.

Here is the caller graph for this function:

◆ SecurityTypeCannotBeMapped()

static string QuantConnect.Messages.Symbol.SecurityTypeCannotBeMapped ( SecurityType  securityType)
static

Returns a string message saying the given security can not be mapped

Definition at line 786 of file Messages.QuantConnect.cs.

Here is the caller graph for this function:

◆ NoOptionTypeForUnderlying()

static string QuantConnect.Messages.Symbol.NoOptionTypeForUnderlying ( SecurityType  securityType)
static

Returns a string message saying no option type exists for the given underlying SecurityType

Definition at line 795 of file Messages.QuantConnect.cs.

Here is the caller graph for this function:

◆ NoUnderlyingForOption()

static string QuantConnect.Messages.Symbol.NoUnderlyingForOption ( SecurityType  securityType)
static

Returns a string message saying no underlying type exists for the given option SecurityType

Definition at line 804 of file Messages.QuantConnect.cs.

Here is the caller graph for this function:

Member Data Documentation

◆ InsufficientInformationToCreateFutureOptionSymbol

string QuantConnect.Messages.Symbol.InsufficientInformationToCreateFutureOptionSymbol
static
Initial value:
=
"Cannot create future option Symbol using this method (insufficient information). Use `CreateOption(Symbol, ...)` instead."

Returns a string message saying there is insufficient information for creating certain future option symbol

Definition at line 759 of file Messages.QuantConnect.cs.

◆ CanonicalNotDefined

string QuantConnect.Messages.Symbol.CanonicalNotDefined
static
Initial value:
=
"Canonical is only defined for SecurityType.Option, SecurityType.Future, SecurityType.FutureOption"

Returns a string message saying Canonical is only defined for SecurityType.Option, SecurityType.Future, SecurityType.FutureOption

Definition at line 765 of file Messages.QuantConnect.cs.

◆ UnexpectedObjectTypeToCompareTo

string QuantConnect.Messages.Symbol.UnexpectedObjectTypeToCompareTo = "Object must be of type Symbol or string."
static

Returns a string message saying certain object must be of type Symbol or string

Definition at line 771 of file Messages.QuantConnect.cs.

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