Represents a chain universe. Intended as a base for options and futures universe data. More...

Inheritance diagram for QuantConnect.Data.UniverseSelection.BaseChainUniverseData:

Public Member Functions
override SubscriptionDataSource	GetSource (SubscriptionDataConfig config, DateTime date, bool isLiveMode)
	Return the URL string source of the file. This will be converted to a stream More...

override Resolution	DefaultResolution ()
	Gets the default resolution for this data and security type More...

Symbol	ToSymbol ()
	Gets the symbol of the option More...

Public Member Functions inherited from QuantConnect.Data.UniverseSelection.BaseDataCollection
	BaseDataCollection ()
	Initializes a new default instance of the BaseDataCollection c;ass More...

	BaseDataCollection (DateTime time, Symbol symbol, IEnumerable< BaseData > data=null)
	Initializes a new instance of the BaseDataCollection class More...

	BaseDataCollection (DateTime time, DateTime endTime, Symbol symbol, IEnumerable< BaseData > data=null, BaseData underlying=null, HashSet< Symbol > filteredContracts=null)
	Initializes a new instance of the BaseDataCollection class More...

	BaseDataCollection (DateTime time, DateTime endTime, Symbol symbol, List< BaseData > data, BaseData underlying, HashSet< Symbol > filteredContracts)
	Initializes a new instance of the BaseDataCollection class More...

	BaseDataCollection (BaseDataCollection other)
	Copy constructor for BaseDataCollection More...

virtual Symbol	UniverseSymbol (string market=null)
	Creates the universe symbol for the target market More...

override bool	ShouldCacheToSecurity ()
	Indicates whether this contains data that should be stored in the security cache More...

virtual void	Add (BaseData newDataPoint)
	Adds a new data point to this collection More...

virtual void	AddRange (IEnumerable< BaseData > newDataPoints)
	Adds a new data points to this collection More...

override BaseData	Clone ()
	Return a new instance clone of this object, used in fill forward More...

IEnumerator< BaseData >	GetEnumerator ()
	Returns an IEnumerator for this enumerable Object. The enumerator provides a simple way to access all the contents of a collection. More...

Public Member Functions inherited from QuantConnect.Data.BaseData
	BaseData ()
	Constructor for initialising the dase data class More...

virtual BaseData	Reader (SubscriptionDataConfig config, string line, DateTime date, bool isLiveMode)
	Reader converts each line of the data source into BaseData objects. Each data type creates its own factory method, and returns a new instance of the object each time it is called. The returned object is assumed to be time stamped in the config.ExchangeTimeZone. More...

virtual BaseData	Reader (SubscriptionDataConfig config, StreamReader stream, DateTime date, bool isLiveMode)
	Reader converts each line of the data source into BaseData objects. Each data type creates its own factory method, and returns a new instance of the object each time it is called. The returned object is assumed to be time stamped in the config.ExchangeTimeZone. More...

virtual bool	RequiresMapping ()
	Indicates if there is support for mapping More...

virtual bool	IsSparseData ()
	Indicates that the data set is expected to be sparse More...

virtual List< Resolution >	SupportedResolutions ()
	Gets the supported resolution for this data and security type More...

virtual DateTimeZone	DataTimeZone ()
	Specifies the data time zone for this data type. This is useful for custom data types More...

void	UpdateTrade (decimal lastTrade, decimal tradeSize)
	Updates this base data with a new trade More...

void	UpdateQuote (decimal bidPrice, decimal bidSize, decimal askPrice, decimal askSize)
	Updates this base data with new quote information More...

void	UpdateBid (decimal bidPrice, decimal bidSize)
	Updates this base data with the new quote bid information More...

void	UpdateAsk (decimal askPrice, decimal askSize)
	Updates this base data with the new quote ask information More...

virtual void	Update (decimal lastTrade, decimal bidPrice, decimal askPrice, decimal volume, decimal bidSize, decimal askSize)
	Update routine to build a bar/tick from a data update. More...

virtual BaseData	Clone (bool fillForward)
	Return a new instance clone of this object, used in fill forward More...

