Lean  $LEAN_TAG$
QuantConnect.Indicators.Identity Class Reference

Represents an indicator that is a ready after ingesting a single sample and always returns the same value as it is given. More...

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

Public Member Functions

 Identity (string name)
 Initializes a new instance of the Identity indicator with the specified name More...
 

Public Attributes

int WarmUpPeriod => 1
 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...
 

Properties

override bool IsReady [get]
 Gets a flag indicating when this indicator is 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

Represents an indicator that is a ready after ingesting a single sample and always returns the same value as it is given.

Definition at line 22 of file Identity.cs.

Constructor & Destructor Documentation

◆ Identity()

QuantConnect.Indicators.Identity.Identity ( string  name)

Initializes a new instance of the Identity indicator with the specified name

Parameters
nameThe name of the indicator

Definition at line 28 of file Identity.cs.

Member Function Documentation

◆ ComputeNextValue()

override decimal QuantConnect.Indicators.Identity.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 Identity.cs.

Member Data Documentation

◆ WarmUpPeriod

int QuantConnect.Indicators.Identity.WarmUpPeriod => 1

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

Definition at line 44 of file Identity.cs.

Property Documentation

◆ IsReady

override bool QuantConnect.Indicators.Identity.IsReady
get

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

Definition at line 37 of file Identity.cs.


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