BaseDataDownloadConfig Class Reference

Abstract base class for configuring data download parameters, including common properties and initialization logic. More...

Inheritance diagram for BaseDataDownloadConfig:

Protected Member Functions
	BaseDataDownloadConfig ()
	Initializes a new instance of the BaseDataDownloadConfig class. More...
	BaseDataDownloadConfig (TickType tickType, SecurityType securityType, Resolution resolution, DateTime startDate, DateTime endDate, string marketName, List< Symbol > symbols)
	Initializes a new instance of the DataDownloadConfig class with the specified parameters. More...

Static Protected Member Functions
static DateTime	ParseDate (string date)
	Parses a string to a DateTime using a specific date format. More...
static TEnum	ParseEnum< TEnum > (string value)
	Parses a string value into an enum of the specified type. More...

Properties
DateTime	StartDate [get, set]
	Gets the start date for the data download. More...
DateTime	EndDate [get, set]
	Gets the end date for the data download. More...
Resolution	Resolution [get, protected set]
	Gets or sets the resolution of the downloaded data. More...
string	MarketName [get, protected set]
	Gets or sets the market name for which the data will be downloaded. More...
SecurityType	SecurityType [get, set]
	Gets the type of security for which the data is being downloaded. More...
TickType	TickType [get, protected set]
	Gets or sets the type of tick data to be downloaded. More...
abstract Type	DataType [get]
	The type of data based on TickTypes More...
IReadOnlyCollection< Symbol >	Symbols = [] [get, protected set]
	Gets the list of symbols for which the data will be downloaded. More...

Detailed Description

Abstract base class for configuring data download parameters, including common properties and initialization logic.

Definition at line 28 of file BaseDataDownloadConfig.cs.

Constructor & Destructor Documentation

BaseDataDownloadConfig() [1/2]

BaseDataDownloadConfig.BaseDataDownloadConfig ( )

protected

Initializes a new instance of the BaseDataDownloadConfig class.

Definition at line 73 of file BaseDataDownloadConfig.cs.

Here is the call graph for this function:

BaseDataDownloadConfig() [2/2]

BaseDataDownloadConfig.BaseDataDownloadConfig ( TickType  tickType, SecurityType  securityType, Resolution  resolution, DateTime  startDate, DateTime  endDate, string  marketName, List< Symbol >  symbols  )

protected

Initializes a new instance of the DataDownloadConfig class with the specified parameters.

Parameters

tickType	The type of tick data to be downloaded.
securityType	The type of security for which data is being downloaded.
resolution	The resolution of the data being downloaded.
startDate	The start date for the data download range.
endDate	The end date for the data download range.
marketName	The name of the market from which the data is being downloaded.
symbols	A list of symbols for which data is being downloaded.

Definition at line 106 of file BaseDataDownloadConfig.cs.

Member Function Documentation

ParseDate()

static DateTime BaseDataDownloadConfig.ParseDate ( string  date )

staticprotected

Parses a string to a DateTime using a specific date format.

Parameters

date	The date string to parse.

Returns

The parsed DateTime value.

Here is the caller graph for this function:

ParseEnum< TEnum >()

static TEnum BaseDataDownloadConfig.ParseEnum< TEnum > ( string  value )

staticprotected

Parses a string value into an enum of the specified type.

Template Parameters

TEnum

The enum type to parse the value into.

Parameters

value

The string value to parse.

Returns

The parsed enum value.

Exceptions

ArgumentException

Thrown if the value cannot be parsed or is not a valid enum value.

Type Constraints

TEnum	:	struct
TEnum	:	Enum

Definition at line 150 of file BaseDataDownloadConfig.cs.

Property Documentation

StartDate

DateTime BaseDataDownloadConfig.StartDate

getset

Gets the start date for the data download.

Definition at line 33 of file BaseDataDownloadConfig.cs.

EndDate

DateTime BaseDataDownloadConfig.EndDate

getset

Gets the end date for the data download.

Definition at line 38 of file BaseDataDownloadConfig.cs.

Resolution

Resolution BaseDataDownloadConfig.Resolution

getprotected set

Gets or sets the resolution of the downloaded data.

Definition at line 43 of file BaseDataDownloadConfig.cs.

MarketName

string BaseDataDownloadConfig.MarketName

getprotected set

Gets or sets the market name for which the data will be downloaded.

Definition at line 48 of file BaseDataDownloadConfig.cs.

SecurityType

SecurityType BaseDataDownloadConfig.SecurityType

getset

Gets the type of security for which the data is being downloaded.

Definition at line 53 of file BaseDataDownloadConfig.cs.

TickType

TickType BaseDataDownloadConfig.TickType

getprotected set

Gets or sets the type of tick data to be downloaded.

Definition at line 58 of file BaseDataDownloadConfig.cs.

DataType

abstract Type BaseDataDownloadConfig.DataType

get

The type of data based on TickTypes

Definition at line 63 of file BaseDataDownloadConfig.cs.

Symbols

IReadOnlyCollection<Symbol> BaseDataDownloadConfig.Symbols = []

getprotected set

Gets the list of symbols for which the data will be downloaded.

Definition at line 68 of file BaseDataDownloadConfig.cs.

---

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

• DownloaderDataProvider/Models/BaseDataDownloadConfig.cs