Represents a single row in a map_file. This is a csv file ordered as {date, mapped symbol} More...

Inheritance diagram for QuantConnect.Data.Auxiliary.MapFileRow:

Public Member Functions
	MapFileRow (DateTime date, string mappedSymbol, string primaryExchange, string market=QuantConnect.Market.USA, SecurityType securityType=SecurityType.Equity, DataMappingMode? dataMappingMode=null)
	Initializes a new instance of the MapFileRow class. More...

	MapFileRow (DateTime date, string mappedSymbol, Exchange primaryExchange=null, DataMappingMode? dataMappingMode=null)
	Initializes a new instance of the MapFileRow class. More...

bool	Equals (MapFileRow other)
	Indicates whether the current object is equal to another object of the same type. More...

override bool	Equals (object obj)
	Determines whether the specified T:System.Object is equal to the current T:System.Object. More...

override int	GetHashCode ()
	Serves as a hash function for a particular type. More...

string	ToCsv ()
	Writes this row to csv format More...

override string	ToString ()
	Convert this row into string form More...

Static Public Member Functions
static IEnumerable< MapFileRow >	Read (string file, string market, SecurityType securityType, IDataProvider dataProvider)
	Reads in the map_file for the specified equity symbol More...

static MapFileRow	Parse (string line, string market, SecurityType securityType)
	Parses the specified line into a MapFileRow More...

static bool	operator== (MapFileRow left, MapFileRow right)
	Determines whether or not the two instances are equal More...

static bool	operator!= (MapFileRow left, MapFileRow right)
	Determines whether or not the two instances are not equal More...

Properties
DateTime	Date `[get]`
	Gets the date associated with this data More...

string	MappedSymbol `[get]`
	Gets the mapped symbol More...

Exchange	PrimaryExchange `[get]`
	Gets the mapped symbol More...

DataMappingMode?	DataMappingMode `[get]`
	Gets the securities mapping mode associated to this mapping row More...

Detailed Description

Represents a single row in a map_file. This is a csv file ordered as {date, mapped symbol}

Definition at line 27 of file MapFileRow.cs.

Constructor & Destructor Documentation

◆ MapFileRow() [1/2]

QuantConnect.Data.Auxiliary.MapFileRow.MapFileRow	(	DateTime	date,
		string	mappedSymbol,
		string	primaryExchange,
		string	market = `QuantConnect.Market.USA`,
		SecurityType	securityType = `SecurityType.Equity`,
		DataMappingMode?	dataMappingMode = `null`
	)

Initializes a new instance of the MapFileRow class.

Definition at line 52 of file MapFileRow.cs.

Here is the caller graph for this function:

◆ MapFileRow() [2/2]

QuantConnect.Data.Auxiliary.MapFileRow.MapFileRow	(	DateTime	date,
		string	mappedSymbol,
		Exchange	primaryExchange = `null`,
		DataMappingMode?	dataMappingMode = `null`
	)

Initializes a new instance of the MapFileRow class.

Definition at line 60 of file MapFileRow.cs.

Member Function Documentation

◆ Read()

static IEnumerable<MapFileRow> QuantConnect.Data.Auxiliary.MapFileRow.Read	(	string	file,
		string	market,
		SecurityType	securityType,
		IDataProvider	dataProvider
	)

static

Reads in the map_file for the specified equity symbol

Definition at line 71 of file MapFileRow.cs.

Here is the call graph for this function:

◆ Parse()

static MapFileRow QuantConnect.Data.Auxiliary.MapFileRow.Parse	(	string	line,
		string	market,
		SecurityType	securityType
	)

static

Parses the specified line into a MapFileRow

Definition at line 92 of file MapFileRow.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Equals() [1/2]

bool QuantConnect.Data.Auxiliary.MapFileRow.Equals ( MapFileRow other )

Indicates whether the current object is equal to another object of the same type.

Returns: true if the current object is equal to the other parameter; otherwise, false.

Parameters

other An object to compare with this object.

Definition at line 119 of file MapFileRow.cs.

Here is the caller graph for this function:

◆ Equals() [2/2]

override bool QuantConnect.Data.Auxiliary.MapFileRow.Equals ( object obj )

Determines whether the specified T:System.Object is equal to the current T:System.Object.

Returns: true if the specified object is equal to the current object; otherwise, false.

Parameters

obj	The object to compare with the current object.

Definition at line 136 of file MapFileRow.cs.

Here is the call graph for this function:

◆ GetHashCode()

override int QuantConnect.Data.Auxiliary.MapFileRow.GetHashCode ( )

Serves as a hash function for a particular type.

Returns: A hash code for the current T:System.Object.

Definition at line 151 of file MapFileRow.cs.

Here is the call graph for this function:

◆ operator==()

static bool QuantConnect.Data.Auxiliary.MapFileRow.operator==	(	MapFileRow	left,
		MapFileRow	right
	)

static

Determines whether or not the two instances are equal

Definition at line 165 of file MapFileRow.cs.

Here is the call graph for this function:

◆ operator!=()

static bool QuantConnect.Data.Auxiliary.MapFileRow.operator!=	(	MapFileRow	left,
		MapFileRow	right
	)

static

Determines whether or not the two instances are not equal

Definition at line 173 of file MapFileRow.cs.

Here is the call graph for this function:

◆ ToCsv()

string QuantConnect.Data.Auxiliary.MapFileRow.ToCsv ( )

Writes this row to csv format

Definition at line 183 of file MapFileRow.cs.

◆ ToString()

override string QuantConnect.Data.Auxiliary.MapFileRow.ToString ( )

Convert this row into string form

Returns: resulting string

Definition at line 206 of file MapFileRow.cs.

Property Documentation

◆ Date

DateTime QuantConnect.Data.Auxiliary.MapFileRow.Date

get

Gets the date associated with this data

Definition at line 32 of file MapFileRow.cs.

◆ MappedSymbol

string QuantConnect.Data.Auxiliary.MapFileRow.MappedSymbol

get

Gets the mapped symbol

Definition at line 37 of file MapFileRow.cs.

◆ PrimaryExchange

Exchange QuantConnect.Data.Auxiliary.MapFileRow.PrimaryExchange

get

Gets the mapped symbol

Definition at line 42 of file MapFileRow.cs.

◆ DataMappingMode

DataMappingMode? QuantConnect.Data.Auxiliary.MapFileRow.DataMappingMode

get

Gets the securities mapping mode associated to this mapping row

Definition at line 47 of file MapFileRow.cs.

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

Common/Data/Auxiliary/MapFileRow.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ MapFileRow() [1/2]

◆ MapFileRow() [2/2]

Member Function Documentation

◆ Read()

◆ Parse()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ operator==()

◆ operator!=()

◆ ToCsv()

◆ ToString()

Property Documentation

◆ Date

◆ MappedSymbol

◆ PrimaryExchange

◆ DataMappingMode