override string	ToString ()
	Formats a string with the symbol and value. More...

virtual BaseData	Reader (SubscriptionDataConfig config, string line, DateTime date, DataFeedEndpoint dataFeed)
	Reader converts each line of the data source into BaseData objects. Each data type creates its own factory method, and returns a new instance of the object each time it is called. More...

virtual string	GetSource (SubscriptionDataConfig config, DateTime date, DataFeedEndpoint datafeed)
	Return the URL string source of the file. This will be converted to a stream More...

Static Public Member Functions
static string	GetUniverseFullFilePath (Symbol symbol, DateTime date)
	Generates the file path for a universe data file based on the given symbol and date. Optionally, creates the directory if it does not exist. More...

Static Public Member Functions inherited from QuantConnect.Data.BaseData
static IEnumerable< BaseData >	DeserializeMessage (string serialized)
	Deserialize the message from the data server More...

Public Attributes
SecurityIdentifier	ID => Symbol.ID
	The security identifier of the option symbol More...

override decimal	Value => Close
	Price of the security More...

Public Attributes inherited from QuantConnect.Data.BaseData
virtual decimal	Price => Value
	As this is a backtesting platform we'll provide an alias of value as price. More...

Protected Member Functions
	BaseChainUniverseData ()
	Creates a new instance of the BaseChainUniverseData class More...

	BaseChainUniverseData (DateTime date, Symbol symbol, string csv)
	Creates a new instance of the BaseChainUniverseData class More...

	BaseChainUniverseData (BaseChainUniverseData other)
	Creates a new instance of the BaseChainUniverseData class as a copy of the given instance More...

Protected Member Functions inherited from QuantConnect.Data.UniverseSelection.BaseDataCollection
	BaseDataCollection (DateTime time, DateTime endTime, Symbol symbol, BaseData underlying, HashSet< Symbol > filteredContracts)
	Helper method to create an instance without setting the data list More...

Static Protected Member Functions
static bool	TryRead (SubscriptionDataConfig config, StreamReader stream, DateTime date, out Symbol symbol, out string remainingLine)
	Reader converts each line of the data source into BaseData objects. Each data type creates its own factory method, and returns a new instance of the object each time it is called. More...

Static Protected Member Functions inherited from QuantConnect.Data.UniverseSelection.BaseDataCollection
static bool	TryGetCachedSymbol (string ticker, out Symbol symbol)
	Tries to get a symbol from the cache More...

static void	CacheSymbol (string ticker, Symbol symbol)
	Caches a symbol More...

Properties
string	CsvLine `[get]`
	Csv line to get the values from More...

decimal	Open `[get]`
	Open price of the security More...

decimal	High `[get]`
	High price of the security More...

decimal	Low `[get]`
	Low price of the security More...

decimal	Close `[get]`
	Close price of the security More...

decimal	Volume `[get]`
	Volume value of the security More...

virtual decimal	OpenInterest `[get]`
	Open interest value More...

override DateTime	EndTime `[get, set]`
	Time that the data became available to use More...

Properties inherited from QuantConnect.Data.UniverseSelection.BaseDataCollection
BaseData	Underlying `[get, set]`
	The associated underlying price data if any More...

HashSet< Symbol >	FilteredContracts `[get, set]`
	Gets or sets the contracts selected by the universe More...

List< BaseData >	Data `[get, set]`
	Gets the data list More...

override DateTime	EndTime `[get, set]`
	Gets or sets the end time of this data More...

Properties inherited from QuantConnect.Data.BaseData
MarketDataType	DataType = MarketDataType.Base `[get, set]`
	Market Data Type of this data - does it come in individual price packets or is it grouped into OHLC. More...

bool	IsFillForward `[get]`
	True if this is a fill forward piece of data More...

DateTime	Time `[get, set]`
	Current time marker of this data packet. More...

virtual DateTime	EndTime `[get, set]`
	The end time of this data. Some data covers spans (trade bars) and as such we want to know the entire time span covered More...

Symbol	Symbol = Symbol.Empty `[get, set]`
	Symbol representation for underlying Security More...

