Class AbstractDecorableIncrementalRTIndicator

java.lang.Object

com.wualabs.qtsurfer.engine.indicators.core.AbstractRTIndicator

com.wualabs.qtsurfer.engine.indicators.core.AbstractIncrementalRTIndicator

com.wualabs.qtsurfer.engine.indicators.core.AbstractDecorableIncrementalRTIndicator

All Implemented Interfaces:

ClockAware, Resettable, RTIndicator

Direct Known Subclasses:

AbstractEmaRTIndicator, AtomicCountRTIndicator, CountRTIndicator, FundingRateRTIndicator, MacdRTIndicator, MaxRTIndicator, MinRTIndicator, OnChangeRTIndicator, PercentChangePeriodRTIndicator, PeriodCounterRTIndicator, RateChangeRTIndicator, RsiRTIndicator, SmaRTIndicator, StochasticRsiRTIndicator, TickerRTIndicator, VarianceRTIndicator

public abstract class AbstractDecorableIncrementalRTIndicator
extends AbstractIncrementalRTIndicator
implements ClockAware

Incremental indicator that optionally decorates (wraps) another indicator. When a decorated indicator is present, incoming values are first passed through it before being processed by this indicator's incremental logic. This enables chaining, e.g., an SMA wrapping a GainRTIndicator. Propagates clock and reset to the decorated child.

Constructor Summary

Constructors

Constructor	Description
AbstractDecorableIncrementalRTIndicator()
AbstractDecorableIncrementalRTIndicator(int periods)
AbstractDecorableIncrementalRTIndicator(int periods, RTIndicator indicator)
AbstractDecorableIncrementalRTIndicator(RTIndicator indicator)

Method Summary

Modifier and Type	Method	Description
<T extends RTIndicator> T	getIndicator()
protected double	nextValue(double prevValue, double newValue)	Computes the next indicator value from the previous and new input values.
void	reset()
void	setClockSupplier(Supplier<Clock> clockSupplier)
double	update(double newValue)	Passes the value through the decorated indicator (if present) before feeding the result into this indicator's incremental update pipeline.

Methods inherited from class AbstractIncrementalRTIndicator

getLastUpdateValue, getPeriodCycles, getPeriods, getPrevValue, initValue, isPeriodic, isReady, prevNextValue, setPeriods, tickValue

Methods inherited from class AbstractRTIndicator

equals, getDisplayHint, getMeta, getValue, hashCode, hide, isPoison, setValue, toString, toString, withDisplayHint, withMeta

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface RTIndicator

getId, isHidden, ro, update, update

Constructor Details

AbstractDecorableIncrementalRTIndicator

public AbstractDecorableIncrementalRTIndicator()

AbstractDecorableIncrementalRTIndicator

public AbstractDecorableIncrementalRTIndicator(int periods)

AbstractDecorableIncrementalRTIndicator

public AbstractDecorableIncrementalRTIndicator(RTIndicator indicator)

AbstractDecorableIncrementalRTIndicator

public AbstractDecorableIncrementalRTIndicator(int periods,
 RTIndicator indicator)

Method Details

reset

public void reset()

Specified by:

reset in interface Resettable

Overrides:

reset in class AbstractIncrementalRTIndicator

getIndicator

public <T extends RTIndicator> T getIndicator()

setClockSupplier

public void setClockSupplier(Supplier<Clock> clockSupplier)

Specified by:

setClockSupplier in interface ClockAware

update

public double update(double newValue)

Passes the value through the decorated indicator (if present) before feeding the result into this indicator's incremental update pipeline.

Specified by:

update in interface RTIndicator

Overrides:

update in class AbstractIncrementalRTIndicator

Parameters:

newValue - the raw input value

Returns:

the computed value after decoration and incremental processing

nextValue

protected double nextValue(double prevValue,
 double newValue)

Description copied from class: AbstractIncrementalRTIndicator

Computes the next indicator value from the previous and new input values. This is the core calculation method that subclasses must implement.

Specified by:

nextValue in class AbstractIncrementalRTIndicator

Parameters:

prevValue - the previous indicator value (or last update value, depending on override)

newValue - the new input value

Returns:

the computed indicator value