Lean  $LEAN_TAG$
QuantConnect.Data.Consolidators.IdentityDataConsolidator< T > Class Template Reference

Represents the simplest DataConsolidator implementation, one that is defined by a straight pass through of the data. No projection or aggregation is performed. More...

Inheritance diagram for QuantConnect.Data.Consolidators.IdentityDataConsolidator< T >:
[legend]

Public Member Functions

override void Update (T data)
 Updates this consolidator with the specified data 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...
 
- Public Member Functions inherited from QuantConnect.Data.Consolidators.DataConsolidator< T >
void Update (IBaseData data)
 Updates this consolidator with the specified data More...
 
abstract void Update (TInput data)
 Updates this consolidator with the specified data. This method is responsible for raising the DataConsolidated event More...
 
void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 

Properties

override IBaseDataWorkingData [get]
 Gets a clone of the data being currently consolidated More...
 
override Type OutputType [get]
 Gets the type produced by this consolidator More...
 
- Properties inherited from QuantConnect.Data.Consolidators.DataConsolidator< T >
IBaseData Consolidated [get, protected set]
 Gets the most recently consolidated piece of data. This will be null if this consolidator has not produced any data yet. More...
 
abstract IBaseData WorkingData [get]
 Gets a clone of the data being currently consolidated More...
 
Type InputType [get]
 Gets the type consumed by this consolidator More...
 
abstract Type OutputType [get]
 Gets the type produced by this consolidator More...
 

Additional Inherited Members

- Protected Member Functions inherited from QuantConnect.Data.Consolidators.DataConsolidator< T >
virtual void OnDataConsolidated (IBaseData consolidated)
 Event invocator for the DataConsolidated event. This should be invoked by derived classes when they have consolidated a new piece of data. More...
 
- Events inherited from QuantConnect.Data.Consolidators.DataConsolidator< T >
DataConsolidatedHandler DataConsolidated
 Event handler that fires when a new piece of data is produced More...
 

Detailed Description

Represents the simplest DataConsolidator implementation, one that is defined by a straight pass through of the data. No projection or aggregation is performed.

Template Parameters
TThe type of data
Type Constraints
T :IBaseData 

Definition at line 26 of file IdentityDataConsolidator.cs.

Member Function Documentation

◆ Update()

override void QuantConnect.Data.Consolidators.IdentityDataConsolidator< T >.Update ( data)

Updates this consolidator with the specified data

Parameters
dataThe new data for the consolidator

Definition at line 53 of file IdentityDataConsolidator.cs.

Here is the call graph for this function:

◆ Scan()

override void QuantConnect.Data.Consolidators.IdentityDataConsolidator< T >.Scan ( DateTime  currentLocalTime)
virtual

Scans this consolidator to see if it should emit a bar due to time passing

Parameters
currentLocalTimeThe current time in the local time zone (same as BaseData.Time)

Implements QuantConnect.Data.Consolidators.DataConsolidator< T >.

Definition at line 66 of file IdentityDataConsolidator.cs.

◆ Reset()

override void QuantConnect.Data.Consolidators.IdentityDataConsolidator< T >.Reset ( )
virtual

Resets the consolidator

Reimplemented from QuantConnect.Data.Consolidators.DataConsolidator< T >.

Definition at line 73 of file IdentityDataConsolidator.cs.

Property Documentation

◆ WorkingData

Gets a clone of the data being currently consolidated

Definition at line 37 of file IdentityDataConsolidator.cs.

◆ OutputType

Gets the type produced by this consolidator

Definition at line 45 of file IdentityDataConsolidator.cs.


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