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

Static Public Member Functions
static string	DownloadDataFailed (string url)
	Returns a string message saying the process of downloading data from the given url failed More...

static string	ZeroPriceForSecurity (QuantConnect.Symbol symbol)
	Returns a string message saying the security does not have an accurate price as it has not yet received a bar of data, as well as some recommendations More...

static string	WaitingForThreadToStopSafely (string threadName)
	Returns a string message saying: Waiting for the given thread to stop More...

static string	TimeoutWaitingForThreadToStopSafely (string threadName)
	Returns a string message saying: Timeout waiting for the given thread to stop More...

static string	DataTypeMissingParameterlessConstructor (Type type)
	Returns a string message saying the given data type is missing a parameterless constructor More...

static string	FailedToCreateInstanceOfType (Type type)
	Returns a string message saying the process of creating an instance of the given type failed More...

static string	TypeIsNotBaseData (Type type)
	Returns a string message saying the given data type does not inherit the required BaseData methods and/or attributes More...

static string	CannotCastNonFiniteFloatingPointValueToDecimal (double input)
	Returns a string message saying it is impossible to cast the given non-finite floating-point value as a decimal More...

static string	UnableToConvertTimeSpanToResolution (TimeSpan timeSpan)
	Returns a string message saying it was not able to exactly convert the given time span to resolution More...

static string	UnableToParseUnknownSecurityType (string value)
	Returns a string message saying it was attempted to parse the given unknown security type More...

static string	NoDefaultOptionStyleForSecurityType (SecurityType securityType)
	Returns a string message saying the given security type has no default OptionStyle, because it has no options available for it More...

static string	UnknownOptionStyle (string value)
	Returns a string message saying the given OptionStyle was unexpected/unknown More...

static string	UnknownOptionStyle (OptionStyle value)
	Returns a string message saying the given OptionStyle was unexpected/unknown More...

static string	UnknownOptionRight (string value)
	Returns a string message saying the given OptionRight was unexpected/unknown More...

static string	UnknownOptionRight (OptionRight value)
	Returns a string message saying the given OptionRight was unexpected/unknown More...

static string	UnknownDataMappingMode (string value)
	Returns a string message saying the given DataMappingMode was unexpected/unknown More...

static string	ConvertToDelegateCannotConverPyObjectToType (string methodName, Type type)
	Returns a string message saying the given method cannot be used to convert a PyObject into the given type More...

static string	ConvertToDictionaryFailed (string sourceType, string targetType, string reason)
	Returns a string message saying the method ConvertToDictionary cannot be used to convert a given source type into another given target type. It also specifies the reason. More...

static string	ConvertToSymbolEnumerableFailed (PyObject item)
	Returns a string message saying the given argument type should Symbol or a list of Symbol. It also shows the given item as well as its Python type More...

static string	ObjectFromPythonIsNotACSharpType (string objectRepr)
	Returns a string message saying the given object is not a C# type More...

static string	RuntimeError (IAlgorithm algorithm, string context)
	Returns a string message saying there was a RuntimeError at a given time in UTC. It also shows the given context More...

Static Public Attributes
static string	ErrorAdjustingSymbolByOffset
	Returns a string message saying adjusting a symbol by an offset is currently only supported for non canonical futures More...

static string	NullDataProvider
	Returns a string message saying the provided DataProvider instance is null More...

static string	NullOrEmptySourceToConvertToHexString = "Source cannot be null or empty."
	Returns a string message saying the source cannot be null or empty More...

static string	CreateOptionChainRequiresOptionSymbol = "CreateOptionChain requires an option symbol."
	Returns a string message saying the CreateOptionChain method requires an option symbol More...

static string	CreateFutureChainRequiresFutureSymbol = "CreateFutureChain requires a future symbol."
	Returns a string message saying the CreateFutureChain method requires a future symbol More...

static string	GreatestCommonDivisorEmptyList = "The list of values cannot be empty"
	Returns a string message saying the list of values cannot be empty More...

Detailed Description

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

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

Member Function Documentation

◆ DownloadDataFailed()

static string QuantConnect.Messages.Extensions.DownloadDataFailed ( string url )

static

Returns a string message saying the process of downloading data from the given url failed

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

