info.monitorenter.gui.chart.traces.computing
Class Trace2DArithmeticMeanY

java.lang.Object
  info.monitorenter.gui.chart.traces.ATrace2D
      info.monitorenter.gui.chart.traces.computing.Trace2DArithmeticMeanY

All Implemented Interfaces:

ITrace2D, java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Comparable<ITrace2D>, java.util.EventListener

public class Trace2DArithmeticMeanY
extends ATrace2D

A trace that accumulates the latest n y values added to points with the arithmetic mean y value and the latest x value.

This trace will not reduce the amount of n points added to one carrying the arithmetic mean but always add a point that has the average of the recent added n points.

Please note that this trace scan be used in two modes:

1. Stand alone:
   Add the ITrace2D implementation to a chart and add data points to it as normal.
2. Computing trace:
   Add the ITrace2D implementation as a computing trace to an existing trace via ITrace2D.addComputingTrace(info.monitorenter.gui.chart.ITrace2D) and only add data points to the original trace. Add the computing trace to the same chart and updates of the original trace will be reflected on the computing trace as well.

Version:

$Revision: 1.4 $

Author:

Achim Westermann

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface info.monitorenter.gui.chart.ITrace2D

ITrace2D.DistancePoint

Field Summary

Fields inherited from class info.monitorenter.gui.chart.traces.ATrace2D

m_computingTraces, m_maxX, m_maxXErrorBar, m_maxY, m_maxYErrorBar, m_minX, m_minXErrorBar, m_minY, m_minYErrorBar, m_name, m_physicalUnitsX, m_physicalUnitsY, m_propertyChangeSupport, m_renderer

Fields inherited from interface info.monitorenter.gui.chart.ITrace2D

PROPERTY_COLOR, PROPERTY_ERRORBARPOLICY, PROPERTY_ERRORBARPOLICY_CONFIGURATION, PROPERTY_LABEL, PROPERTY_MAX_X, PROPERTY_MAX_Y, PROPERTY_MIN_X, PROPERTY_MIN_Y, PROPERTY_NAME, PROPERTY_PAINTERS, PROPERTY_PHYSICALUNITS, PROPERTY_POINT_CHANGED, PROPERTY_POINT_HIGHLIGHTERS_CHANGED, PROPERTY_STROKE, PROPERTY_TRACEPOINT, PROPERTY_VISIBLE, PROPERTY_ZINDEX, Z_INDEX_MIN, ZINDEX_MAX

Constructor Summary

Trace2DArithmeticMeanY(int arithmenticMeanSpan)
The amount of n recent points to buffer.

Method Summary

protected boolean	addPointInternal(ITracePoint2D p) Override this template method for the custom add operation that depends on the policies of the implementation.
int	getMaxSize() Returns the maximum amount of TracePoint2D instances that may be added.
int	getSize() Returns the amount of TracePoint2D instances currently contained.
boolean	isEmpty() Returns false if internal TracePoint2D instances are contained or true if not.
java.util.Iterator<ITracePoint2D>	iterator() Returns an Iterator over the internal TracePoint2D instances.
protected void	removeAllPointsInternal() Override this template method for the custom remove operation that depends on the Collection used in the implementation.
protected ITracePoint2D	removePointInternal(ITracePoint2D point) Override this template method for the custom remove operation that depends on the internal storage the implementation.

Methods inherited from class info.monitorenter.gui.chart.traces.ATrace2D

addComputingTrace, addErrorBarPolicy, addPoint, addPoint, addPointHighlighter, addPropertyChangeListener, addTracePainter, compareTo, containsTracePainter, ensureInitialized, finalize, firePointAdded, firePointChanged, firePointRemoved, firePropertyChange, getChangeListeners, getColor, getErrorBarPolicies, getHasErrorBars, getInstanceCount, getLabel, getMaxX, getMaxY, getMinX, getMinY, getName, getNearestPointEuclid, getNearestPointManhattan, getPhysicalUnits, getPhysicalUnitsX, getPhysicalUnitsY, getPointHighlighters, getPropertyChangeListeners, getRenderer, getStroke, getTracePainters, getZIndex, isVisible, maxXSearch, maxYSearch, minXSearch, minYSearch, propertyChange, removeAllPointHighlighters, removeAllPoints, removeComputingTrace, removeErrorBarPolicy, removePoint, removePointHighlighter, removePropertyChangeListener, removePropertyChangeListener, removeTracePainter, setColor, setErrorBarPolicy, setName, setPhysicalUnits, setPointHighlighter, setRenderer, setStroke, setTracePainter, setVisible, setZIndex, showsErrorBars, showsNegativeXErrorBars, showsNegativeYErrorBars, showsPositiveXErrorBars, showsPositiveYErrorBars, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Trace2DArithmeticMeanY

