QuantConnect.Securities.Future.FutureCache Class Reference
Future specific caching support More...
Inheritance diagram for QuantConnect.Securities.Future.FutureCache:
Protected Member Functions | |
| override void | ProcessDataPoint (BaseData data, bool cacheByType) |
| Will consume the given data point updating the cache state and it's properties More... | |
Properties | |
| decimal | SettlementPrice [get, set] |
| The current settlement price More... | |
 Properties inherited from QuantConnect.Securities.SecurityCache | |
| decimal | Price [get] |
| Gets the most recent price submitted to this cache More... | |
| decimal | Open [get] |
| Gets the most recent open submitted to this cache More... | |
| decimal | High [get] |
| Gets the most recent high submitted to this cache More... | |
| decimal | Low [get] |
| Gets the most recent low submitted to this cache More... | |
| decimal | Close [get] |
| Gets the most recent close submitted to this cache More... | |
| decimal | BidPrice [get] |
| Gets the most recent bid submitted to this cache More... | |
| decimal | AskPrice [get] |
| Gets the most recent ask submitted to this cache More... | |
| decimal | BidSize [get] |
| Gets the most recent bid size submitted to this cache More... | |
| decimal | AskSize [get] |
| Gets the most recent ask size submitted to this cache More... | |
| decimal | Volume [get] |
| Gets the most recent volume submitted to this cache More... | |
| long | OpenInterest [get] |
| Gets the most recent open interest submitted to this cache More... | |
| Dictionary< string, object > | Properties [get] |
| Collection of keyed custom properties More... | |
Additional Inherited Members | |
| Public Member Functions inherited from QuantConnect.Securities.SecurityCache | |
| void | AddDataList (IReadOnlyList< BaseData > data, Type dataType, bool? containsFillForwardData=null) |
| Add a list of market data points to the local security cache for the current market price. More... | |
| void | AddData (BaseData data) |
| Add a new market data point to the local security cache for the current market price. Rules: Don't cache fill forward data. Always return the last observation. If two consecutive data has the same time stamp and one is Quotebars and the other Tradebar, prioritize the Quotebar. More... | |
| void | StoreData (IReadOnlyList< BaseData > data, Type dataType) |
| Stores the specified data list in the cache WITHOUT updating any of the cache properties, such as Price More... | |
| BaseData | GetData () |
| Get last data packet received for this security if any else null More... | |
| T | GetData< T > () |
| Get last data packet received for this security of the specified type More... | |
| IEnumerable< T > | GetAll< T > () |
| Gets all data points of the specified type from the most recent time step that produced data for that type More... | |
| void | Reset () |
| Reset cache storage and free memory More... | |
| bool | HasData (Type type) |
| Gets whether or not this dynamic data instance has data stored for the specified type More... | |
| bool | TryGetValue (Type type, out IReadOnlyList< BaseData > data) |
| Gets whether or not this dynamic data instance has data stored for the specified type More... | |
| Static Public Member Functions inherited from QuantConnect.Securities.SecurityCache | |
| static void | ShareTypeCacheInstance (SecurityCache sourceToShare, SecurityCache targetToModify) |
| Helper method that modifies the target security cache instance to use the type cache of the source More... | |
Detailed Description
Future specific caching support
Class is virtually empty and scheduled to be made obsolete. Potentially could be used for user data storage.
- See also
- SecurityCache
Definition at line 25 of file FutureCache.cs.
Member Function Documentation
◆ ProcessDataPoint()
|
protectedvirtual |
Will consume the given data point updating the cache state and it's properties
- Parameters
-
data The data point to process cacheByType True if this data point should be cached by type
Reimplemented from QuantConnect.Securities.SecurityCache.
Definition at line 37 of file FutureCache.cs.
Property Documentation
◆ SettlementPrice
|
getset |
The current settlement price
Definition at line 30 of file FutureCache.cs.
The documentation for this class was generated from the following file:
- Common/Securities/Future/FutureCache.cs
