Lean  $LEAN_TAG$
QuantConnect.Indicators.ResetCompositeIndicator Class Reference

Class that extends CompositeIndicator to execute a given action once is reset More...

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

Public Member Functions

 ResetCompositeIndicator (IndicatorBase left, IndicatorBase right, IndicatorComposer composer, Action extraResetAction)
 Creates a new ResetCompositeIndicator capable of taking the output from the left and right indicators and producing a new value via the composer delegate specified More...
 
 ResetCompositeIndicator (string name, IndicatorBase left, IndicatorBase right, IndicatorComposer composer, Action extraResetAction)
 Creates a new CompositeIndicator capable of taking the output from the left and right indicators and producing a new value via the composer delegate specified More...
 
override void Reset ()
 Resets this indicator and invokes the given reset action More...
 
- Public Member Functions inherited from QuantConnect.Indicators.CompositeIndicator
delegate IndicatorResult IndicatorComposer (IndicatorBase left, IndicatorBase right)
 Delegate type used to compose the output of two indicators into a new value. More...
 
override void Reset ()
 Resets this indicator to its initial state More...
 
 CompositeIndicator (string name, IndicatorBase left, IndicatorBase right, IndicatorComposer composer)
 Creates a new CompositeIndicator capable of taking the output from the left and right indicators and producing a new value via the composer delegate specified More...
 
 CompositeIndicator (IndicatorBase left, IndicatorBase right, IndicatorComposer composer)
 Creates a new CompositeIndicator capable of taking the output from the left and right indicators and producing a new value via the composer delegate specified More...
 

Additional Inherited Members

- Protected Member Functions inherited from QuantConnect.Indicators.CompositeIndicator
override IndicatorResult ValidateAndComputeNextValue (IndicatorDataPoint input)
 Computes the next value of this indicator from the given state and returns an instance of the IndicatorResult class More...
 
override decimal ComputeNextValue (IndicatorDataPoint _)
 Computes the next value of this indicator from the given state More...
 
- Properties inherited from QuantConnect.Indicators.CompositeIndicator
IndicatorBase Left [get]
 Gets the 'left' indicator for the delegate More...
 
IndicatorBase Right [get]
 Gets the 'right' indicator for the delegate More...
 
override bool IsReady [get]
 Gets a flag indicating when this indicator is ready and fully initialized More...
 

Detailed Description

Class that extends CompositeIndicator to execute a given action once is reset

Definition at line 23 of file ResetCompositeIndicator.cs.

Constructor & Destructor Documentation

◆ ResetCompositeIndicator() [1/2]

QuantConnect.Indicators.ResetCompositeIndicator.ResetCompositeIndicator ( IndicatorBase  left,
IndicatorBase  right,
IndicatorComposer  composer,
Action  extraResetAction 
)

Creates a new ResetCompositeIndicator capable of taking the output from the left and right indicators and producing a new value via the composer delegate specified

Parameters
leftThe left indicator for the 'composer'
rightThe right indicator for the 'composer'
composerFunction used to compose the left and right indicators
extraResetActionAction to execute once the composite indicator is reset

Definition at line 38 of file ResetCompositeIndicator.cs.

◆ ResetCompositeIndicator() [2/2]

QuantConnect.Indicators.ResetCompositeIndicator.ResetCompositeIndicator ( string  name,
IndicatorBase  left,
IndicatorBase  right,
IndicatorComposer  composer,
Action  extraResetAction 
)

Creates a new CompositeIndicator capable of taking the output from the left and right indicators and producing a new value via the composer delegate specified

Parameters
nameThe name of this indicator
leftThe left indicator for the 'composer'
rightThe right indicator for the 'composer'
composerFunction used to compose the left and right indicators
extraResetActionAction to execute once the indicator is reset

Definition at line 52 of file ResetCompositeIndicator.cs.

Member Function Documentation

◆ Reset()

override void QuantConnect.Indicators.ResetCompositeIndicator.Reset ( )

Resets this indicator and invokes the given reset action

Definition at line 61 of file ResetCompositeIndicator.cs.


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