Package com.amalgamasimulation.studies.result

Class ResultDoubleValue

java.lang.Object

com.amalgamasimulation.studies.result.ResultElement

com.amalgamasimulation.studies.result.ResultDoubleValue

All Implemented Interfaces:

ResultValue

Direct Known Subclasses:

SummaryResultGroup

public class ResultDoubleValue
extends ResultElement
implements ResultValue

A result element representing a double precision floating-point value. Extends ResultElement and implements ResultValue to provide numeric value functionality within a hierarchical result structure.

This class provides methods to get and set the double value. It also provides formatting capabilities through the DoubleFormats enum.

Field Summary

Fields

Modifier and Type	Field	Description
protected Supplier<Double>	valueSupplier

Constructor Summary

Constructors

Constructor	Description
ResultDoubleValue(double value)	Constructs a new ResultDoubleValue with the specified value.
ResultDoubleValue(Supplier<Double> valueSupplier)	Constructs a new ResultDoubleValue with a value supplier for lazy initialization.

Method Summary

Modifier and Type	Method	Description
Function<Double,String>	format()	Gets the current formatter function based on the configured format.
ResultDoubleValue	format(DoubleFormats format)	Sets the display format for this value.
DoubleFormats	getFormat()	Gets the current display format for this value.
ResultDoubleValue	id(String id)	Sets the identifier for this element.
Double	value()	Gets the double value of this element.

Methods inherited from class com.amalgamasimulation.studies.result.ResultElement

children, descendants, element, element, element, element, element, element, element, element, element, element, find, findByTags, findOrThrow, findOrThrow, getChildrenDoubleResults, getChildrenDoubleResults, getChildrenGroups, getChildrenGroups, getDateTimeOrThrow, getDateTimeOrThrow, getFunctionOrDefault, getFunctionOrThrow, getGroupOrThrow, getOrDefault, getOrThrow, getOrThrow, getStringOrThrow, getStringOrThrow, group, group, hasSiblingWithSameId, id, id, parent, path, root, setParent, summaryResultGroup, summaryResultGroup, tag, tags

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amalgamasimulation.studies.result.ResultValue

path

Field Details

valueSupplier

protected Supplier<Double> valueSupplier

Constructor Details

ResultDoubleValue

public ResultDoubleValue(double value)

Constructs a new ResultDoubleValue with the specified value.

Parameters:

value - the double value to store

ResultDoubleValue

public ResultDoubleValue(Supplier<Double> valueSupplier)

Constructs a new ResultDoubleValue with a value supplier for lazy initialization. The supplier will be called exactly once when the value is first requested.

Parameters:

valueSupplier - the supplier providing the double value (cannot be null)

Throws:

NullPointerException - if the valueSupplier parameter is null

Method Details

value

public Double value()

Gets the double value of this element. If constructed with a supplier, this will trigger the first (and only) call to the supplier.

Specified by:

value in interface ResultValue

Returns:

the double value, which may be Double.NaN

format

public Function<Double,String> format()

Gets the current formatter function based on the configured format.

Returns:

a function that formats double values according to the current format

format

public ResultDoubleValue format(DoubleFormats format)

Sets the display format for this value.

Parameters:

format - the format to use (cannot be null)

Returns:

this element for method chaining

Throws:

NullPointerException - if the format parameter is null

getFormat

public DoubleFormats getFormat()

Gets the current display format for this value. Default format DoubleFormats.KMB.

Returns:

the current format setting

id

public ResultDoubleValue id(String id)

Description copied from class: ResultElement

Sets the identifier for this element. The ID must be unique among siblings.

Overrides:

id in class ResultElement

Parameters:

id - the unique identifier for this element

Returns:

this element for method chaining