Lean  $LEAN_TAG$
QuantConnect.Indicators.IndicatorResult Class Reference

Represents the result of an indicator's calculations More...

Public Member Functions

 IndicatorResult (decimal value, IndicatorStatus status=IndicatorStatus.Success)
 Initializes a new instance of the IndicatorResult class More...
 

Static Public Member Functions

static implicit operator IndicatorResult (decimal value)
 Converts the specified decimal value into a successful indicator result More...
 

Properties

decimal Value [get]
 The indicator output value More...
 
IndicatorStatus Status [get]
 The indicator status More...
 

Detailed Description

Represents the result of an indicator's calculations

Definition at line 21 of file IndicatorResult.cs.

Constructor & Destructor Documentation

◆ IndicatorResult()

QuantConnect.Indicators.IndicatorResult.IndicatorResult ( decimal  value,
IndicatorStatus  status = IndicatorStatus.Success 
)

Initializes a new instance of the IndicatorResult class

Parameters
valueThe value output by the indicator
statusThe status returned by the indicator

Definition at line 46 of file IndicatorResult.cs.

Here is the caller graph for this function:

Member Function Documentation

◆ operator IndicatorResult()

static implicit QuantConnect.Indicators.IndicatorResult.operator IndicatorResult ( decimal  value)
static

Converts the specified decimal value into a successful indicator result

This method is provided for backwards compatibility

Parameters
valueThe decimal value to be converted into an IndicatorResult

Definition at line 59 of file IndicatorResult.cs.

Here is the call graph for this function:

Property Documentation

◆ Value

decimal QuantConnect.Indicators.IndicatorResult.Value
get

The indicator output value

Definition at line 27 of file IndicatorResult.cs.

◆ Status

IndicatorStatus QuantConnect.Indicators.IndicatorResult.Status
get

The indicator status

Definition at line 36 of file IndicatorResult.cs.


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