info.monitorenter.gui.chart.traces.accumulationfunctions

Class AAccumulationFunction

java.lang.Object

info.monitorenter.gui.chart.traces.accumulationfunctions.AAccumulationFunction

All Implemented Interfaces:

IAccumulationFunction, Serializable

Direct Known Subclasses:

AccumulationFunctionArithmeticMeanXY

public abstract class AAccumulationFunction
extends Object
implements IAccumulationFunction

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AAccumulationFunction()

Method Summary

Modifier and Type	Method and Description
protected ITracePointProvider	acquireTracePointProvider(ITracePoint2D point) Helper method to read a ITracePointProvider from the given point.
ITracePoint2D	getAccumulatedPoint() Returns the accumulated point resulting from all the points fed via IAccumulationFunction.addPointToAccumulate(ITracePoint2D) since the last call this method was invoked.
ITracePoint2D	getAccumulatedPointCurrent() Returns the current accumulated point.
protected ITracePoint2D	getAccumulatedPointPrevious() Returns previous accumulated point which might be used by implementations that want to accumulate based on the previous accumulated point (e.g.: An implementation that cherry picks only one point from the points to accumulate that is the most different from the previous one).
protected void	setAccumulatedPointCurrent(ITracePoint2D accumulatedPointCurrent) Sets the current accumulated point.

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.monitorenter.gui.chart.IAccumulationFunction

addPointToAccumulate, getAccumulatedPointCount

Constructor Detail

AAccumulationFunction

public AAccumulationFunction()

Method Detail

setAccumulatedPointCurrent

protected void setAccumulatedPointCurrent(ITracePoint2D accumulatedPointCurrent)

Sets the current accumulated point.

This is intended for internal (subclass) use only.

Parameters:

accumulatedPointCurrent - the accumulatedPointCurrent to set

getAccumulatedPointCurrent

public ITracePoint2D getAccumulatedPointCurrent()

Returns the current accumulated point.

Specified by:

getAccumulatedPointCurrent in interface IAccumulationFunction

Returns:

the current accumulated point.

getAccumulatedPointPrevious

protected ITracePoint2D getAccumulatedPointPrevious()

Returns previous accumulated point which might be used by implementations that want to accumulate based on the previous accumulated point (e.g.: An implementation that cherry picks only one point from the points to accumulate that is the most different from the previous one).

This is intended for internal (subclass) use only.

Returns:

the previous accumulated point which might be used by implementations that want to accumulate based on the previous accumulated point (e.g.: An implementation that cherry picks only one point from the points to accumulate that is the most different from the previous one).

getAccumulatedPoint

public ITracePoint2D getAccumulatedPoint()

Description copied from interface: IAccumulationFunction

Returns the accumulated point resulting from all the points fed via IAccumulationFunction.addPointToAccumulate(ITracePoint2D) since the last call this method was invoked.

As a side effect all previous accumulation data is reset and this function is empty again, ready to accumulate the next n points. Internally you might want to store the result in case you want to cherry pick the following point to accumulated in relation to it.

Specified by:

getAccumulatedPoint in interface IAccumulationFunction

Returns:

null or the accumulated point resulting from all the points fed via IAccumulationFunction.addPointToAccumulate(ITracePoint2D) since the last call this method was invoked. If there was nothing to accumulate null is returned.

See Also:

IAccumulationFunction.getAccumulatedPoint()

acquireTracePointProvider

protected final ITracePointProvider acquireTracePointProvider(ITracePoint2D point)
                                                       throws IllegalStateException

Helper method to read a ITracePointProvider from the given point.

This assumes that the given point is assigned to an ITrace2D and that that trace is assigned to a Chart2D. If this is not the case an IllegalStateException is thrown.

Parameters:

point - the point to search the trace point provider for.

Returns:

the trace point provider that is assigned to the chart which this trace point belongs to.

Throws:

IllegalStateException - if the point is not assigned to a trace which is assigned to a chart.