simudyne.core.graph

Interface DoubleAccumulator

All Superinterfaces:

JSONValue

public interface DoubleAccumulator
extends JSONValue

Method Summary

Modifier and Type	Method and Description
void	add(double v)
long	count()
default com.fasterxml.jackson.databind.JsonNode	getSchema(com.fasterxml.jackson.databind.node.JsonNodeFactory factory) Defines the avro schema for the result of reading this datatype as JSON.
double	mean()
default void	reset() Reset the accumulator to 0.
DoubleAccumulator	setPersistent(boolean v) make the accumulator persitent for beginStep.
double	value()

Methods inherited from interface simudyne.core.JSONValue

emitJSON, getRecord, getValues, receiveJSON

Method Detail

value

double value()

Returns:

the cached value of the double accumulator. This cached value is updated between every message phase. For synchronization issues, it is not possible to get the live value of the accumulator

mean

double mean()

Returns:

the mean of the elements added to the accumulator

add

void add(double v)

Parameters:

v - value to add to the accumulator

count

long count()

Returns:

the number of elements added to the accumulator

setPersistent

DoubleAccumulator setPersistent(boolean v)

make the accumulator persitent for beginStep.

reset

default void reset()

Reset the accumulator to 0. Cannot be called from within an agent environment.

getSchema

default com.fasterxml.jackson.databind.JsonNode getSchema(com.fasterxml.jackson.databind.node.JsonNodeFactory factory)

Description copied from interface: JSONValue

Defines the avro schema for the result of reading this datatype as JSON. Provides a JSON node to add the schema to. The JSON node provided includes the name of the JSON field, this method should add the type and fields.

Specified by:

getSchema in interface JSONValue

Parameters:

factory - Jackson ObjectNode for constructing output JSON nodes.

Returns:

A JsonNode representing the schema as JSON.