Lean  $LEAN_TAG$
QuantConnect.Indicators.WindowIdentity Class Reference

Represents an indicator that is a ready after ingesting enough samples (# samples > period) and always returns the same value as it is given. More...

Inheritance diagram for QuantConnect.Indicators.WindowIdentity:
[legend]

Public Member Functions

 WindowIdentity (string name, int period)
 Initializes a new instance of the WindowIdentity class with the specified name and period More...
 
 WindowIdentity (int period)
 Initializes a new instance of the WindowIdentity class with the default name and period More...
 
- Public Member Functions inherited from QuantConnect.Indicators.WindowIndicator< IndicatorDataPoint >
override void Reset ()
 Resets this indicator to its initial state More...
 

Protected Member Functions

override decimal ComputeNextValue (IReadOnlyWindow< IndicatorDataPoint > window, IndicatorDataPoint input)
 Computes the next value for this indicator from the given state. More...
 
- Protected Member Functions inherited from QuantConnect.Indicators.WindowIndicator< IndicatorDataPoint >
 WindowIndicator (string name, int period)
 Initializes a new instance of the WindowIndicator class More...
 
override decimal ComputeNextValue (T input)
 Computes the next value of this indicator from the given state More...
 
abstract decimal ComputeNextValue (IReadOnlyWindow< T > window, T input)
 Computes the next value for this indicator from the given state. More...
 

Properties

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

Additional Inherited Members

- Public Attributes inherited from QuantConnect.Indicators.WindowIndicator< IndicatorDataPoint >
int Period
 Gets the period of this window indicator More...
 
override bool IsReady
 Gets a flag indicating when this indicator is ready and fully initialized More...
 
virtual int WarmUpPeriod
 Required period, in data points, to the indicator to be ready and fully initialized More...
 

Detailed Description

Represents an indicator that is a ready after ingesting enough samples (# samples > period) and always returns the same value as it is given.

Definition at line 22 of file WindowIdentity.cs.

Constructor & Destructor Documentation

◆ WindowIdentity() [1/2]

QuantConnect.Indicators.WindowIdentity.WindowIdentity ( string  name,
int  period 
)

Initializes a new instance of the WindowIdentity class with the specified name and period

Parameters
nameThe name of this indicator
periodThe period of the WindowIdentity

Definition at line 29 of file WindowIdentity.cs.

◆ WindowIdentity() [2/2]

QuantConnect.Indicators.WindowIdentity.WindowIdentity ( int  period)

Initializes a new instance of the WindowIdentity class with the default name and period

Parameters
periodThe period of the WindowIdentity

Definition at line 38 of file WindowIdentity.cs.

Member Function Documentation

◆ ComputeNextValue()

override decimal QuantConnect.Indicators.WindowIdentity.ComputeNextValue ( IReadOnlyWindow< IndicatorDataPoint window,
IndicatorDataPoint  input 
)
protected

Computes the next value for this indicator from the given state.

Parameters
windowThe window of data held in this indicator
inputThe input value to this indicator on this time step
Returns
A new value for this indicator

Definition at line 57 of file WindowIdentity.cs.

Property Documentation

◆ IsReady

override bool QuantConnect.Indicators.WindowIdentity.IsReady
get

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

Definition at line 47 of file WindowIdentity.cs.


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