Lean  $LEAN_TAG$
QuantConnect.Messages.SecurityIdentifier Class Reference

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

Static Public Member Functions

static string InvalidSecurityType (string parameterName)
 Returns a string message saying the given parameter must be between 0 and 99 More...
 
static string InvalidOptionRight (string parameterName)
 Returns a string message saying the given parameter must be either 0 or 1 More...
 
static string InvalidStrikePrice (decimal strikePrice)
 Returns a string message saying the specified strike price's precision is too high More...
 
static string ErrorParsingSecurityIdentifier (string value, Exception exception)
 Returns a string message saying there was an error parsing SecurityIdentifier. It also says the given error and exception More...
 
static string MarketNotFound (string market)
 Returns a string message saying the given market could not be found in the markets lookup More...
 

Static Public Attributes

static string NoUnderlyingForIdentifier
 Returns a string message saying no underlying was specified for certain identifier More...
 
static string DateNotSupportedBySecurityType
 Returns a string message saying Date is only defined for SecurityType.Equity, SecurityType.Option, SecurityType.Future, SecurityType.FutureOption, SecurityType.IndexOption, and SecurityType.Base More...
 
static string StrikePriceNotSupportedBySecurityType
 Returns a string message saying StrikePrice is only defined for SecurityType.Option, SecurityType.FutureOption, and SecurityType.IndexOption More...
 
static string OptionRightNotSupportedBySecurityType
 Returns a string message saying OptionRight is only defined for SecurityType.Option, SecurityType.FutureOption, and SecurityType.IndexOption More...
 
static string OptionStyleNotSupportedBySecurityType
 Returns a string message saying OptionStyle is only defined for SecurityType.Option, SecurityType.FutureOption, and SecurityType.IndexOption More...
 
static string NullSymbol = "SecurityIdentifier requires a non-null string 'symbol'"
 Returns a string message saying SecurityIdentifier requires a non-null string 'symbol' More...
 
static string SymbolWithInvalidCharacters = "Symbol must not contain the characters '|' or ' '."
 Returns a string message saying Symbol must not contain the characters '|' or ' ' More...
 
static string PropertiesDoNotMatchAnySecurityType = $"The provided properties do not match with a valid {nameof(SecurityType)}"
 Returns a string message saying the provided properties do not match with a valid SecurityType More...
 
static string StringIsNotSplittable = "The string must be splittable on space into two parts."
 Returns a string message saying the string must be splittable on space into two parts More...
 
static string UnexpectedTypeToCompareTo = $"Object must be of type {nameof(SecurityIdentifier)}"
 Returns a string message saying object must be of type SecurityIdentifier More...
 

Detailed Description

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

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

Member Function Documentation

◆ InvalidSecurityType()

static string QuantConnect.Messages.SecurityIdentifier.InvalidSecurityType ( string  parameterName)
static

Returns a string message saying the given parameter must be between 0 and 99

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

◆ InvalidOptionRight()

static string QuantConnect.Messages.SecurityIdentifier.InvalidOptionRight ( string  parameterName)
static

Returns a string message saying the given parameter must be either 0 or 1

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

◆ InvalidStrikePrice()

static string QuantConnect.Messages.SecurityIdentifier.InvalidStrikePrice ( decimal  strikePrice)
static

Returns a string message saying the specified strike price's precision is too high

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

◆ ErrorParsingSecurityIdentifier()

static string QuantConnect.Messages.SecurityIdentifier.ErrorParsingSecurityIdentifier ( string  value,
Exception  exception 
)
static

Returns a string message saying there was an error parsing SecurityIdentifier. It also says the given error and exception

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

◆ MarketNotFound()

static string QuantConnect.Messages.SecurityIdentifier.MarketNotFound ( string  market)
static

Returns a string message saying the given market could not be found in the markets lookup

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

Member Data Documentation

◆ NoUnderlyingForIdentifier

string QuantConnect.Messages.SecurityIdentifier.NoUnderlyingForIdentifier
static
Initial value:
=
"No underlying specified for this identifier. Check that HasUnderlying is true before accessing the Underlying property."

Returns a string message saying no underlying was specified for certain identifier

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

◆ DateNotSupportedBySecurityType

string QuantConnect.Messages.SecurityIdentifier.DateNotSupportedBySecurityType
static
Initial value:
=
"Date is only defined for SecurityType.Equity, SecurityType.Option, SecurityType.Future, SecurityType.FutureOption, SecurityType.IndexOption, and SecurityType.Base"

Returns a string message saying Date is only defined for SecurityType.Equity, SecurityType.Option, SecurityType.Future, SecurityType.FutureOption, SecurityType.IndexOption, and SecurityType.Base

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

◆ StrikePriceNotSupportedBySecurityType

string QuantConnect.Messages.SecurityIdentifier.StrikePriceNotSupportedBySecurityType
static
Initial value:
=
"StrikePrice is only defined for SecurityType.Option, SecurityType.FutureOption, and SecurityType.IndexOption"

Returns a string message saying StrikePrice is only defined for SecurityType.Option, SecurityType.FutureOption, and SecurityType.IndexOption

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

◆ OptionRightNotSupportedBySecurityType

string QuantConnect.Messages.SecurityIdentifier.OptionRightNotSupportedBySecurityType
static
Initial value:
=
"OptionRight is only defined for SecurityType.Option, SecurityType.FutureOption, and SecurityType.IndexOption"

Returns a string message saying OptionRight is only defined for SecurityType.Option, SecurityType.FutureOption, and SecurityType.IndexOption

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

◆ OptionStyleNotSupportedBySecurityType

string QuantConnect.Messages.SecurityIdentifier.OptionStyleNotSupportedBySecurityType
static
Initial value:
=
"OptionStyle is only defined for SecurityType.Option, SecurityType.FutureOption, and SecurityType.IndexOption"

Returns a string message saying OptionStyle is only defined for SecurityType.Option, SecurityType.FutureOption, and SecurityType.IndexOption

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

◆ NullSymbol

string QuantConnect.Messages.SecurityIdentifier.NullSymbol = "SecurityIdentifier requires a non-null string 'symbol'"
static

Returns a string message saying SecurityIdentifier requires a non-null string 'symbol'

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

◆ SymbolWithInvalidCharacters

string QuantConnect.Messages.SecurityIdentifier.SymbolWithInvalidCharacters = "Symbol must not contain the characters '|' or ' '."
static

Returns a string message saying Symbol must not contain the characters '|' or ' '

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

◆ PropertiesDoNotMatchAnySecurityType

string QuantConnect.Messages.SecurityIdentifier.PropertiesDoNotMatchAnySecurityType = $"The provided properties do not match with a valid {nameof(SecurityType)}"
static

Returns a string message saying the provided properties do not match with a valid SecurityType

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

◆ StringIsNotSplittable

string QuantConnect.Messages.SecurityIdentifier.StringIsNotSplittable = "The string must be splittable on space into two parts."
static

Returns a string message saying the string must be splittable on space into two parts

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

◆ UnexpectedTypeToCompareTo

string QuantConnect.Messages.SecurityIdentifier.UnexpectedTypeToCompareTo = $"Object must be of type {nameof(SecurityIdentifier)}"
static

Returns a string message saying object must be of type SecurityIdentifier

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


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