Lean  $LEAN_TAG$
QuantConnect.Indicators.RelativeVigorIndexSignal Class Reference

The signal for the Relative Vigor Index, itself an indicator. More...

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

Public Member Functions

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

Public Attributes

override bool IsReady => _rollingRvi.IsReady
 Gets a flag indicating when this indicator is ready and fully initialized More...
 

Protected Member Functions

override decimal ComputeNextValue (IndicatorDataPoint input)
 Computes the next value of this indicator from the given state More...
 
- Protected Member Functions inherited from QuantConnect.Indicators.Indicator
 Indicator (string name)
 Initializes a new instance of the Indicator class using the specified name. More...
 

Properties

int WarmUpPeriod [get]
 Resets this indicator to its initial state More...
 
- Properties inherited from QuantConnect.Indicators.Indicator
static int DefaultWindowSize = 2 [get]
 The default size of the history window for the indicator More...
 
- 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

The signal for the Relative Vigor Index, itself an indicator.

Definition at line 21 of file RelativeVigorIndexSignal.cs.

Member Function Documentation

◆ ComputeNextValue()

override decimal QuantConnect.Indicators.RelativeVigorIndexSignal.ComputeNextValue ( IndicatorDataPoint  input)
protected

Computes the next value of this indicator from the given state

Parameters
inputThe input given to the indicator
Returns
A new value for this indicator

Definition at line 51 of file RelativeVigorIndexSignal.cs.

◆ Reset()

override void QuantConnect.Indicators.RelativeVigorIndexSignal.Reset ( )

Resets this indicator to its initial state

Definition at line 67 of file RelativeVigorIndexSignal.cs.

Here is the caller graph for this function:

Member Data Documentation

◆ IsReady

override bool QuantConnect.Indicators.RelativeVigorIndexSignal.IsReady => _rollingRvi.IsReady

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

Definition at line 39 of file RelativeVigorIndexSignal.cs.

Property Documentation

◆ WarmUpPeriod

int QuantConnect.Indicators.RelativeVigorIndexSignal.WarmUpPeriod
get

Resets this indicator to its initial state

Definition at line 44 of file RelativeVigorIndexSignal.cs.


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