◆ ZeroPriceForSecurity()

static string QuantConnect.Messages.Extensions.ZeroPriceForSecurity ( QuantConnect.Symbol symbol )

static

Returns a string message saying the security does not have an accurate price as it has not yet received a bar of data, as well as some recommendations

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

Here is the caller graph for this function:

◆ WaitingForThreadToStopSafely()

static string QuantConnect.Messages.Extensions.WaitingForThreadToStopSafely ( string threadName )

static

Returns a string message saying: Waiting for the given thread to stop

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

◆ TimeoutWaitingForThreadToStopSafely()

static string QuantConnect.Messages.Extensions.TimeoutWaitingForThreadToStopSafely ( string threadName )

static

Returns a string message saying: Timeout waiting for the given thread to stop

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

◆ DataTypeMissingParameterlessConstructor()

static string QuantConnect.Messages.Extensions.DataTypeMissingParameterlessConstructor ( Type type )

static

Returns a string message saying the given data type is missing a parameterless constructor

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

Here is the caller graph for this function:

◆ FailedToCreateInstanceOfType()

static string QuantConnect.Messages.Extensions.FailedToCreateInstanceOfType ( Type type )

static

Returns a string message saying the process of creating an instance of the given type failed

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

Here is the caller graph for this function:

◆ TypeIsNotBaseData()

static string QuantConnect.Messages.Extensions.TypeIsNotBaseData ( Type type )

static

Returns a string message saying the given data type does not inherit the required BaseData methods and/or attributes

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

Here is the caller graph for this function:

◆ CannotCastNonFiniteFloatingPointValueToDecimal()

static string QuantConnect.Messages.Extensions.CannotCastNonFiniteFloatingPointValueToDecimal ( double input )

static

Returns a string message saying it is impossible to cast the given non-finite floating-point value as a decimal

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

Here is the caller graph for this function:

◆ UnableToConvertTimeSpanToResolution()

static string QuantConnect.Messages.Extensions.UnableToConvertTimeSpanToResolution ( TimeSpan timeSpan )

static

Returns a string message saying it was not able to exactly convert the given time span to resolution

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

Here is the caller graph for this function:

◆ UnableToParseUnknownSecurityType()

static string QuantConnect.Messages.Extensions.UnableToParseUnknownSecurityType ( string value )

static

Returns a string message saying it was attempted to parse the given unknown security type

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

◆ NoDefaultOptionStyleForSecurityType()

static string QuantConnect.Messages.Extensions.NoDefaultOptionStyleForSecurityType ( SecurityType securityType )

static

Returns a string message saying the given security type has no default OptionStyle, because it has no options available for it

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

Here is the caller graph for this function:

◆ UnknownOptionStyle() [1/2]

static string QuantConnect.Messages.Extensions.UnknownOptionStyle ( string value )

static

Returns a string message saying the given OptionStyle was unexpected/unknown

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

Here is the caller graph for this function:

◆ UnknownOptionStyle() [2/2]

static string QuantConnect.Messages.Extensions.UnknownOptionStyle ( OptionStyle value )

static

Returns a string message saying the given OptionStyle was unexpected/unknown

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

◆ UnknownOptionRight() [1/2]

static string QuantConnect.Messages.Extensions.UnknownOptionRight ( string value )

static

Returns a string message saying the given OptionRight was unexpected/unknown

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

Here is the caller graph for this function:

◆ UnknownOptionRight() [2/2]

static string QuantConnect.Messages.Extensions.UnknownOptionRight ( OptionRight value )

static

Returns a string message saying the given OptionRight was unexpected/unknown

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

◆ UnknownDataMappingMode()

static string QuantConnect.Messages.Extensions.UnknownDataMappingMode ( string value )

static

Returns a string message saying the given DataMappingMode was unexpected/unknown

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

Here is the caller graph for this function:

◆ ConvertToDelegateCannotConverPyObjectToType()

static string QuantConnect.Messages.Extensions.ConvertToDelegateCannotConverPyObjectToType	(	string	methodName,
		Type	type
	)

static

Returns a string message saying the given method cannot be used to convert a PyObject into the given type

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

Here is the caller graph for this function:

