Lean  $LEAN_TAG$
QuantConnect.Securities.SecurityDatabaseKey Class Reference

Represents the key to a single entry in the MarketHoursDatabase or the SymbolPropertiesDatabase More...

Inheritance diagram for QuantConnect.Securities.SecurityDatabaseKey:
[legend]

Public Member Functions

 SecurityDatabaseKey (string market, string symbol, SecurityType securityType)
 Initializes a new instance of the SecurityDatabaseKey class More...
 
SecurityDatabaseKey CreateCommonKey ()
 Based on this entry will initializes the generic market and security type instance of the SecurityDatabaseKey class More...
 
bool Equals (SecurityDatabaseKey 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 object is equal to the current object. More...
 
override int GetHashCode ()
 Serves as the default hash function. More...
 
override string ToString ()
 Returns a string that represents the current object. More...
 

Static Public Member Functions

static SecurityDatabaseKey Parse (string key)
 Parses the specified string as a SecurityDatabaseKey More...
 
static bool operator== (SecurityDatabaseKey left, SecurityDatabaseKey right)
 Security Database Key == operator More...
 
static bool operator!= (SecurityDatabaseKey left, SecurityDatabaseKey right)
 Security Database Key != operator More...
 

Static Public Attributes

const string Wildcard = "[*]"
 Represents that the specified symbol or market field will match all More...
 

Properties

string Market [get]
 The market. If null, ignore market filtering More...
 
string Symbol [get]
 The symbol. If null, ignore symbol filtering More...
 
SecurityType SecurityType [get]
 The security type More...
 

Detailed Description

Represents the key to a single entry in the MarketHoursDatabase or the SymbolPropertiesDatabase

Definition at line 23 of file SecurityDatabaseKey.cs.

Constructor & Destructor Documentation

◆ SecurityDatabaseKey()

QuantConnect.Securities.SecurityDatabaseKey.SecurityDatabaseKey ( string  market,
string  symbol,
SecurityType  securityType 
)

Initializes a new instance of the SecurityDatabaseKey class

Parameters
marketThe market
symbolThe symbol. specify null to apply to all symbols in market/security type
securityTypeThe security type

Definition at line 51 of file SecurityDatabaseKey.cs.

Here is the caller graph for this function:

Member Function Documentation

◆ CreateCommonKey()

SecurityDatabaseKey QuantConnect.Securities.SecurityDatabaseKey.CreateCommonKey ( )

Based on this entry will initializes the generic market and security type instance of the SecurityDatabaseKey class

Definition at line 61 of file SecurityDatabaseKey.cs.

Here is the call graph for this function:

◆ Parse()

static SecurityDatabaseKey QuantConnect.Securities.SecurityDatabaseKey.Parse ( string  key)
static

Parses the specified string as a SecurityDatabaseKey

Parameters
keyThe string representation of the key
Returns
A new SecurityDatabaseKey instance

Definition at line 71 of file SecurityDatabaseKey.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Equals() [1/2]

bool QuantConnect.Securities.SecurityDatabaseKey.Equals ( SecurityDatabaseKey  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
otherAn object to compare with this object.

Definition at line 96 of file SecurityDatabaseKey.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Equals() [2/2]

override bool QuantConnect.Securities.SecurityDatabaseKey.Equals ( object  obj)

Determines whether the specified object is equal to the current object.

Returns
true if the specified object is equal to the current object; otherwise, false.
Parameters
objThe object to compare with the current object.

Definition at line 112 of file SecurityDatabaseKey.cs.

Here is the call graph for this function:

◆ GetHashCode()

override int QuantConnect.Securities.SecurityDatabaseKey.GetHashCode ( )

Serves as the default hash function.

Returns
A hash code for the current object.

Definition at line 126 of file SecurityDatabaseKey.cs.

◆ operator==()

static bool QuantConnect.Securities.SecurityDatabaseKey.operator== ( SecurityDatabaseKey  left,
SecurityDatabaseKey  right 
)
static

Security Database Key == operator

Returns
True if they are the same

Definition at line 141 of file SecurityDatabaseKey.cs.

Here is the call graph for this function:

◆ operator!=()

static bool QuantConnect.Securities.SecurityDatabaseKey.operator!= ( SecurityDatabaseKey  left,
SecurityDatabaseKey  right 
)
static

Security Database Key != operator

Returns
True if they are not the same

Definition at line 150 of file SecurityDatabaseKey.cs.

Here is the call graph for this function:

◆ ToString()

override string QuantConnect.Securities.SecurityDatabaseKey.ToString ( )

Returns a string that represents the current object.

Returns
A string that represents the current object.

Definition at line 163 of file SecurityDatabaseKey.cs.

Here is the call graph for this function:

Member Data Documentation

◆ Wildcard

const string QuantConnect.Securities.SecurityDatabaseKey.Wildcard = "[*]"
static

Represents that the specified symbol or market field will match all

Definition at line 28 of file SecurityDatabaseKey.cs.

Property Documentation

◆ Market

string QuantConnect.Securities.SecurityDatabaseKey.Market
get

The market. If null, ignore market filtering

Definition at line 33 of file SecurityDatabaseKey.cs.

◆ Symbol

string QuantConnect.Securities.SecurityDatabaseKey.Symbol
get

The symbol. If null, ignore symbol filtering

Definition at line 38 of file SecurityDatabaseKey.cs.

◆ SecurityType

SecurityType QuantConnect.Securities.SecurityDatabaseKey.SecurityType
get

The security type

Definition at line 43 of file SecurityDatabaseKey.cs.


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