Type representing the various pieces of information emebedded into a lean data file path More...

Public Member Functions
	LeanDataPathComponents (SecurityType securityType, string market, Resolution resolution, Symbol symbol, string filename, DateTime date, TickType tickType)
	Initializes a new instance of the LeanDataPathComponents class More...

Static Public Member Functions
static LeanDataPathComponents	Parse (string path)
	Parses the specified path into a new instance of the LeanDataPathComponents class More...

Properties
DateTime	Date `[get]`
	Gets the date component from the file name More...

SecurityType	SecurityType `[get]`
	Gets the security type from the path More...

string	Market `[get]`
	Gets the market from the path More...

Resolution	Resolution `[get]`
	Gets the resolution from the path More...

string	Filename `[get]`
	Gets the file name, not inluding directory information More...

Symbol	Symbol `[get]`
	Gets the symbol object implied by the path. For options, or any multi-entry zip file, this should be the canonical symbol More...

TickType	TickType `[get]`
	Gets the tick type from the file name More...

Detailed Description

Type representing the various pieces of information emebedded into a lean data file path

Definition at line 25 of file LeanDataPathComponents.cs.

Constructor & Destructor Documentation

◆ LeanDataPathComponents()

QuantConnect.Util.LeanDataPathComponents.LeanDataPathComponents	(	SecurityType	securityType,
		string	market,
		Resolution	resolution,
		Symbol	symbol,
		string	filename,
		DateTime	date,
		TickType	tickType
	)

Initializes a new instance of the LeanDataPathComponents class

Definition at line 87 of file LeanDataPathComponents.cs.

Here is the caller graph for this function:

Member Function Documentation

◆ Parse()

static LeanDataPathComponents QuantConnect.Util.LeanDataPathComponents.Parse ( string path )

static

Parses the specified path into a new instance of the LeanDataPathComponents class

Parameters

path	The path to be parsed

Returns: A new instance of the LeanDataPathComponents class representing the specified path

Definition at line 103 of file LeanDataPathComponents.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

Property Documentation

◆ Date

DateTime QuantConnect.Util.LeanDataPathComponents.Date

get

Gets the date component from the file name

Definition at line 31 of file LeanDataPathComponents.cs.

◆ SecurityType

SecurityType QuantConnect.Util.LeanDataPathComponents.SecurityType

get

Gets the security type from the path

Definition at line 39 of file LeanDataPathComponents.cs.

◆ Market

string QuantConnect.Util.LeanDataPathComponents.Market

get

Gets the market from the path

Definition at line 47 of file LeanDataPathComponents.cs.

◆ Resolution

Resolution QuantConnect.Util.LeanDataPathComponents.Resolution

get

Gets the resolution from the path

Definition at line 55 of file LeanDataPathComponents.cs.

◆ Filename

string QuantConnect.Util.LeanDataPathComponents.Filename

get

Gets the file name, not inluding directory information

Definition at line 63 of file LeanDataPathComponents.cs.

◆ Symbol

Symbol QuantConnect.Util.LeanDataPathComponents.Symbol

get

Gets the symbol object implied by the path. For options, or any multi-entry zip file, this should be the canonical symbol

Definition at line 72 of file LeanDataPathComponents.cs.

◆ TickType

TickType QuantConnect.Util.LeanDataPathComponents.TickType

get

Gets the tick type from the file name

Definition at line 80 of file LeanDataPathComponents.cs.

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

Common/Util/LeanDataPathComponents.cs

Public Member Functions

Static Public Member Functions

Properties