◆ ConvertToDictionaryFailed()

static string QuantConnect.Messages.Extensions.ConvertToDictionaryFailed	(	string	sourceType,
		string	targetType,
		string	reason
	)

static

Returns a string message saying the method ConvertToDictionary cannot be used to convert a given source type into another given target type. It also specifies the reason.

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

Here is the caller graph for this function:

◆ ConvertToSymbolEnumerableFailed()

static string QuantConnect.Messages.Extensions.ConvertToSymbolEnumerableFailed ( PyObject item )

static

Returns a string message saying the given argument type should Symbol or a list of Symbol. It also shows the given item as well as its Python type

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

◆ ObjectFromPythonIsNotACSharpType()

static string QuantConnect.Messages.Extensions.ObjectFromPythonIsNotACSharpType ( string objectRepr )

static

Returns a string message saying the given object is not a C# type

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

◆ RuntimeError()

static string QuantConnect.Messages.Extensions.RuntimeError	(	IAlgorithm	algorithm,
		string	context
	)

static

Returns a string message saying there was a RuntimeError at a given time in UTC. It also shows the given context

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

Member Data Documentation

◆ ErrorAdjustingSymbolByOffset

string QuantConnect.Messages.Extensions.ErrorAdjustingSymbolByOffset

static

Initial value:

=

"Adjusting a symbol by an offset is currently only supported for non canonical futures"

Returns a string message saying adjusting a symbol by an offset is currently only supported for non canonical futures

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

◆ NullDataProvider

string QuantConnect.Messages.Extensions.NullDataProvider

static

Initial value:

=

$"The provided '{nameof(IDataProvider)}' instance is null. Are you missing some initialization step?"

Returns a string message saying the provided DataProvider instance is null

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

◆ NullOrEmptySourceToConvertToHexString

string QuantConnect.Messages.Extensions.NullOrEmptySourceToConvertToHexString = "Source cannot be null or empty."

static

Returns a string message saying the source cannot be null or empty

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

◆ CreateOptionChainRequiresOptionSymbol

string QuantConnect.Messages.Extensions.CreateOptionChainRequiresOptionSymbol = "CreateOptionChain requires an option symbol."

static

Returns a string message saying the CreateOptionChain method requires an option symbol

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

◆ CreateFutureChainRequiresFutureSymbol

string QuantConnect.Messages.Extensions.CreateFutureChainRequiresFutureSymbol = "CreateFutureChain requires a future symbol."

static

Returns a string message saying the CreateFutureChain method requires a future symbol

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

◆ GreatestCommonDivisorEmptyList

string QuantConnect.Messages.Extensions.GreatestCommonDivisorEmptyList = "The list of values cannot be empty"

static

Returns a string message saying the list of values cannot be empty

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

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

Common/Messages/Messages.QuantConnect.cs

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ DownloadDataFailed()

◆ ZeroPriceForSecurity()

◆ WaitingForThreadToStopSafely()

◆ TimeoutWaitingForThreadToStopSafely()

◆ DataTypeMissingParameterlessConstructor()

◆ FailedToCreateInstanceOfType()

◆ TypeIsNotBaseData()

◆ CannotCastNonFiniteFloatingPointValueToDecimal()

◆ UnableToConvertTimeSpanToResolution()

◆ UnableToParseUnknownSecurityType()

◆ NoDefaultOptionStyleForSecurityType()

◆ UnknownOptionStyle() [1/2]

◆ UnknownOptionStyle() [2/2]

◆ UnknownOptionRight() [1/2]

◆ UnknownOptionRight() [2/2]

◆ UnknownDataMappingMode()

◆ ConvertToDelegateCannotConverPyObjectToType()

◆ ConvertToDictionaryFailed()

◆ ConvertToSymbolEnumerableFailed()

◆ ObjectFromPythonIsNotACSharpType()

◆ RuntimeError()

Member Data Documentation

◆ ErrorAdjustingSymbolByOffset

◆ NullDataProvider

◆ NullOrEmptySourceToConvertToHexString

◆ CreateOptionChainRequiresOptionSymbol

◆ CreateFutureChainRequiresFutureSymbol

◆ GreatestCommonDivisorEmptyList