Represents the parameters required for downloading universe data. More...

Inheritance diagram for DataUniverseDownloaderGetParameters:

Public Member Functions
	DataUniverseDownloaderGetParameters (Symbol canonicalSymbol, DateTime startDate, DateTime endDate, SecurityExchangeHours securityExchangeHours=default)
	Initializes a new instance of the DataUniverseDownloaderGetParameters class. More...

string	GetUniverseFileName (DateTime processingDate)
	Gets the file name where the universe data will be saved. More...

IEnumerable<(DateTime, IEnumerable< DataDownloaderGetParameters >)>	CreateDataDownloaderGetParameters ()
	Creates data download parameters for each day in the range. More...

Properties
Symbol?	UnderlyingSymbol `[get]`
	Gets the underlying symbol associated with the universe. More...

Detailed Description

Represents the parameters required for downloading universe data.

Definition at line 28 of file DataUniverseDownloaderGetParameters.cs.

Constructor & Destructor Documentation

◆ DataUniverseDownloaderGetParameters()

DataUniverseDownloaderGetParameters.DataUniverseDownloaderGetParameters	(	Symbol	canonicalSymbol,
		DateTime	startDate,
		DateTime	endDate,
		SecurityExchangeHours	securityExchangeHours = `default`
	)

Initializes a new instance of the DataUniverseDownloaderGetParameters class.

Parameters

canonicalSymbol	The canonical symbol for the data request.
startDate	The start date for the data request.
endDate	The end date for the data request.
securityExchangeHours	The security exchange hours for this symbol

Exceptions

ArgumentException Thrown when the provided symbol is not canonical.

Definition at line 53 of file DataUniverseDownloaderGetParameters.cs.

Here is the call graph for this function:

Member Function Documentation

◆ GetUniverseFileName()

string DataUniverseDownloaderGetParameters.GetUniverseFileName ( DateTime processingDate )

Gets the file name where the universe data will be saved.

Parameters

processingDate The date for which the file name is generated.

Returns: The universe file name.

Definition at line 71 of file DataUniverseDownloaderGetParameters.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateDataDownloaderGetParameters()

IEnumerable<(DateTime, IEnumerable<DataDownloaderGetParameters>)> DataUniverseDownloaderGetParameters.CreateDataDownloaderGetParameters ( )

Creates data download parameters for each day in the range.

Definition at line 79 of file DataUniverseDownloaderGetParameters.cs.

Here is the caller graph for this function:

Property Documentation

◆ UnderlyingSymbol

Symbol? DataUniverseDownloaderGetParameters.UnderlyingSymbol

get

Gets the underlying symbol associated with the universe.

Definition at line 43 of file DataUniverseDownloaderGetParameters.cs.

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

Common/DataUniverseDownloaderGetParameters.cs

Public Member Functions

Properties