Lean  $LEAN_TAG$
QuantConnect.Indicators.SchaffTrendCycle Class Reference

This indicator creates the Schaff Trend Cycle More...

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

Public Member Functions

 SchaffTrendCycle (int cyclePeriod=10, int fastPeriod=23, int slowPeriod=50, MovingAverageType type=MovingAverageType.Exponential)
 Creates the name string and calls on the indicator constructor with given parameters https://www.tradingpedia.com/forex-trading-indicators/schaff-trend-cycle More...
 
 SchaffTrendCycle (string name, int cyclePeriod, int fastPeriod, int slowPeriod, MovingAverageType type)
 Creates a new schaff trend cycle with the specified parameters More...
 
override void Reset ()
 Resets this indicator to its initial state More...
 

Public Attributes

override bool IsReady => _MACD.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]
 Required period, in data points, for the indicator to be ready and fully initialized. 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

This indicator creates the Schaff Trend Cycle

Definition at line 23 of file SchaffTrendCycle.cs.

Constructor & Destructor Documentation

◆ SchaffTrendCycle() [1/2]

QuantConnect.Indicators.SchaffTrendCycle.SchaffTrendCycle ( int  cyclePeriod = 10,
int  fastPeriod = 23,
int  slowPeriod = 50,
MovingAverageType  type = MovingAverageType.Exponential 
)

Creates the name string and calls on the indicator constructor with given parameters https://www.tradingpedia.com/forex-trading-indicators/schaff-trend-cycle

Parameters
fastPeriodThe fast moving average period
slowPeriodThe slow moving average period
cyclePeriodThe signal period
typeThe type of moving averages to use

Definition at line 58 of file SchaffTrendCycle.cs.

◆ SchaffTrendCycle() [2/2]

QuantConnect.Indicators.SchaffTrendCycle.SchaffTrendCycle ( string  name,
int  cyclePeriod,
int  fastPeriod,
int  slowPeriod,
MovingAverageType  type 
)

Creates a new schaff trend cycle with the specified parameters

Parameters
nameThe name of this indicator
fastPeriodThe fast moving average period
slowPeriodThe slow moving average period
cyclePeriodThe signal period
typeThe type of moving averages to use

Definition at line 71 of file SchaffTrendCycle.cs.

Member Function Documentation

◆ ComputeNextValue()

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

◆ Reset()

override void QuantConnect.Indicators.SchaffTrendCycle.Reset ( )

Resets this indicator to its initial state

Definition at line 131 of file SchaffTrendCycle.cs.

Member Data Documentation

◆ IsReady

override bool QuantConnect.Indicators.SchaffTrendCycle.IsReady => _MACD.IsReady

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

Definition at line 43 of file SchaffTrendCycle.cs.

Property Documentation

◆ WarmUpPeriod

int QuantConnect.Indicators.SchaffTrendCycle.WarmUpPeriod
get

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

Definition at line 48 of file SchaffTrendCycle.cs.


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