com.agi.moxie.delegates.core

Interface FixedScalarValue

All Superinterfaces:

ComparableDiscreteModelType<ScalarValue>, ScalarValue, Thing

All Known Implementing Classes:

DefaultScalarValue

public interface FixedScalarValue
extends ScalarValue, ComparableDiscreteModelType<ScalarValue>

This represents a single constant double value as a scalar.

Method Summary

Modifier and Type	Method and Description
default DiscreteValue<Integer>	compareDiscreteValue(ScalarValue value) Compares the discretely time varying internal state of this model against the provided value.
double	getValue() This is a helper method to get the underlying value of the scalar.
default double	getValueAt(MoxieTime time) Gets the current value of the ScalarValue at the requested time.
default BooleanValue	isEqualTo(ScalarValue rhs) Returns a BooleanValue that is true when the value of this instance is strictly equal to the value of the provided ScalarValue.
default BooleanValue	isGreaterThan(ScalarValue rhs) Returns a BooleanValue that is true when the value of this instance is strictly greater than the value of the provided ScalarValue.
default BooleanValue	isLessThan(ScalarValue rhs) Returns a BooleanValue that is true when the value of this instance is strictly less than the value of the provided ScalarValue.
default ScalarValue	minus(ScalarValue rhs) Subtracts the value of the provided ScalarValue from this one to produce a new instance representing the difference of the two.
default ScalarValue	negate() Produces a new value that is the negative of this one.
default ScalarValue	plus(ScalarValue rhs) Adds the value of the provided ScalarValue to this one to produce a new instance representing the sum of both.
default ScalarValue	times(ScalarValue rhs) Multiplies the value of the provided ScalarValue to this one to produce a new instance representing the product of the two.
Property<Double>	valueProperty() Returns the value associated with this ScalarValue.

Methods inherited from interface com.agi.moxie.delegates.core.ScalarValue

constant, isEqualTo, isGreaterThan, isLessThan, minus, plus, times, within, within

Method Detail

getValue

double getValue()

This is a helper method to get the underlying value of the scalar.

Returns:

The underlying value of the scalar.

valueProperty

Property<Double> valueProperty()

Returns the value associated with this ScalarValue.

Returns:

The value associated with this ScalarValue.

compareDiscreteValue

default DiscreteValue<Integer> compareDiscreteValue(ScalarValue value)

Description copied from interface: ComparableDiscreteModelType

Compares the discretely time varying internal state of this model against the provided value. The result is a DiscreteValue type representing the aggregate comparisons of all of the discrete states represented by this object as they compare against the provided value. The data contained in the DiscreteValue must follow the same behavior as Comparable.

A negative integer indicates that a particular discrete value is less than the provided value.

A positive integer indicates that a particular discrete value is greater than the provided value.

Zero indicates that the values are identical.

Specified by:

compareDiscreteValue in interface ComparableDiscreteModelType<ScalarValue>

Parameters:

value - The value to compare against.

Returns:

An instance representing the comparison of every discrete value represented by this instance against the provided value.

isLessThan

default BooleanValue isLessThan(ScalarValue rhs)

Description copied from interface: ScalarValue

Returns a BooleanValue that is true when the value of this instance is strictly less than the value of the provided ScalarValue.

Specified by:

isLessThan in interface ScalarValue

Parameters:

rhs - The value that represents the scalar to test against.

Returns:

A BooleanValue representing whether the current scalar value is less than the value provided.

isGreaterThan

default BooleanValue isGreaterThan(ScalarValue rhs)

Description copied from interface: ScalarValue

Returns a BooleanValue that is true when the value of this instance is strictly greater than the value of the provided ScalarValue.

Specified by:

isGreaterThan in interface ScalarValue

Parameters:

rhs - The value that represents the scalar to test against.

Returns:

A BooleanValue representing whether the current scalar value is greater than the value provided.

isEqualTo

default BooleanValue isEqualTo(ScalarValue rhs)

Description copied from interface: ScalarValue

Returns a BooleanValue that is true when the value of this instance is strictly equal to the value of the provided ScalarValue.

Specified by:

isEqualTo in interface ScalarValue

Parameters:

rhs - The value that represents the scalar to test against.

Returns:

A BooleanValue representing whether the current scalar value is equal to the value provided.

negate

default ScalarValue negate()

Description copied from interface: ScalarValue

Produces a new value that is the negative of this one. This is equivalent to calling times(-1.0) on this instance.

Specified by:

negate in interface ScalarValue

Returns:

A ScalarValue representing the negative of the current value.

plus

default ScalarValue plus(ScalarValue rhs)

Description copied from interface: ScalarValue

Adds the value of the provided ScalarValue to this one to produce a new instance representing the sum of both.

Specified by:

plus in interface ScalarValue

Parameters:

rhs - The value to add to the current ScalarValue.

Returns:

A ScalarValue representing the sum of the two values.

minus

default ScalarValue minus(ScalarValue rhs)

Description copied from interface: ScalarValue

Subtracts the value of the provided ScalarValue from this one to produce a new instance representing the difference of the two.

Specified by:

minus in interface ScalarValue

Parameters:

rhs - The value to subtract from the current ScalarValue.

Returns:

A ScalarValue representing the differences of the two values.

times

default ScalarValue times(ScalarValue rhs)

Description copied from interface: ScalarValue

Multiplies the value of the provided ScalarValue to this one to produce a new instance representing the product of the two.

Specified by:

times in interface ScalarValue

Parameters:

rhs - The value to multiply to the current ScalarValue.

Returns:

A ScalarValue representing the product of the two values.

getValueAt

default double getValueAt(MoxieTime time)

Description copied from interface: ScalarValue

Gets the current value of the ScalarValue at the requested time.

Specified by:

getValueAt in interface ScalarValue

Parameters:

time - The time that you are interested in obtaining the value at.

Returns:

The current value of the ScalarValue at the given time.