Type capable of consolidating open interest
More...
|
| OpenInterestConsolidator (TimeSpan period) |
| Creates a consolidator to produce a new 'OpenInterest' representing the period More...
|
|
| OpenInterestConsolidator (int maxCount) |
| Creates a consolidator to produce a new 'OpenInterest' representing the last count pieces of data More...
|
|
| OpenInterestConsolidator (int maxCount, TimeSpan period) |
| Creates a consolidator to produce a new 'OpenInterest' representing the last count pieces of data or the period, whichever comes first More...
|
|
| OpenInterestConsolidator (Func< DateTime, CalendarInfo > func) |
| Creates a consolidator to produce a new 'OpenInterest' More...
|
|
| OpenInterestConsolidator (PyObject pyfuncobj) |
| Creates a consolidator to produce a new 'OpenInterest' More...
|
|
override void | Update (T data) |
| Updates this consolidator with the specified data. This method is responsible for raising the DataConsolidated event In time span mode, the bar range is closed on the left and open on the right: [T, T+TimeSpan). For example, if time span is 1 minute, we have [10:00, 10:01): so data at 10:01 is not included in the bar starting at 10:00. More...
|
|
override void | Scan (DateTime currentLocalTime) |
| Scans this consolidator to see if it should emit a bar due to time passing More...
|
|
override void | Reset () |
| Resets the consolidator More...
|
|
|
override Type | OutputType |
| Gets the type produced by this consolidator More...
|
|
override IBaseData | WorkingData |
| Gets a clone of the data being currently consolidated More...
|
|
bool | IsTimeBased |
| Returns true if this consolidator is time-based, false otherwise More...
|
|
TimeSpan? | Period |
| Gets the time period for this consolidator More...
|
|
new EventHandler< TConsolidated > | DataConsolidated |
| Event handler that fires when a new piece of data is produced. We define this as a 'new' event so we can expose it as a TConsolidated instead of a BaseData instance More...
|
|
Type capable of consolidating open interest
Definition at line 25 of file OpenInterestConsolidator.cs.
◆ OpenInterestConsolidator() [1/5]
QuantConnect.Data.Consolidators.OpenInterestConsolidator.OpenInterestConsolidator |
( |
TimeSpan |
period | ) |
|
Creates a consolidator to produce a new 'OpenInterest' representing the period
- Parameters
-
period | The minimum span of time before emitting a consolidated bar |
Definition at line 41 of file OpenInterestConsolidator.cs.
◆ OpenInterestConsolidator() [2/5]
QuantConnect.Data.Consolidators.OpenInterestConsolidator.OpenInterestConsolidator |
( |
int |
maxCount | ) |
|
Creates a consolidator to produce a new 'OpenInterest' representing the last count pieces of data
- Parameters
-
maxCount | The number of pieces to accept before emitting a consolidated bar |
Definition at line 50 of file OpenInterestConsolidator.cs.
◆ OpenInterestConsolidator() [3/5]
QuantConnect.Data.Consolidators.OpenInterestConsolidator.OpenInterestConsolidator |
( |
int |
maxCount, |
|
|
TimeSpan |
period |
|
) |
| |
Creates a consolidator to produce a new 'OpenInterest' representing the last count pieces of data or the period, whichever comes first
- Parameters
-
maxCount | The number of pieces to accept before emitting a consolidated bar |
period | The minimum span of time before emitting a consolidated bar |
Definition at line 60 of file OpenInterestConsolidator.cs.
◆ OpenInterestConsolidator() [4/5]
QuantConnect.Data.Consolidators.OpenInterestConsolidator.OpenInterestConsolidator |
( |
Func< DateTime, CalendarInfo > |
func | ) |
|
Creates a consolidator to produce a new 'OpenInterest'
- Parameters
-
func | Func that defines the start time of a consolidated data |
Definition at line 69 of file OpenInterestConsolidator.cs.
◆ OpenInterestConsolidator() [5/5]
QuantConnect.Data.Consolidators.OpenInterestConsolidator.OpenInterestConsolidator |
( |
PyObject |
pyfuncobj | ) |
|
Creates a consolidator to produce a new 'OpenInterest'
- Parameters
-
pyfuncobj | Python function object that defines the start time of a consolidated data |
Definition at line 78 of file OpenInterestConsolidator.cs.
◆ FromResolution()
Create a new OpenInterestConsolidator for the desired resolution
- Parameters
-
resolution | The resolution desired |
- Returns
- A consolidator that produces data on the resolution interval
Definition at line 32 of file OpenInterestConsolidator.cs.
◆ ShouldProcess()
override bool QuantConnect.Data.Consolidators.OpenInterestConsolidator.ShouldProcess |
( |
Tick |
data | ) |
|
|
protected |
Determines whether or not the specified data should be processed
- Parameters
-
- Returns
- True if the consolidator should process this data, false otherwise
Definition at line 89 of file OpenInterestConsolidator.cs.
◆ AggregateBar()
override void QuantConnect.Data.Consolidators.OpenInterestConsolidator.AggregateBar |
( |
ref OpenInterest |
workingBar, |
|
|
Tick |
data |
|
) |
| |
|
protected |
Aggregates the new 'data' into the 'workingBar'. The 'workingBar' will be null following the event firing
- Parameters
-
workingBar | The bar we're building, null if the event was just fired and we're starting a new OI bar |
data | The new data |
Definition at line 100 of file OpenInterestConsolidator.cs.
The documentation for this class was generated from the following file: