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, SignalListener, ErrorListener

Direct Known Subclasses:

ReadMeasurement

public class SignalMeasurement
extends DataMeasurement
implements SignalListener

The SignalMeasurement class implements the MeasurementService interface.

Version:

1.0.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, SETVALUEEXCEPTION_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, INTEGER_TABLE, KEY_KEY, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_TRACE, LOG_WARNING, PREFIX_KEY, 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

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 property.
void	signalOccurred(SignalService source, java.lang.Object timestamp, java.lang.Object data) This method is fired to all Listeners each time the signal triggerred.

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, executeRead, executeWrite, fireErrorOccurred, fireErrorOccurred, fireValueChanged, getMeasurementListener, getTimestamp, getValue, getValueRaw, read, removeMeasurementListener, reportError, setMeasurementListener, setTimestamp, setValue, setValue

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

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

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

createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogService, getLong, getObject, getOutputName, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleStaticError, handleStaticException, isDebug, isTrace, loadService, log, log, report, report, report, report, report, report, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, 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 - java.lang.String

value - java.lang.Object

units - org.eclipse.soda.dk.dk.UnitsService

transform - org.eclipse.soda.dk.transform.service.TransformService

signal - org.eclipse.soda.dk.signal.service.SignalService

See Also:

SignalMeasurement(String,UnitsService,TransformService,SignalService), SignalMeasurement(String,TransformService,SignalService), SignalMeasurement(String,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,TransformService,SignalService), SignalMeasurement(String,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,UnitsService,TransformService,SignalService), SignalMeasurement(String,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,UnitsService,TransformService,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:

- href="java.lang.Throwable.html">Throwable Thrown if the Throwable exception condition occurs.

java.lang.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 property.

Parameters:

signal - The new property value (org.eclipse.soda.dk.signal.service.SignalService).

See Also:

getSignal()

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 triggerred. The signal can be triggered when a message is recevied 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 (eg calling read on a measuremnt).
• Handle this call quickly and return.

Specified by:

signalOccurred in interface SignalListener

Parameters:

source - The SignalService which fired.

timestamp - The time at which the signal was detected.

data - Contains any data which was contained within the signal.