Lean  $LEAN_TAG$
QuantConnect.Data.Market.FuturesChains Class Reference

Collection of FuturesChain keyed by canonical futures symbol More...

Inheritance diagram for QuantConnect.Data.Market.FuturesChains:
[legend]

Public Member Functions

 FuturesChains ()
 Creates a new instance of the FuturesChains dictionary More...
 
 FuturesChains (DateTime time)
 Creates a new instance of the FuturesChains dictionary More...
 
- Public Member Functions inherited from QuantConnect.Data.Market.DataDictionary< FuturesChain >
 DataDictionary ()
 Initializes a new instance of the QuantConnect.Data.Market.DataDictionary<T> class. More...
 
 DataDictionary (IEnumerable< T > data, Func< T, Symbol > keySelector)
 Initializes a new instance of the QuantConnect.Data.Market.DataDictionary<T> class using the specified data as a data source More...
 
 DataDictionary (DateTime time)
 Initializes a new instance of the QuantConnect.Data.Market.DataDictionary<T> class. More...
 
IEnumerator< KeyValuePair< Symbol, T > > GetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 
void Add (KeyValuePair< Symbol, T > item)
 Adds an item to the T:System.Collections.Generic.ICollection`1. More...
 
void Add (Symbol key, T value)
 Adds an element with the provided key and value to the T:System.Collections.Generic.IDictionary`2. More...
 
override void Clear ()
 Removes all items from the T:System.Collections.Generic.ICollection`1. More...
 
bool Contains (KeyValuePair< Symbol, T > item)
 Determines whether the T:System.Collections.Generic.ICollection`1 contains a specific value. More...
 
void CopyTo (KeyValuePair< Symbol, T >[] array, int arrayIndex)
 Copies the elements of the T:System.Collections.Generic.ICollection`1 to an T:System.Array, starting at a particular T:System.Array index. More...
 
bool Remove (KeyValuePair< Symbol, T > item)
 Removes the first occurrence of a specific object from the T:System.Collections.Generic.ICollection`1. More...
 
override bool Remove (Symbol key)
 Removes the element with the specified key from the T:System.Collections.Generic.IDictionary`2. More...
 
bool ContainsKey (Symbol key)
 Determines whether the T:System.Collections.Generic.IDictionary`2 contains an element with the specified key. More...
 
override bool TryGetValue (Symbol key, out T value)
 Gets the value associated with the specified key. More...
 
virtual T GetValue (Symbol key)
 Gets the value associated with the specified key. More...
 

Properties

new FuturesChain this[string ticker] [get, set]
 Gets or sets the FuturesChain with the specified ticker. More...
 
new FuturesChain this[Symbol symbol] [get, set]
 Gets or sets the FuturesChain with the specified Symbol. More...
 
- Properties inherited from QuantConnect.Data.Market.DataDictionary< FuturesChain >
DateTime Time [get, set]
 Gets or sets the time associated with this collection of data More...
 
int Count [get]
 Gets the number of elements contained in the T:System.Collections.Generic.ICollection`1. More...
 
override bool IsReadOnly [get]
 Gets a value indicating whether the T:System.Collections.Generic.ICollection`1 is read-only. More...
 
override T this[Symbol symbol] [get, set]
 Gets or sets the element with the specified key. More...
 
ICollection< SymbolKeys [get]
 Gets an T:System.Collections.Generic.ICollection`1 containing the keys of the T:System.Collections.Generic.IDictionary`2. More...
 
ICollection< T > Values [get]
 Gets an T:System.Collections.Generic.ICollection`1 containing the values in the T:System.Collections.Generic.IDictionary`2. More...
 

Additional Inherited Members

- Protected Attributes inherited from QuantConnect.Data.Market.DataDictionary< FuturesChain >
override IEnumerable< SymbolGetKeys
 Gets an T:System.Collections.Generic.ICollection`1 containing the Symbol objects of the T:System.Collections.Generic.IDictionary`2. More...
 
override IEnumerable< T > GetValues
 Gets an T:System.Collections.Generic.ICollection`1 containing the values in the T:System.Collections.Generic.IDictionary`2. More...
 

Detailed Description

Collection of FuturesChain keyed by canonical futures symbol

Definition at line 23 of file FuturesChains.cs.

Constructor & Destructor Documentation

◆ FuturesChains() [1/2]

QuantConnect.Data.Market.FuturesChains.FuturesChains ( )

Creates a new instance of the FuturesChains dictionary

Definition at line 28 of file FuturesChains.cs.

◆ FuturesChains() [2/2]

QuantConnect.Data.Market.FuturesChains.FuturesChains ( DateTime  time)

Creates a new instance of the FuturesChains dictionary

Definition at line 35 of file FuturesChains.cs.

Property Documentation

◆ this[string ticker]

new FuturesChain QuantConnect.Data.Market.FuturesChains.this[string ticker]
getset

Gets or sets the FuturesChain with the specified ticker.

Returns
The FuturesChain with the specified ticker.
Parameters
tickerThe ticker of the element to get or set.

Wraps the base implementation to enable indexing in python algorithms due to pythonnet limitations

Definition at line 48 of file FuturesChains.cs.

◆ this[Symbol symbol]

new FuturesChain QuantConnect.Data.Market.FuturesChains.this[Symbol symbol]
getset

Gets or sets the FuturesChain with the specified Symbol.

Returns
The FuturesChain with the specified Symbol.
Parameters
symbolThe Symbol of the element to get or set.

Wraps the base implementation to enable indexing in python algorithms due to pythonnet limitations

Definition at line 58 of file FuturesChains.cs.


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