Lean  $LEAN_TAG$
QuantConnect.Data.Auxiliary.MapFileResolver Class Reference

Provides a means of mapping a symbol at a point in time to the map file containing that share class's mapping information More...

Inheritance diagram for QuantConnect.Data.Auxiliary.MapFileResolver:
[legend]

Public Member Functions

 MapFileResolver (IEnumerable< MapFile > mapFiles)
 Initializes a new instance of the MapFileResolver by reading in all files in the specified directory. More...
 
MapFile GetByPermtick (string permtick)
 Gets the map file matching the specified permtick More...
 
MapFile ResolveMapFile (string symbol, DateTime date)
 Resolves the map file path containing the mapping information for the symbol defined at date More...
 
IEnumerator< MapFileGetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 

Static Public Attributes

static readonly MapFileResolver Empty = new MapFileResolver(Enumerable.Empty<MapFile>())
 Gets an empty MapFileResolver, that is an instance that contains zero mappings More...
 

Detailed Description

Provides a means of mapping a symbol at a point in time to the map file containing that share class's mapping information

Definition at line 32 of file MapFileResolver.cs.

Constructor & Destructor Documentation

◆ MapFileResolver()

QuantConnect.Data.Auxiliary.MapFileResolver.MapFileResolver ( IEnumerable< MapFile mapFiles)

Initializes a new instance of the MapFileResolver by reading in all files in the specified directory.

Parameters
mapFilesThe data used to initialize this resolver.

Definition at line 48 of file MapFileResolver.cs.

Member Function Documentation

◆ GetByPermtick()

MapFile QuantConnect.Data.Auxiliary.MapFileResolver.GetByPermtick ( string  permtick)

Gets the map file matching the specified permtick

Parameters
permtickThe permtick to match on
Returns
The map file matching the permtick, or null if not found

Definition at line 90 of file MapFileResolver.cs.

Here is the caller graph for this function:

◆ ResolveMapFile()

MapFile QuantConnect.Data.Auxiliary.MapFileResolver.ResolveMapFile ( string  symbol,
DateTime  date 
)

Resolves the map file path containing the mapping information for the symbol defined at date

Parameters
symbolThe symbol as of date to be mapped
dateThe date associated with the symbol
Returns
The map file responsible for mapping the symbol, if no map file is found, null is returned

Definition at line 103 of file MapFileResolver.cs.

Here is the caller graph for this function:

◆ GetEnumerator()

IEnumerator<MapFile> QuantConnect.Data.Auxiliary.MapFileResolver.GetEnumerator ( )

Returns an enumerator that iterates through the collection.

Returns
A T:System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.

<filterpriority>1</filterpriority>

Definition at line 211 of file MapFileResolver.cs.

Member Data Documentation

◆ Empty

readonly MapFileResolver QuantConnect.Data.Auxiliary.MapFileResolver.Empty = new MapFileResolver(Enumerable.Empty<MapFile>())
static

Gets an empty MapFileResolver, that is an instance that contains zero mappings

Definition at line 41 of file MapFileResolver.cs.


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