Package ch.psi.wica.services.channel

Class WicaChannelValueFixedSamplingCycleFilter

java.lang.Object

ch.psi.wica.services.channel.WicaChannelValueFixedSamplingCycleFilter

All Implemented Interfaces:

WicaChannelValueFilter

@NotThreadSafe
class WicaChannelValueFixedSamplingCycleFilter
extends Object
implements WicaChannelValueFilter

A filter that returns an output list which includes one-in-every-M values taken from the input list over successive invocations.

Constructor Summary

Constructors

Constructor	Description
WicaChannelValueFixedSamplingCycleFilter(int samplingCycleLength)	Constructs a new instance with the specified sampling cycle length.

Method Summary

Modifier and Type	Method	Description
List<WicaChannelValue>	apply(List<WicaChannelValue> inputList)	Transforms the values in the input apply to the output apply using some configurable filtering algorithm.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

WicaChannelValueFixedSamplingCycleFilter

WicaChannelValueFixedSamplingCycleFilter(int samplingCycleLength)

Constructs a new instance with the specified sampling cycle length.

Parameters:

samplingCycleLength - - the sampling cycle length. (ie the value of M in this 1-in-every-M sampler).

Method Details

apply

public List<WicaChannelValue> apply(List<WicaChannelValue> inputList)

Description copied from interface: WicaChannelValueFilter

Transforms the values in the input apply to the output apply using some configurable filtering algorithm.

Specified by:

apply in interface WicaChannelValueFilter

Parameters:

inputList - the list of values to process.

Returns:

the list of values that were produced from the processing step.

toString

public String toString()

Overrides:

toString in class Object