virtual decimal	Value `[get, set]`
	Value representation of this data packet. All data requires a representative value for this moment in time. For streams of data this is the price now, for OHLC packets this is the closing price. More...

Properties inherited from QuantConnect.Data.IBaseData
MarketDataType	DataType `[get, set]`
	Market Data Type of this data - does it come in individual price packets or is it grouped into OHLC. More...

DateTime	Time `[get, set]`
	Time keeper of data – all data is timeseries based. More...

DateTime	EndTime `[get, set]`
	End time of data More...

decimal	Value `[get, set]`
	All timeseries data is a time-value pair: More...

decimal	Price `[get]`
	Alias of Value. More...

Properties inherited from QuantConnect.Data.ISymbolProvider
Symbol	Symbol `[get, set]`
	Gets the Symbol More...

Properties inherited from QuantConnect.Securities.IChainUniverseData
SecurityIdentifier	ID `[get]`
	Gets the security identifier. More...

Additional Inherited Members
Static Protected Attributes inherited from QuantConnect.Data.BaseData
static readonly List< Resolution >	AllResolutions
	A list of all Resolution More...

static readonly List< Resolution >	DailyResolution = new List<Resolution> { Resolution.Daily }
	A list of Resolution.Daily More...

static readonly List< Resolution >	MinuteResolution = new List<Resolution> { Resolution.Minute }
	A list of Resolution.Minute More...

static readonly List< Resolution >	HighResolution = new List<Resolution> { Resolution.Minute, Resolution.Second, Resolution.Tick }
	A list of high Resolution, including minute, second, and tick. More...

static readonly List< Resolution >	OptionResolutions = new List<Resolution> { Resolution.Daily, Resolution.Hour, Resolution.Minute }
	A list of resolutions support by Options More...

Detailed Description

Represents a chain universe. Intended as a base for options and futures universe data.

Definition at line 28 of file BaseChainUniverseData.cs.

Constructor & Destructor Documentation

◆ BaseChainUniverseData() [1/3]

QuantConnect.Data.UniverseSelection.BaseChainUniverseData.BaseChainUniverseData ( )

protected

Creates a new instance of the BaseChainUniverseData class

Definition at line 127 of file BaseChainUniverseData.cs.

◆ BaseChainUniverseData() [2/3]

QuantConnect.Data.UniverseSelection.BaseChainUniverseData.BaseChainUniverseData	(	DateTime	date,
		Symbol	symbol,
		string	csv
	)

protected

Creates a new instance of the BaseChainUniverseData class

Definition at line 134 of file BaseChainUniverseData.cs.

◆ BaseChainUniverseData() [3/3]

QuantConnect.Data.UniverseSelection.BaseChainUniverseData.BaseChainUniverseData ( BaseChainUniverseData other )

protected

Creates a new instance of the BaseChainUniverseData class as a copy of the given instance

Definition at line 143 of file BaseChainUniverseData.cs.

Member Function Documentation

◆ GetSource()

override SubscriptionDataSource QuantConnect.Data.UniverseSelection.BaseChainUniverseData.GetSource	(	SubscriptionDataConfig	config,
		DateTime	date,
		bool	isLiveMode
	)

virtual

Return the URL string source of the file. This will be converted to a stream

Parameters

config	Configuration object
date	Date of this source file
isLiveMode	true if we're in live mode, false for backtesting mode

Returns: String URL of source file.

Reimplemented from QuantConnect.Data.BaseData.

Definition at line 156 of file BaseChainUniverseData.cs.

Here is the call graph for this function:

◆ GetUniverseFullFilePath()

static string QuantConnect.Data.UniverseSelection.BaseChainUniverseData.GetUniverseFullFilePath	(	Symbol	symbol,
		DateTime	date
	)

static

Generates the file path for a universe data file based on the given symbol and date. Optionally, creates the directory if it does not exist.

Parameters

symbol	The financial symbol for which the universe file is generated.
date	The date associated with the universe file.

Returns: The full file path to the universe data file.

Definition at line 169 of file BaseChainUniverseData.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TryRead()

