Package com.inductiveautomation.historian.gateway.tags.actor.compression

Class DeadbandCompressor

java.lang.Object

com.inductiveautomation.historian.gateway.tags.actor.compression.DeadbandCompressor

All Implemented Interfaces:

ValueCompressor, Diagnosable

public class DeadbandCompressor
extends Object
implements ValueCompressor, Diagnosable

Constructor Summary

Constructors

Constructor	Description
DeadbandCompressor(Deadband deadband)

Method Summary

Modifier and Type	Method	Description
List<QualifiedValue>	flush()	Tells the compressor to return any values it can.
InterpolationMode	getDeadbandMode()
List<QualifiedValue>	putValue(QualifiedValue value)	Places a value into the compressor to be processed.
void	sampleDiagnostics(DiagnosticsSample sample)	Provides the sample upon which the object can set diagnostics information.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DeadbandCompressor

public DeadbandCompressor(Deadband deadband)

Method Details

getDeadbandMode

public InterpolationMode getDeadbandMode()

Specified by:

getDeadbandMode in interface ValueCompressor

sampleDiagnostics

public void sampleDiagnostics(DiagnosticsSample sample)

Description copied from interface: Diagnosable

Provides the sample upon which the object can set diagnostics information. It is expected that the calling object will first call getSubSample() in order to specify a useful identifier for this object's data.

Specified by:

sampleDiagnostics in interface Diagnosable

putValue

public List<QualifiedValue> putValue(QualifiedValue value)

Description copied from interface: ValueCompressor

Places a value into the compressor to be processed. Any available processed values are returned. Will return an empty list if no values should be emitted (will not return null).

Important: For performance reasons, the list returned may be the same object between calls. Therefore, it should not be held onto. The values should be utilized directly after calling this function.

Specified by:

putValue in interface ValueCompressor

flush

public List<QualifiedValue> flush()

Description copied from interface: ValueCompressor

Tells the compressor to return any values it can. Can be used before shutdown, or when the max-age has been reached in order to force values to be written.

Important: For performance reasons, the list returned may be the same object between calls. Therefore, it should not be held onto. The values should be utilized directly after calling this function.

Specified by:

flush in interface ValueCompressor

toString

public String toString()

Overrides:

toString in class Object