HistoryMultipleDataQueueT Class |
Represents a generic dynamic circled queue which stores several values for one observation.
It has several modes which are described below.
SingleElement: Queue store only one single element. (Useful as default method for indicators history storing)
ManualControl: Support all typical operations specific to Dequeue. (Useful for some custom work).
AutoStatic: Store all elements in sliding window specified by number elements to store. Automatically drop element when it out of the window.
AutoDynamic: Store all elements in sliding window specified by time period. Automatically drop element when it out of the window.
Also it supports direct access to element. Using two indexers: by index (int) and by time (DateTime).
All methods have two versions, with and without DateTime parameter. Please do not use both for the same class instance.
Using method with DateTime is mandatory if you want to use DateTime indexer or time period sliding window (AutoDynamic type.)
You can specify number of listener (IDataQueueListener), to do some additional work when queue stores or drops element.
Inheritance HierarchySystemObject
FinAnalysis.BaseHistoryMultipleDataQueueT
FinAnalysis.BaseBaseMultipleValueT
FinAnalysis.BaseBasePortfolioT
FinAnalysis.BaseHistoryMultipleDataQueueT
FinAnalysis.BaseBaseMultipleValueT
FinAnalysis.BaseBasePortfolioT
Namespace: FinAnalysis.Base
Assembly: FinAnalysis.Base (in FinAnalysis.Base.dll) Version: 2.1.13-cc97e13414b71fde928e8f3a546ac1daf26f295f
SyntaxC#
public class HistoryMultipleDataQueue<T> where T : new()
Type Parameters
- T
- Queue data type. Note: T must has default public constructor.
The HistoryMultipleDataQueueT type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HistoryMultipleDataQueueT(Int32) |
Initializes a new instance of the FinAnalysis.Base.TimeSeriesDataQueue
class that contains circle queue of Data and DateTime (optional). Default method of use is ManualControl.
Queue capacity will be dynamic. You can manage it manually Put\Remove Last or First elements as in Dequeue.
|
| HistoryMultipleDataQueueT(Int32, Int32) |
Initializes a new instance of the FinAnalysis.Base.TimeSeriesDataQueue
class that contains circle queue of of Data and DateTime (optional). In this case method of use will be AutoStatic,
or SingleElement if you specify capacity equal to one. Queue capacity will be
fixed and it will be enough for exact "capacity" elements.
|
| HistoryMultipleDataQueueT(Int32, TimeSpan) |
Initializes a new instance of the FinAnalysis.Base.TimeSeriesDataQueue
class that contains circle queue of of Data and DateTime. In this case method of use will be AutoDynamic,
Queue capacity will be dynamic and it will be enough for contain all elements on specified time period.
Using Put method with DateTime is mandatory in this case.
Note: You can give queue a hint, what initial arrays size it should use, by seting Capacity field.
|
Properties| Name | Description | |
|---|---|---|
 | First |
Get first(oldest) data element stored in container.
Note: if there is not elements in queue it returns DefaltValue.
|
| FirstDateTime |
Get first(oldest) data element DateTime stored in container.
Note: if there is not elements in queue it returns DefaltDateTime.
|
| ItemDateTime, Int32 |
Return historically latest element with smaller or equal DateTime.
Note: do not try to use this method if you didn't specify DateTime to data elements.
|
| ItemInt32, Int32 |
Get data which was store "index" steps ago.
|
| Last |
Get last data element stored in container.
Note: if there is not elements in queue it returns DefaltValue.
|
| LastDateTime |
Get last data element DateTime stored in container.
Note: if there is not elements in queue it returns DefaltDateTime.
|
| Ready |
Ready flag is set if and only if queue contain something.
|
Methods| Name | Description | |
|---|---|---|
| Clone |
Makes full copy of this instance.
|
| CopyTo(Object) |
Gets internal state from source object.
|
| CopyTo(Object, IL_Clone) |
Gets internal state from source object.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetIndexByTime |
Get offset index of element by element time.
If there no element with such time, we return latest element with time smaller than specified.
If we can't find valid index, we return -1.
|
| GetTimeByIndex |
Return time associated with specified point.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| SetOnPopDelegate |
Set delegate that will be invoked every time a new element is dequeued.
|
| SetOnPushDelegate |
Set delegate that will be invoked every time a new element is enqueued.
|
| SetQueueListener |
Set listener to queue capacity. Queue will call OnPop method every time, when queue drop some element.
And OnPush method, when queue store element. Do not use listener with single element queue.
Queue support any number of listeners.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
  | DefaultDateTime |
Default DateTime, which will be assumed as default date value.
Note: if you call indicator Add function with DefaultDateTime,
it will automatically forward this call to Add without DateTime parameter.
|
| DefaultValue |
Default value, which will be returned for invalid request or request for empty queue.
|
See Also