Lean  $LEAN_TAG$
QuantConnect.Indicators.SwissArmyKnife Class Reference

Swiss Army Knife indicator by John Ehlers More...

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

Public Member Functions

 SwissArmyKnife (int period, double delta, SwissArmyKnifeTool tool)
 Swiss Army Knife indicator by John Ehlers More...
 
 SwissArmyKnife (string name, int period, double delta, SwissArmyKnifeTool tool)
 Swiss Army Knife indicator by John Ehlers More...
 
override void Reset ()
 Resets to the 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 => _period
 Required period, in data points, for the indicator to be 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...
 

Additional Inherited Members

- 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

Swiss Army Knife indicator by John Ehlers

Definition at line 50 of file SwissArmyKnife.cs.

Constructor & Destructor Documentation

◆ SwissArmyKnife() [1/2]

QuantConnect.Indicators.SwissArmyKnife.SwissArmyKnife ( int  period,
double  delta,
SwissArmyKnifeTool  tool 
)

Swiss Army Knife indicator by John Ehlers

Parameters
period
delta
tool

Definition at line 69 of file SwissArmyKnife.cs.

◆ SwissArmyKnife() [2/2]

QuantConnect.Indicators.SwissArmyKnife.SwissArmyKnife ( string  name,
int  period,
double  delta,
SwissArmyKnifeTool  tool 
)

Swiss Army Knife indicator by John Ehlers

Parameters
name
period
delta
tool

Definition at line 81 of file SwissArmyKnife.cs.

Member Function Documentation

◆ ComputeNextValue()

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

◆ Reset()

override void QuantConnect.Indicators.SwissArmyKnife.Reset ( )

Resets to the initial state

Definition at line 167 of file SwissArmyKnife.cs.

Member Data Documentation

◆ IsReady

override bool QuantConnect.Indicators.SwissArmyKnife.IsReady => Samples >= _period

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

Definition at line 135 of file SwissArmyKnife.cs.

◆ WarmUpPeriod

int QuantConnect.Indicators.SwissArmyKnife.WarmUpPeriod => _period

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

Definition at line 140 of file SwissArmyKnife.cs.


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