Package com.amalgamasimulation.studies.result

Class ResultPiecewiseFunctionValue

java.lang.Object

com.amalgamasimulation.studies.result.ResultElement

com.amalgamasimulation.studies.result.ResultPiecewiseFunctionValue

All Implemented Interfaces:

ResultValue

public class ResultPiecewiseFunctionValue
extends ResultElement
implements ResultValue

A result element representing a piecewise function value. Extends ResultElement and implements ResultValue to provide piecewise function storage and display capabilities within a hierarchical result structure.

This class supports the storage of a PiecewiseFunction and formatting configuration through DoubleFormats.

Constructor Summary

Constructors

Constructor	Description
ResultPiecewiseFunctionValue(PiecewiseFunction value)	Constructs a new ResultPiecewiseFunctionValue with the specified piecewise function.

Method Summary

Modifier and Type	Method	Description
Function<Double,String>	format()	Gets the current formatter function based on the configured format.
ResultPiecewiseFunctionValue	format(DoubleFormats format)	Sets the display format for numeric outputs from this piecewise function.
DoubleFormats	getFormat()	Gets the current display format for numeric outputs.
ResultPiecewiseFunctionValue	id(String id)	Sets the identifier for this element.
PiecewiseFunction	value()	Gets the PiecewiseFunction 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

Constructor Details

ResultPiecewiseFunctionValue

public ResultPiecewiseFunctionValue(PiecewiseFunction value)

Constructs a new ResultPiecewiseFunctionValue with the specified piecewise function.

Parameters:

value - the piecewise function value (cannot be null)

Throws:

NullPointerException - if the value parameter is null

Method Details

value

public PiecewiseFunction value()

Gets the PiecewiseFunction value of this element.

Specified by:

value in interface ResultValue

Returns:

the piecewise function value

format

public Function<Double,String> format()

Gets the current formatter function based on the configured format. The formatter will be used to format numeric outputs from the piecewise function. Default format DoubleFormats.KMB.

Returns:

a function that formats double values according to the current format

format

public ResultPiecewiseFunctionValue format(DoubleFormats format)

Sets the display format for numeric outputs from this piecewise function.

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 numeric outputs. Default format DoubleFormats.KMB.

Returns:

the current format setting

id

public ResultPiecewiseFunctionValue 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