QuantConnect.Indicators.Sum Class Reference

Represents an indicator capable of tracking the sum for the given period More...

Inheritance diagram for QuantConnect.Indicators.Sum:

Public Member Functions
override void	Reset ()
	Resets this indicator to its initial state More...
	Sum (string name, int period)
	Initializes a new instance of the Sum class with the specified name and period More...
	Sum (int period)
	Initializes a new instance of the Sum 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...

Public Attributes
int	WarmUpPeriod => 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

Represents an indicator capable of tracking the sum for the given period

Definition at line 21 of file Sum.cs.

Constructor & Destructor Documentation

Sum() [1/2]

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

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

Parameters

name	The name of this indicator
period	The period of the SMA

Definition at line 47 of file Sum.cs.

Sum() [2/2]

QuantConnect.Indicators.Sum.Sum

(

int

period

)

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

Parameters

period

The period of the SMA

Definition at line 56 of file Sum.cs.

Member Function Documentation

Reset()

override void QuantConnect.Indicators.Sum.Reset

(

)

Resets this indicator to its initial state

Definition at line 36 of file Sum.cs.

ComputeNextValue()

override decimal QuantConnect.Indicators.Sum.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 67 of file Sum.cs.

Member Data Documentation

WarmUpPeriod

int QuantConnect.Indicators.Sum.WarmUpPeriod => Period

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

Definition at line 31 of file Sum.cs.

---

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

• Indicators/Sum.cs