public Trace2DArithmeticMeanY(int arithmenticMeanSpan)

The amount of n recent points to buffer. private int m_pointBufferSize; /** Constructor with the given amount of points to merge into one point with their arithmetic mean.

Parameters:

arithmenticMeanSpan - the amount of points to merge into one point with their arithmetic mean.

Method Detail

addPointInternal

protected boolean addPointInternal(ITracePoint2D p)

Description copied from class: ATrace2D

Override this template method for the custom add operation that depends on the policies of the implementation.

No property change events have to be fired by default. If this method returns true the outer logic of the calling method ATrace2D.addPoint(ITracePoint2D) will perform bound checks for the new point and fire property changes as described in method ATrace2D.firePointChanged(ITracePoint2D, int).

In special cases - when additional modifications to the internal set of points take place (e.g. a further point gets removed) this method should return false (regardless whether the new point was accepted or not) and perform bound checks and fire the property changes as mentioned above "manually".

Specified by:

addPointInternal in class ATrace2D

Parameters:

p - the point to add.

Returns:

true if the given point was accepted or false if not.

See Also:

ATrace2D.addPointInternal(info.monitorenter.gui.chart.ITracePoint2D)

getMaxSize

public int getMaxSize()

Description copied from interface: ITrace2D

Returns the maximum amount of TracePoint2D instances that may be added. For implementations that limit the maximum amount this is a reasonable amount. Non-limiting implementations should return Integer.MAX_VALUE. This allows to detect the unlimitedness. Of course no implementation could store that amount of points.

Returns:

The maximum amount of TracePoint2D instances that may be added.

See Also:

ITrace2D.getMaxSize()

getSize

public int getSize()

Description copied from interface: ITrace2D

Returns the amount of TracePoint2D instances currently contained.

Returns:

The amount of TracePoint2D instances currently contained.

See Also:

ITrace2D.getSize()

isEmpty

public boolean isEmpty()

Description copied from interface: ITrace2D

Returns false if internal TracePoint2D instances are contained or true if not.

Returns:

false if internal TracePoint2D instances are contained or true if not.

See Also:

ITrace2D.isEmpty()

iterator

public java.util.Iterator<ITracePoint2D> iterator()

Description copied from interface: ITrace2D

Returns an Iterator over the internal TracePoint2D instances.

Implementations should be synchronized. This method is meant to allow modifications of the intenal TracePoint2D instances, so the original points should be returned.

There is no guarantee that changes made to the contained tracepoints will be reflected in the display immediately. The order the iterator returns the TracePoint2D instances decides how the Chart2D will paint the trace.

Returns:

an Iterator over the internal TracePoint2D instances.

See Also:

ITrace2D.iterator()

removeAllPointsInternal

protected void removeAllPointsInternal()

Description copied from class: ATrace2D

Override this template method for the custom remove operation that depends on the Collection used in the implementation.

No change events have to be fired, this is done by ATrace2D.

Specified by:

removeAllPointsInternal in class ATrace2D

See Also:

ATrace2D.removeAllPointsInternal()

removePointInternal

protected ITracePoint2D removePointInternal(ITracePoint2D point)

Description copied from class: ATrace2D

Override this template method for the custom remove operation that depends on the internal storage the implementation.

The returned point may be the same as the given. But some "computing" traces like Trace2DArithmeticMean will internally delete a different point and return that one.

No property change events have to be fired by default. If this method returns null the outer logic of the calling method ATrace2D.removePoint(ITracePoint2D) will perform bound checks for the returned point and fire property changes for the properties ITrace2D.PROPERTY_MAX_X, ITrace2D.PROPERTY_MIN_X, ITrace2D.PROPERTY_MAX_Y and ITrace2D.PROPERTY_MIN_Y.

In special cases - when additional modifications to the internal set of points take place (e.g. a further point get added) this method should return false (regardless whether the old point was really removed or not) and perform bound checks and fire the property changes as mentioned above "manually".

Specified by:

removePointInternal in class ATrace2D

Parameters:

point - the point to remove.

Returns:

null if unsuccessful (and no events should be fired) or the point that actually was removed (in case different than the given one it should be somehow related to the given one).

See Also:

ATrace2D.removePointInternal(info.monitorenter.gui.chart.ITracePoint2D)