Represents an indicator capable of tracking the maximum value and how many periods ago it occurred More...
Public Member Functions | |
| Maximum (int period) | |
| Creates a new Maximum indicator with the specified period More... | |
| Maximum (string name, int period) | |
| Creates a new Maximum indicator with the specified period More... | |
| override void | Reset () |
| Resets this indicator to its initial state 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 => 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) |
| 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... | |
Properties | |
| int | PeriodsSinceMaximum [get] |
| The number of periods since the maximum value was encountered 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
Represents an indicator capable of tracking the maximum value and how many periods ago it occurred
Definition at line 23 of file Maximum.cs.
Constructor & Destructor Documentation
◆ Maximum() [1/2]
| QuantConnect.Indicators.Maximum.Maximum | ( | int | period | ) |
Creates a new Maximum indicator with the specified period
- Parameters
-
period The period over which to look back
Definition at line 44 of file Maximum.cs.
◆ Maximum() [2/2]
| QuantConnect.Indicators.Maximum.Maximum | ( | string | name, |
| int | period | ||
| ) |
Creates a new Maximum indicator with the specified period
- Parameters
-
name The name of this indicator period The period over which to look back
Definition at line 54 of file Maximum.cs.
Member Function Documentation
◆ Reset()
| override void QuantConnect.Indicators.Maximum.Reset | ( | ) |
Resets this indicator to its initial state
Definition at line 99 of file Maximum.cs.
Member Data Documentation
◆ IsReady
| override bool QuantConnect.Indicators.Maximum.IsReady => Samples >= Period |
Gets a flag indicating when this indicator is ready and fully initialized
Definition at line 33 of file Maximum.cs.
◆ WarmUpPeriod
| int QuantConnect.Indicators.Maximum.WarmUpPeriod => Period |
Required period, in data points, for the indicator to be ready and fully initialized.
Definition at line 38 of file Maximum.cs.
Property Documentation
◆ PeriodsSinceMaximum
|
get |
The number of periods since the maximum value was encountered
Definition at line 28 of file Maximum.cs.
The documentation for this class was generated from the following file:
- Indicators/Maximum.cs
