Lean  $LEAN_TAG$
QuantConnect.Lean.Engine.DataFeeds.CollectionSubscriptionDataSourceReader Class Reference

Collection Subscription Factory takes a BaseDataCollection from BaseData factories and yields it one point at a time to the algorithm More...

Inheritance diagram for QuantConnect.Lean.Engine.DataFeeds.CollectionSubscriptionDataSourceReader:
[legend]

Public Member Functions

 CollectionSubscriptionDataSourceReader (IDataCacheProvider dataCacheProvider, SubscriptionDataConfig config, DateTime date, bool isLiveMode, IObjectStore objectStore)
 Initializes a new instance of the CollectionSubscriptionDataSourceReader class More...
 
override IEnumerable< BaseDataRead (SubscriptionDataSource source)
 Reads the specified source More...
 

Events

EventHandler< ReaderErrorEventArgsReaderError
 Event fired when an exception is thrown during a call to BaseData.Reader(SubscriptionDataConfig, string, DateTime, bool) More...
 
- Events inherited from QuantConnect.Lean.Engine.DataFeeds.BaseSubscriptionDataSourceReader
EventHandler< InvalidSourceEventArgsInvalidSource
 Event fired when the specified source is considered invalid, this may be from a missing file or failure to download a remote source More...
 
- Events inherited from QuantConnect.Lean.Engine.DataFeeds.ISubscriptionDataSourceReader
EventHandler< InvalidSourceEventArgsInvalidSource
 Event fired when the specified source is considered invalid, this may be from a missing file or failure to download a remote source More...
 

Additional Inherited Members

- Protected Member Functions inherited from QuantConnect.Lean.Engine.DataFeeds.BaseSubscriptionDataSourceReader
 BaseSubscriptionDataSourceReader (IDataCacheProvider dataCacheProvider, bool isLiveMode, IObjectStore objectStore)
 Creates a new instance More...
 
IStreamReader CreateStreamReader (SubscriptionDataSource subscriptionDataSource)
 Creates a new IStreamReader for the specified subscriptionDataSource More...
 
void OnInvalidSource (SubscriptionDataSource source, Exception exception)
 Event invocator for the InvalidSource event More...
 
- Properties inherited from QuantConnect.Lean.Engine.DataFeeds.BaseSubscriptionDataSourceReader
bool IsLiveMode [get]
 True if we're in live mode, false for backtesting More...
 
IDataCacheProvider DataCacheProvider [get]
 The data cache provider to use More...
 
IObjectStore ObjectStore [get]
 The object store to use More...
 

Detailed Description

Collection Subscription Factory takes a BaseDataCollection from BaseData factories and yields it one point at a time to the algorithm

Definition at line 28 of file CollectionSubscriptionDataSourceReader.cs.

Constructor & Destructor Documentation

◆ CollectionSubscriptionDataSourceReader()

QuantConnect.Lean.Engine.DataFeeds.CollectionSubscriptionDataSourceReader.CollectionSubscriptionDataSourceReader ( IDataCacheProvider  dataCacheProvider,
SubscriptionDataConfig  config,
DateTime  date,
bool  isLiveMode,
IObjectStore  objectStore 
)

Initializes a new instance of the CollectionSubscriptionDataSourceReader class

Parameters
dataCacheProviderUsed to cache data for requested from the IDataProvider
configThe subscription's configuration
dateThe date this factory was produced to read data for
isLiveModeTrue if we're in live mode, false for backtesting

Definition at line 41 of file CollectionSubscriptionDataSourceReader.cs.

Member Function Documentation

◆ Read()

override IEnumerable<BaseData> QuantConnect.Lean.Engine.DataFeeds.CollectionSubscriptionDataSourceReader.Read ( SubscriptionDataSource  source)
virtual

Reads the specified source

Parameters
sourceThe source to be read
Returns
An IEnumerable<BaseData> that contains the data in the source

Implements QuantConnect.Lean.Engine.DataFeeds.BaseSubscriptionDataSourceReader.

Definition at line 60 of file CollectionSubscriptionDataSourceReader.cs.

Here is the call graph for this function:

Event Documentation

◆ ReaderError

EventHandler<ReaderErrorEventArgs> QuantConnect.Lean.Engine.DataFeeds.CollectionSubscriptionDataSourceReader.ReaderError

Event fired when an exception is thrown during a call to BaseData.Reader(SubscriptionDataConfig, string, DateTime, bool)

Definition at line 53 of file CollectionSubscriptionDataSourceReader.cs.


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