Package ch.psi.wica.model.stream

Class WicaStreamProperties

java.lang.Object

ch.psi.wica.model.stream.WicaStreamProperties

Direct Known Subclasses:

WicaStreamSerializer.WicaStreamPropertiesDeserializerMixin, WicaStreamSerializer.WicaStreamPropertiesSerializerMixin

@Immutable
public class WicaStreamProperties
extends Object

Represents the configurable properties of a wica stream.

These include parameters for controlling the frequency at which the various fluxes (heartbeat, metadata, monitored and polled values) are sent down the wire to the end consumer.

Additionally, the stream properties specify the default values that will be applied to the configuration of the individual wica channels that make up the stream, when they are not explicitly specified on the channels themselves.

Constructor Summary

Constructors

Constructor	Description
WicaStreamProperties()
WicaStreamProperties(Boolean quietMode, Integer heartbeatFluxIntervalInMillis, Integer metadataFluxIntervalInMillis, Integer monitoredValueFluxIntervalInMillis, Integer polledValueFluxIntervalInMillis, WicaDataAcquisitionMode dataAcquisitionMode, Integer pollingIntervalInMillis, String fieldsOfInterest, Integer numericPrecision, WicaFilterType filterType, Integer filterNumSamples, Integer filterNumSamplesInAverage, Integer filterCycleLength, Integer filterSamplingIntervalInMillis, Double filterDeadband)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
WicaDataAcquisitionMode	getDataAcquisitionMode()
String	getFieldsOfInterest()
int	getFilterCycleLength()
double	getFilterDeadband()
int	getFilterNumSamples()
int	getFilterNumSamplesInAverage()
int	getFilterSamplingIntervalInMillis()
WicaFilterType	getFilterType()
int	getHeartbeatFluxIntervalInMillis()
int	getMetadataFluxIntervalInMillis()
int	getMonitoredValueFluxIntervalInMillis()
int	getNumericPrecision()
Optional<WicaDataAcquisitionMode>	getOptionalDataAcquisitionMode()
Optional<String>	getOptionalFieldsOfInterest()
Optional<Integer>	getOptionalFilterCycleLength()
Optional<Double>	getOptionalFilterDeadband()
Optional<Integer>	getOptionalFilterNumSamples()
Optional<Integer>	getOptionalFilterNumSamplesInAverage()
Optional<Integer>	getOptionalFilterSamplingIntervalInMillis()
Optional<WicaFilterType>	getOptionalFilterType()
Optional<Integer>	getOptionalHeartbeatFluxIntervalInMillis()
Optional<Integer>	getOptionalMetadataFluxIntervalInMillis()
Optional<Integer>	getOptionalMonitoredValueFluxIntervalInMillis()
Optional<Integer>	getOptionalNumericPrecision()
Optional<Integer>	getOptionalPolledValueFluxIntervalInMillis()
Optional<Integer>	getOptionalPollingIntervalInMillis()
Optional<Boolean>	getOptionalQuietMode()
int	getPolledValueFluxIntervalInMillis()
int	getPollingIntervalInMillis()
boolean	getQuietMode()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

WicaStreamProperties

public WicaStreamProperties()

WicaStreamProperties

public WicaStreamProperties(Boolean quietMode,
 Integer heartbeatFluxIntervalInMillis,
 Integer metadataFluxIntervalInMillis,
 Integer monitoredValueFluxIntervalInMillis,
 Integer polledValueFluxIntervalInMillis,
 WicaDataAcquisitionMode dataAcquisitionMode,
 Integer pollingIntervalInMillis,
 String fieldsOfInterest,
 Integer numericPrecision,
 WicaFilterType filterType,
 Integer filterNumSamples,
 Integer filterNumSamplesInAverage,
 Integer filterCycleLength,
 Integer filterSamplingIntervalInMillis,
 Double filterDeadband)

Method Details

getOptionalQuietMode

public Optional<Boolean> getOptionalQuietMode()

getQuietMode

public boolean getQuietMode()

getOptionalHeartbeatFluxIntervalInMillis

public Optional<Integer> getOptionalHeartbeatFluxIntervalInMillis()

getHeartbeatFluxIntervalInMillis

public int getHeartbeatFluxIntervalInMillis()

getOptionalMetadataFluxIntervalInMillis

public Optional<Integer> getOptionalMetadataFluxIntervalInMillis()

getMetadataFluxIntervalInMillis

public int getMetadataFluxIntervalInMillis()

getOptionalMonitoredValueFluxIntervalInMillis

public Optional<Integer> getOptionalMonitoredValueFluxIntervalInMillis()

getMonitoredValueFluxIntervalInMillis

public int getMonitoredValueFluxIntervalInMillis()

getOptionalPolledValueFluxIntervalInMillis

public Optional<Integer> getOptionalPolledValueFluxIntervalInMillis()

getPolledValueFluxIntervalInMillis

public int getPolledValueFluxIntervalInMillis()

getOptionalDataAcquisitionMode

public Optional<WicaDataAcquisitionMode> getOptionalDataAcquisitionMode()

getDataAcquisitionMode

public WicaDataAcquisitionMode getDataAcquisitionMode()

getOptionalFieldsOfInterest

public Optional<String> getOptionalFieldsOfInterest()

getFieldsOfInterest

public String getFieldsOfInterest()

getOptionalFilterType

public Optional<WicaFilterType> getOptionalFilterType()

getFilterType

public WicaFilterType getFilterType()

getOptionalNumericPrecision

public Optional<Integer> getOptionalNumericPrecision()

getNumericPrecision

public int getNumericPrecision()

getOptionalPollingIntervalInMillis

public Optional<Integer> getOptionalPollingIntervalInMillis()

getPollingIntervalInMillis

public int getPollingIntervalInMillis()

getOptionalFilterCycleLength

public Optional<Integer> getOptionalFilterCycleLength()

getFilterCycleLength

public int getFilterCycleLength()

getOptionalFilterNumSamples

public Optional<Integer> getOptionalFilterNumSamples()

getFilterNumSamples

public int getFilterNumSamples()

getOptionalFilterNumSamplesInAverage

public Optional<Integer> getOptionalFilterNumSamplesInAverage()

getFilterNumSamplesInAverage

public int getFilterNumSamplesInAverage()

getOptionalFilterDeadband

public Optional<Double> getOptionalFilterDeadband()

getFilterDeadband

public double getFilterDeadband()

getOptionalFilterSamplingIntervalInMillis

public Optional<Integer> getOptionalFilterSamplingIntervalInMillis()

getFilterSamplingIntervalInMillis

public int getFilterSamplingIntervalInMillis()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object