Class ClampPredicateRTIndicator

java.lang.Object

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

com.wualabs.qtsurfer.engine.indicators.core.AbstractDecorableRTIndicator

com.wualabs.qtsurfer.engine.indicators.numeric.ClampPredicateRTIndicator

All Implemented Interfaces:

Resettable, RTIndicator

public class ClampPredicateRTIndicator
extends AbstractDecorableRTIndicator

Allow to apply a predicate function to colapse/clamp to a single value

Constructor Summary

Constructors

Constructor	Description
ClampPredicateRTIndicator(@NonNull RTIndicator indicator, @NonNull Predicate<Double> clampPredicate, @NonNull Number clampValue)

Method Summary

Modifier and Type	Method	Description
static ClampPredicateRTIndicator	absEqual(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
static ClampPredicateRTIndicator	absGreatOrEqual(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
static ClampPredicateRTIndicator	absGreatThan(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
static ClampPredicateRTIndicator	absLessOrEqual(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
static ClampPredicateRTIndicator	absLessThan(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
static ClampPredicateRTIndicator	absNotEqual(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
ClampPredicateRTIndicator	clampTo(@NonNull Number clampValue)
static ClampPredicateRTIndicator	equal(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
double	getClampValue()
static ClampPredicateRTIndicator	greatOrEqual(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
static ClampPredicateRTIndicator	greatThan(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
static ClampPredicateRTIndicator	lessOrEqual(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
static ClampPredicateRTIndicator	lessThan(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
static ClampPredicateRTIndicator	notEqual(RTIndicator indicator, @NonNull Number coefficient, @NonNull Number clampValue)
final double	update(double newValue)	Updates the decorated indicator and tests the result against the clamp predicate.

Methods inherited from class AbstractDecorableRTIndicator

getIndicator, getIndicatorValue

Methods inherited from class AbstractRTIndicator

equals, getDisplayHint, getMeta, getValue, hashCode, hide, isPoison, reset, 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, isReady, ro, update, update

Constructor Details

ClampPredicateRTIndicator

public ClampPredicateRTIndicator(@NonNull
 @NonNull RTIndicator indicator,
 @NonNull
 @NonNull Predicate<Double> clampPredicate,
 @NonNull
 @NonNull Number clampValue)

Method Details

clampTo

public ClampPredicateRTIndicator clampTo(@NonNull
 @NonNull Number clampValue)

update

public final double update(double newValue)

Updates the decorated indicator and tests the result against the clamp predicate. If the predicate matches, the output is replaced with the fixed clamp value; otherwise, the indicator's actual value is used.

Specified by:

update in interface RTIndicator

Overrides:

update in class AbstractRTIndicator

Parameters:

newValue - the new input value

Returns:

the clamped value if predicate matches, otherwise the indicator's computed value

equal

public static ClampPredicateRTIndicator equal(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

absEqual

public static ClampPredicateRTIndicator absEqual(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

notEqual

public static ClampPredicateRTIndicator notEqual(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

absNotEqual

public static ClampPredicateRTIndicator absNotEqual(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

lessThan

public static ClampPredicateRTIndicator lessThan(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

absLessThan

public static ClampPredicateRTIndicator absLessThan(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

lessOrEqual

public static ClampPredicateRTIndicator lessOrEqual(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

absLessOrEqual

public static ClampPredicateRTIndicator absLessOrEqual(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

greatThan

public static ClampPredicateRTIndicator greatThan(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

absGreatThan

public static ClampPredicateRTIndicator absGreatThan(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

greatOrEqual

public static ClampPredicateRTIndicator greatOrEqual(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

absGreatOrEqual

public static ClampPredicateRTIndicator absGreatOrEqual(RTIndicator indicator,
 @NonNull
 @NonNull Number coefficient,
 @NonNull
 @NonNull Number clampValue)

getClampValue

public double getClampValue()