org.eclipse.soda.dk.measurement
Class SignalMeasurement

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.device.Control
          org.eclipse.soda.dk.measurement.Measurement
              org.eclipse.soda.dk.measurement.UnitsMeasurement
                  org.eclipse.soda.dk.measurement.DataMeasurement
                      org.eclipse.soda.dk.measurement.SignalMeasurement

All Implemented Interfaces:

ControlService, MeasurementService, MultiplexSignalListener, SignalListener, ErrorListener

Direct Known Subclasses:

ReadMeasurement

public class SignalMeasurement
extends DataMeasurement
implements MultiplexSignalListener

The SignalMeasurement class implements the MeasurementService interface.

Since:

1.0

Version:

1.2.0

See Also:

Control, DataMeasurement, Measurement, UnitsMeasurement, ControlService, ErrorListener, MeasurementService, MessageHandler, SignalService, SignalListener

Field Summary

Fields inherited from class org.eclipse.soda.dk.device.Control

EXCEPTION_READ_FAILED_RESOURCE, SET_VALUE_EXCEPTION_RESOURCE

Fields inherited from class org.eclipse.soda.dk.core.EscObject

CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, ID_NAME_KEY, INTEGER_TABLE, INTEGER_TABLE_SIZE, KEY_KEY, LOG_DEBUG, LOG_DEFAULT, LOG_ERROR, LOG_INFO, LOG_LEVEL_KEY, LOG_TRACE, LOG_WARNING, LONG_TABLE, LONG_TABLE_SIZE, PREFIX_KEY, READONLY_EMPTY_COLLECTION, READONLY_EMPTY_LIST, READONLY_EMPTY_MAP, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TO_STRING_CONFIGURATION_KEYS, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE, Unmodifiable

Constructor Summary

SignalMeasurement(java.lang.String key, java.lang.Object value, UnitsService units, TransformService transform, SignalService signal)
Constructs an SignalMeasurement object using the input parameter(s).

SignalMeasurement(java.lang.String key, SignalService signal)
Constructs an instance of this class from the specified key and signal parameters.

SignalMeasurement(java.lang.String key, TransformService transform, SignalService signal)
Constructs an instance of this class from the specified key, transform and signal parameters.

SignalMeasurement(java.lang.String key, UnitsService units, TransformService transform, SignalService signal)
Constructs an instance of this class from the specified key, units, transform and signal parameters.

Method Summary

protected void	finalize() Perform the finalize action method.
SignalService	getSignal() Gets the SignalService signal property value.
protected void	setSignal(SignalService signal) Sets the signal value.
void	signalOccurred(SignalService source, java.lang.Object timestamp, ChannelService channel, java.lang.Object data) Signal occurred with the specified source, timestamp, channel and data parameters.
void	signalOccurred(SignalService source, java.lang.Object timestamp, java.lang.Object data) This method is fired to all Listeners each time the signal triggered.

Methods inherited from class org.eclipse.soda.dk.measurement.DataMeasurement

getTransform, setRawValue, setTransform

Methods inherited from class org.eclipse.soda.dk.measurement.UnitsMeasurement

getUnits, setUnits

Methods inherited from class org.eclipse.soda.dk.measurement.Measurement

addMeasurementListener, addMeasurementListener, executeRead, executeRead, executeWrite, executeWrite, fireErrorOccurred, fireErrorOccurred, fireValueChanged, fireValueChanged, getMeasurementListener, getTimestamp, getTimestamp, getTimestampKey, getValue, getValue, getValueRaw, getValueRaw, read, read, removeMeasurementListener, reportError, setMeasurementListener, setRawValue, setTimestamp, setTimestamp, setValue, setValue, setValue, setValue

Methods inherited from class org.eclipse.soda.dk.device.Control

attemptRecoveryFromError, equalsValue, errorOccurred, findMethod, getCodeKey, getErrorSeverity, getKey, getQualifiedKey, getResource, setKey, setQualifiedKey, toString

Methods inherited from class org.eclipse.soda.dk.core.EscObject