static bool QuantConnect.Data.UniverseSelection.BaseChainUniverseData.TryRead	(	SubscriptionDataConfig	config,
		StreamReader	stream,
		DateTime	date,
		out Symbol	symbol,
		out string	remainingLine
	)

staticprotected

Reader converts each line of the data source into BaseData objects. Each data type creates its own factory method, and returns a new instance of the object each time it is called.

Parameters

config	Subscription data config setup object
stream	Stream reader of the source document
date	Date of the requested data
symbol	The symbol read and parsed from the current line in the stream
remainingLine	The remaining string after reading the symbol from the current line in the stream

Returns: Whether a valid line starting with a symbol was read

Definition at line 184 of file BaseChainUniverseData.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DefaultResolution()

override Resolution QuantConnect.Data.UniverseSelection.BaseChainUniverseData.DefaultResolution ( )

virtual

Gets the default resolution for this data and security type

This is a method and not a property so that python custom data types can override it

Reimplemented from QuantConnect.Data.BaseData.

Reimplemented in QuantConnect.Data.UniverseSelection.FutureUniverse.

Definition at line 242 of file BaseChainUniverseData.cs.

◆ ToSymbol()

Symbol QuantConnect.Data.UniverseSelection.BaseChainUniverseData.ToSymbol ( )

Gets the symbol of the option

Definition at line 250 of file BaseChainUniverseData.cs.

Member Data Documentation

◆ ID

SecurityIdentifier QuantConnect.Data.UniverseSelection.BaseChainUniverseData.ID => Symbol.ID

The security identifier of the option symbol

Definition at line 40 of file BaseChainUniverseData.cs.

◆ Value

override decimal QuantConnect.Data.UniverseSelection.BaseChainUniverseData.Value => Close

Price of the security

Definition at line 46 of file BaseChainUniverseData.cs.

Property Documentation

◆ CsvLine

string QuantConnect.Data.UniverseSelection.BaseChainUniverseData.CsvLine

getprotected

Csv line to get the values from

We keep the properties as they are in the csv file to reduce memory usage (strings vs decimals)

Definition at line 34 of file BaseChainUniverseData.cs.

◆ Open

decimal QuantConnect.Data.UniverseSelection.BaseChainUniverseData.Open

get

Open price of the security

Definition at line 52 of file BaseChainUniverseData.cs.

◆ High

decimal QuantConnect.Data.UniverseSelection.BaseChainUniverseData.High

get

High price of the security

Definition at line 64 of file BaseChainUniverseData.cs.

◆ Low

decimal QuantConnect.Data.UniverseSelection.BaseChainUniverseData.Low

get

Low price of the security

Definition at line 75 of file BaseChainUniverseData.cs.

◆ Close

decimal QuantConnect.Data.UniverseSelection.BaseChainUniverseData.Close

get

Close price of the security

Definition at line 86 of file BaseChainUniverseData.cs.

◆ Volume

decimal QuantConnect.Data.UniverseSelection.BaseChainUniverseData.Volume

get

Volume value of the security

Definition at line 97 of file BaseChainUniverseData.cs.

◆ OpenInterest

virtual decimal QuantConnect.Data.UniverseSelection.BaseChainUniverseData.OpenInterest

get

Open interest value

Definition at line 108 of file BaseChainUniverseData.cs.

◆ EndTime

override DateTime QuantConnect.Data.UniverseSelection.BaseChainUniverseData.EndTime

getset

Time that the data became available to use

Definition at line 119 of file BaseChainUniverseData.cs.

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

Common/Data/UniverseSelection/BaseChainUniverseData.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseChainUniverseData() [1/3]

◆ BaseChainUniverseData() [2/3]

◆ BaseChainUniverseData() [3/3]

Member Function Documentation

◆ GetSource()

◆ GetUniverseFullFilePath()

◆ TryRead()

◆ DefaultResolution()

◆ ToSymbol()

Member Data Documentation

◆ ID

◆ Value

Property Documentation

◆ CsvLine

◆ Open

◆ High

◆ Low

◆ Close

◆ Volume

◆ OpenInterest

◆ EndTime