QuantConnect.Indicators.Delay Class Reference

An indicator that delays its input for a certain period More...

Inheritance diagram for QuantConnect.Indicators.Delay:

Public Member Functions
	Delay (int period)
	Creates a new Delay indicator that delays its input by the specified period More...
	Delay (string name, int period)
	Creates a new Delay indicator that delays its input by the specified period More...
Public Member Functions inherited from QuantConnect.Indicators.WindowIndicator< IndicatorDataPoint >
override void	Reset ()
	Resets this indicator to its initial state More...

Public Attributes
override bool	IsReady => Samples > Period
	Gets a flag indicating when this indicator is ready and fully initialized More...
int	WarmUpPeriod => 1 + Period
	Required period, in data points, for the indicator to be ready and fully initialized. More...
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...

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...

Additional Inherited Members
Properties inherited from QuantConnect.Indicators.IIndicatorWarmUpPeriodProvider
int	WarmUpPeriod [get]
	Required period, in data points, for the indicator to be ready and fully initialized. More...

Detailed Description

An indicator that delays its input for a certain period

Definition at line 21 of file Delay.cs.

Constructor & Destructor Documentation

Delay() [1/2]

QuantConnect.Indicators.Delay.Delay

(

int

period

)

Creates a new Delay indicator that delays its input by the specified period

Parameters

period

The period to delay input, must be greater than zero

Definition at line 27 of file Delay.cs.

Delay() [2/2]

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

Creates a new Delay indicator that delays its input by the specified period

Parameters

name	Name of the delay window indicator
period	The period to delay input, must be greater than zero

Definition at line 37 of file Delay.cs.

Member Function Documentation

ComputeNextValue()

override decimal QuantConnect.Indicators.Delay.ComputeNextValue ( IReadOnlyWindow< IndicatorDataPoint >  window, IndicatorDataPoint  input  )

protected

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

Parameters

window	The window of data held in this indicator
input	The input value to this indicator on this time step

Returns

A new value for this indicator

Definition at line 58 of file Delay.cs.

Member Data Documentation

IsReady

override bool QuantConnect.Indicators.Delay.IsReady => Samples > Period

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

Definition at line 45 of file Delay.cs.

WarmUpPeriod

int QuantConnect.Indicators.Delay.WarmUpPeriod => 1 + Period

Required period, in data points, for the indicator to be ready and fully initialized.

Definition at line 50 of file Delay.cs.

---

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

• Indicators/Delay.cs