createBoolean, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getByte, getChar, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getDouble, getFloat, getId, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogLevel, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, getShort, getSimpleClassName, getStaticBoolean, getStaticByte, getStaticChar, getStaticDouble, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticShort, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleError, handleErrorInternal, handleStaticError, handleStaticException, isBackward, isDebug, isLogging, isTrace, isUnmodifiable, loadService, log, log, log, report, report, report, report, report, report, report, reportSystemInfo, setBackward, setDebug, setDefaultLogService, setLogService, setTraceLevel, setUnmodifiable, shouldLog, sleep, startupEscStatic, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.soda.dk.transport.service.ErrorListener

errorOccurred

Methods inherited from interface org.eclipse.soda.dk.device.service.ControlService

getKey

Constructor Detail

SignalMeasurement

public SignalMeasurement(java.lang.String key,
                         java.lang.Object value,
                         UnitsService units,
                         TransformService transform,
                         SignalService signal)

Constructs an SignalMeasurement object using the input parameter(s).

Parameters:

key - The key (String) parameter.

value - The value (Object) parameter.

units - The units (UnitsService) parameter.

transform - The transform (TransformService) parameter.

signal - The signal (SignalService) parameter.

See Also:

SignalMeasurement(String,SignalService), SignalMeasurement(String,TransformService,SignalService), SignalMeasurement(String,UnitsService,TransformService,SignalService)

SignalMeasurement

public SignalMeasurement(java.lang.String key,
                         SignalService signal)

Constructs an instance of this class from the specified key and signal parameters.

Parameters:

key - The key (String) parameter.

signal - The signal (SignalService) parameter.

See Also:

SignalMeasurement(String,Object,UnitsService,TransformService,SignalService), SignalMeasurement(String,TransformService,SignalService), SignalMeasurement(String,UnitsService,TransformService,SignalService)

SignalMeasurement

public SignalMeasurement(java.lang.String key,
                         TransformService transform,
                         SignalService signal)

Constructs an instance of this class from the specified key, transform and signal parameters.

Parameters:

key - The key (String) parameter.

transform - The transform (TransformService) parameter.

signal - The signal (SignalService) parameter.

See Also:

SignalMeasurement(String,Object,UnitsService,TransformService,SignalService), SignalMeasurement(String,SignalService), SignalMeasurement(String,UnitsService,TransformService,SignalService)

SignalMeasurement

public SignalMeasurement(java.lang.String key,
                         UnitsService units,
                         TransformService transform,
                         SignalService signal)

Constructs an instance of this class from the specified key, units, transform and signal parameters.

Parameters:

key - The key (String) parameter.

units - The units (UnitsService) parameter.

transform - The transform (TransformService) parameter.

signal - The signal (SignalService) parameter.

See Also:

SignalMeasurement(String,Object,UnitsService,TransformService,SignalService), SignalMeasurement(String,SignalService), SignalMeasurement(String,TransformService,SignalService)

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Perform the finalize action method.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - Throwable.

getSignal

public SignalService getSignal()

Gets the SignalService signal property value.

Returns:

Results of the get signal (SignalService) value.

See Also:

setSignal(SignalService)

setSignal

protected void setSignal(SignalService signal)

Sets the signal value.

Parameters:

signal - The signal (SignalService) parameter.

See Also:

getSignal()

signalOccurred

public void signalOccurred(SignalService source,
                           java.lang.Object timestamp,
                           ChannelService channel,
                           java.lang.Object data)

Signal occurred with the specified source, timestamp, channel and data parameters.

Specified by:

signalOccurred in interface MultiplexSignalListener

Parameters:

source - The source (SignalService) parameter.

timestamp - The time stamp (Object) parameter.

channel - The channel (ChannelService) parameter.

data - The data (Object) parameter.

Since:

1.2

See Also:

signalOccurred(SignalService,Object,Object)

signalOccurred

public void signalOccurred(SignalService source,
                           java.lang.Object timestamp,
                           java.lang.Object data)

This method is fired to all Listeners each time the signal triggered. The signal can be triggered when a message is received from the hardware or when the trigger method is invoked by the application. Since other notifications are blocked until this method returns, implementors of this method should:

• Not cause the device or transport to be blocked (e.g. calling read on a measurement).
• Handle this call quickly and return.

Specified by:

signalOccurred in interface SignalListener

Parameters:

source - The source (SignalService) parameter.

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

See Also:

signalOccurred(SignalService,Object,ChannelService,Object)