Unique definition key for a collection of auxiliary data for a Market and SecurityType More...

Public Member Functions
	AuxiliaryDataKey (string market, SecurityType securityType)
	Creates a new instance More...

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

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

override string	ToString ()
	Returns a string containing the market and security type More...

Static Public Member Functions
static AuxiliaryDataKey	Create (Symbol symbol)
	Helper method to create a new instance from a Symbol More...

static AuxiliaryDataKey	Create (SecurityIdentifier securityIdentifier)
	Helper method to create a new instance from a SecurityIdentifier More...

Properties
static AuxiliaryDataKey	EquityUsa = new (QuantConnect.Market.USA, SecurityType.Equity) `[get]`
	USA equities market corporate actions key definition More...

string	Market `[get]`
	The market associated with these corporate actions More...

SecurityType	SecurityType `[get]`
	The associated security type More...

Detailed Description

Unique definition key for a collection of auxiliary data for a Market and SecurityType

Definition at line 22 of file AuxiliaryDataKey.cs.

Constructor & Destructor Documentation

◆ AuxiliaryDataKey()

QuantConnect.Data.Auxiliary.AuxiliaryDataKey.AuxiliaryDataKey	(	string	market,
		SecurityType	securityType
	)

Creates a new instance

Definition at line 42 of file AuxiliaryDataKey.cs.

Here is the caller graph for this function:

Member Function Documentation

◆ GetHashCode()

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

Serves as a hash function for a particular type.

Definition at line 51 of file AuxiliaryDataKey.cs.

◆ Equals()

override bool QuantConnect.Data.Auxiliary.AuxiliaryDataKey.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 67 of file AuxiliaryDataKey.cs.

Here is the call graph for this function:

◆ ToString()

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

Returns a string containing the market and security type

Definition at line 81 of file AuxiliaryDataKey.cs.

◆ Create() [1/2]

static AuxiliaryDataKey QuantConnect.Data.Auxiliary.AuxiliaryDataKey.Create ( Symbol symbol )

static

Helper method to create a new instance from a Symbol

Here is the caller graph for this function:

◆ Create() [2/2]

static AuxiliaryDataKey QuantConnect.Data.Auxiliary.AuxiliaryDataKey.Create ( SecurityIdentifier securityIdentifier )

static

Helper method to create a new instance from a SecurityIdentifier

Definition at line 94 of file AuxiliaryDataKey.cs.

Here is the call graph for this function:

Property Documentation

◆ EquityUsa

AuxiliaryDataKey QuantConnect.Data.Auxiliary.AuxiliaryDataKey.EquityUsa = new (QuantConnect.Market.USA, SecurityType.Equity)

staticget

USA equities market corporate actions key definition

Definition at line 27 of file AuxiliaryDataKey.cs.

◆ Market

string QuantConnect.Data.Auxiliary.AuxiliaryDataKey.Market

get

The market associated with these corporate actions

Definition at line 32 of file AuxiliaryDataKey.cs.

◆ SecurityType

SecurityType QuantConnect.Data.Auxiliary.AuxiliaryDataKey.SecurityType

get

The associated security type

Definition at line 37 of file AuxiliaryDataKey.cs.

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

Common/Data/Auxiliary/AuxiliaryDataKey.cs

Public Member Functions

Static Public Member Functions

Properties