org.jcpsim.plot
Class ResultParameter

java.lang.Object
  org.jcpsim.plot.ResultParameter

Direct Known Subclasses:

RbResultParameter

public abstract class ResultParameter
extends java.lang.Object

Constructor Summary

ResultParameter(java.lang.String name, java.lang.String type, java.lang.String unit, double min, double max)

Method Summary

abstract double	get() Gets the actual element.
abstract double	get(int i) Retrieves a value from the buffer.
double	getMax()
double	getMin()
java.lang.String	getName()
double	getTrimmed()
java.lang.String	getType()
java.lang.String	getTypeWithUnit()
java.lang.String	getUnit()
abstract boolean	isEmpty()
abstract void	put(double item) Writes a value to the buffer.
abstract int	size()
double	trim(double x)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultParameter

public ResultParameter(java.lang.String name,
                       java.lang.String type,
                       java.lang.String unit,
                       double min,
                       double max)

Method Detail

getName

public java.lang.String getName()

getType

public java.lang.String getType()

getTypeWithUnit

public java.lang.String getTypeWithUnit()

getUnit

public java.lang.String getUnit()

getMin

public double getMin()

getMax

public double getMax()

trim

public double trim(double x)

getTrimmed

public double getTrimmed()

isEmpty

public abstract boolean isEmpty()

size

public abstract int size()

put

public abstract void put(double item)

Writes a value to the buffer.

Parameters:

item - the value

get

public abstract double get()

Gets the actual element. Does not check if the buffer is empty (for sake of speed).

Returns:

the newest (= actual) element

get

public abstract double get(int i)

Retrieves a value from the buffer. To read all values:

for (int i=0; i.


Parameters:
i - 0: the newest value in the buffer;
          1: the newest but one value;
          size()-1: the oldest value
Returns:
the value