Lean  $LEAN_TAG$
QuantConnect.Data.HistoryProviderInitializeParameters Class Reference

Represents the set of parameters for the IHistoryProvider.Initialize method More...

Public Member Functions

 HistoryProviderInitializeParameters (AlgorithmNodePacket job, IApi api, IDataProvider dataProvider, IDataCacheProvider dataCacheProvider, IMapFileProvider mapFileProvider, IFactorFileProvider factorFileProvider, Action< int > statusUpdateAction, bool parallelHistoryRequestsEnabled, IDataPermissionManager dataPermissionManager, IObjectStore objectStore, IAlgorithmSettings algorithmSettings)
 Initializes a new instance of the HistoryProviderInitializeParameters class from the specified parameters More...
 

Properties

AlgorithmNodePacket Job [get]
 The job More...
 
IApi Api [get]
 The API instance More...
 
IDataProvider DataProvider [get]
 The provider used to get data when it is not present on disk More...
 
IDataCacheProvider DataCacheProvider [get]
 The provider used to cache history data files More...
 
IMapFileProvider MapFileProvider [get]
 The provider used to get a map file resolver to handle equity mapping More...
 
IFactorFileProvider FactorFileProvider [get]
 The provider used to get factor files to handle equity price scaling More...
 
Action< int > StatusUpdateAction [get]
 A function used to send status updates More...
 
bool ParallelHistoryRequestsEnabled [get]
 True if parallel history requests are enabled More...
 
IDataPermissionManager DataPermissionManager [get]
 The data permission manager More...
 
IObjectStore ObjectStore [get]
 The object store More...
 
IAlgorithmSettings AlgorithmSettings [get]
 The algorithm settings instance to use More...
 

Detailed Description

Represents the set of parameters for the IHistoryProvider.Initialize method

Definition at line 25 of file HistoryProviderInitializeParameters.cs.

Constructor & Destructor Documentation

◆ HistoryProviderInitializeParameters()

QuantConnect.Data.HistoryProviderInitializeParameters.HistoryProviderInitializeParameters ( AlgorithmNodePacket  job,
IApi  api,
IDataProvider  dataProvider,
IDataCacheProvider  dataCacheProvider,
IMapFileProvider  mapFileProvider,
IFactorFileProvider  factorFileProvider,
Action< int >  statusUpdateAction,
bool  parallelHistoryRequestsEnabled,
IDataPermissionManager  dataPermissionManager,
IObjectStore  objectStore,
IAlgorithmSettings  algorithmSettings 
)

Initializes a new instance of the HistoryProviderInitializeParameters class from the specified parameters

Parameters
jobThe job
apiThe API instance
dataProviderProvider used to get data when it is not present on disk
dataCacheProviderProvider used to cache history data files
mapFileProviderProvider used to get a map file resolver to handle equity mapping
factorFileProviderProvider used to get factor files to handle equity price scaling
statusUpdateActionFunction used to send status updates
parallelHistoryRequestsEnabledTrue if parallel history requests are enabled
dataPermissionManagerThe data permission manager to use
objectStoreThe object store to use
algorithmSettingsThe algorithm settings instance to use

Definition at line 98 of file HistoryProviderInitializeParameters.cs.

Property Documentation

◆ Job

AlgorithmNodePacket QuantConnect.Data.HistoryProviderInitializeParameters.Job
get

The job

Definition at line 30 of file HistoryProviderInitializeParameters.cs.

◆ Api

IApi QuantConnect.Data.HistoryProviderInitializeParameters.Api
get

The API instance

Definition at line 35 of file HistoryProviderInitializeParameters.cs.

◆ DataProvider

IDataProvider QuantConnect.Data.HistoryProviderInitializeParameters.DataProvider
get

The provider used to get data when it is not present on disk

Definition at line 40 of file HistoryProviderInitializeParameters.cs.

◆ DataCacheProvider

IDataCacheProvider QuantConnect.Data.HistoryProviderInitializeParameters.DataCacheProvider
get

The provider used to cache history data files

Definition at line 45 of file HistoryProviderInitializeParameters.cs.

◆ MapFileProvider

IMapFileProvider QuantConnect.Data.HistoryProviderInitializeParameters.MapFileProvider
get

The provider used to get a map file resolver to handle equity mapping

Definition at line 50 of file HistoryProviderInitializeParameters.cs.

◆ FactorFileProvider

IFactorFileProvider QuantConnect.Data.HistoryProviderInitializeParameters.FactorFileProvider
get

The provider used to get factor files to handle equity price scaling

Definition at line 55 of file HistoryProviderInitializeParameters.cs.

◆ StatusUpdateAction

Action<int> QuantConnect.Data.HistoryProviderInitializeParameters.StatusUpdateAction
get

A function used to send status updates

Definition at line 60 of file HistoryProviderInitializeParameters.cs.

◆ ParallelHistoryRequestsEnabled

bool QuantConnect.Data.HistoryProviderInitializeParameters.ParallelHistoryRequestsEnabled
get

True if parallel history requests are enabled

Parallel history requests are faster but require more ram and cpu usage and are not compatible with some IDataCacheProvider

Definition at line 67 of file HistoryProviderInitializeParameters.cs.

◆ DataPermissionManager

IDataPermissionManager QuantConnect.Data.HistoryProviderInitializeParameters.DataPermissionManager
get

The data permission manager

Definition at line 72 of file HistoryProviderInitializeParameters.cs.

◆ ObjectStore

IObjectStore QuantConnect.Data.HistoryProviderInitializeParameters.ObjectStore
get

The object store

Definition at line 77 of file HistoryProviderInitializeParameters.cs.

◆ AlgorithmSettings

IAlgorithmSettings QuantConnect.Data.HistoryProviderInitializeParameters.AlgorithmSettings
get

The algorithm settings instance to use

Definition at line 82 of file HistoryProviderInitializeParameters.cs.


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