KEEPING THIS INTERFACE FOR BACKWARDS COMPATIBILITY. Represents an indicator that can receive data updates and emit events when the value of the indicator has changed. More...

Inheritance diagram for QuantConnect.Indicators.IIndicator< T >:

[legend]

Public Member Functions
bool	Update (IBaseData input)
	Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise More...

void	Reset ()
	Resets this indicator to its initial state More...

Properties
string	Name `[get]`
	Gets a name for this indicator More...

bool	IsReady `[get]`
	Gets a flag indicating when this indicator is ready and fully initialized More...

IndicatorDataPoint	Current `[get]`
	Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue. More...

long	Samples `[get]`
	Gets the number of samples processed by this indicator More...

Events
IndicatorUpdatedHandler	Updated
	Event handler that fires after this indicator is updated More...

Detailed Description

KEEPING THIS INTERFACE FOR BACKWARDS COMPATIBILITY. Represents an indicator that can receive data updates and emit events when the value of the indicator has changed.

Represents an indicator that can receive data updates and emit events when the value of the indicator has changed.

Type Constraints

T

:

IBaseData

Definition at line 26 of file IIndicator.cs.

Member Function Documentation

◆ Update()

bool QuantConnect.Indicators.IIndicator< T >.Update ( IBaseData input )

Updates the state of this indicator with the given value and returns true if this indicator is ready, false otherwise

Parameters

input The value to use to update this indicator

Returns: True if this indicator is ready, false otherwise

Implemented in QuantConnect.Indicators.IndicatorBase< T >, and QuantConnect.Indicators.IndicatorBase< T >.

◆ Reset()

void QuantConnect.Indicators.IIndicator< T >.Reset ( )

Resets this indicator to its initial state

Implemented in QuantConnect.Indicators.IndicatorBase< T >, and QuantConnect.Indicators.IndicatorBase< T >.

Property Documentation

◆ Name

string QuantConnect.Indicators.IIndicator< T >.Name

get

Gets a name for this indicator

Definition at line 45 of file IIndicator.cs.

◆ IsReady

bool QuantConnect.Indicators.IIndicator< T >.IsReady

get

Gets a flag indicating when this indicator is ready and fully initialized

Definition at line 50 of file IIndicator.cs.

◆ Current

IndicatorDataPoint QuantConnect.Indicators.IIndicator< T >.Current

get

Gets the current state of this indicator. If the state has not been updated then the time on the value will equal DateTime.MinValue.

Definition at line 56 of file IIndicator.cs.

◆ Samples

long QuantConnect.Indicators.IIndicator< T >.Samples

get

Gets the number of samples processed by this indicator

Definition at line 61 of file IIndicator.cs.

Event Documentation

◆ Updated

IndicatorUpdatedHandler QuantConnect.Indicators.IIndicator< T >.Updated

Event handler that fires after this indicator is updated

Definition at line 40 of file IIndicator.cs.

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

Common/Indicators/IIndicator.cs

Public Member Functions

Properties

Events