org.eclipse.soda.dk.measurement
Class ReadMeasurement

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
                          org.eclipse.soda.dk.measurement.ReadMeasurement

All Implemented Interfaces:

ControlService, MeasurementService, MultiplexSignalListener, SignalListener, ErrorListener

Direct Known Subclasses:

CommandMeasurement

public class ReadMeasurement
extends SignalMeasurement

Since:

1.0

Version:

1.2.0

Field Summary

protected CommandService

readCommand Define the read command (CommandService) field.

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

ReadMeasurement(java.lang.String key, java.lang.Object value, UnitsService units, TransformService transform, SignalService signal, CommandService readCommand)
Constructs an instance of this class from the specified key, value, units, transform, signal and read command parameters.

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

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

ReadMeasurement(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

void	executeRead(ChannelService channel) Execute read with the specified channel parameter.
CommandService	getReadCommand() Gets the CommandService readCommand property value.
java.lang.Object	read(ChannelService channel, long timeout) Perform the read method and return the Object result.
void	setReadCommand(CommandService readCommand) Sets the readCommand property.
void	setTimestamp(ChannelService channel, java.lang.Object timestamp) Set timestamp with the specified channel and timestamp parameters.

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

finalize, getSignal, setSignal, signalOccurred, signalOccurred

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

Field Detail

readCommand

protected CommandService readCommand

Define the read command (CommandService) field.

Constructor Detail

ReadMeasurement

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

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

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.

readCommand - The read command (CommandService) parameter.

See Also:

ReadMeasurement(String,UnitsService,TransformService,SignalService), ReadMeasurement(String,TransformService,SignalService), ReadMeasurement(String,SignalService)

ReadMeasurement

public ReadMeasurement(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:

ReadMeasurement(String,Object,UnitsService,TransformService,SignalService,CommandService), ReadMeasurement(String,TransformService,SignalService), ReadMeasurement(String,SignalService)

ReadMeasurement

public ReadMeasurement(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:

ReadMeasurement(String,Object,UnitsService,TransformService,SignalService,CommandService), ReadMeasurement(String,UnitsService,TransformService,SignalService), ReadMeasurement(String,SignalService)

ReadMeasurement

public ReadMeasurement(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:

ReadMeasurement(String,Object,UnitsService,TransformService,SignalService,CommandService), ReadMeasurement(String,UnitsService,TransformService,SignalService), ReadMeasurement(String,TransformService,SignalService)

Method Detail

executeRead

public void executeRead(ChannelService channel)

Execute read with the specified channel parameter.

Specified by:

executeRead in interface MeasurementService

Overrides:

executeRead in class Measurement

Parameters:

channel - The channel (ChannelService) parameter.

See Also:

Measurement.executeRead()

getReadCommand

public CommandService getReadCommand()

Gets the CommandService readCommand property value.

Returns:

Results of the get read command (CommandService) value.

See Also:

setReadCommand(CommandService)

read

public java.lang.Object read(ChannelService channel,
                             long timeout)
                      throws java.lang.RuntimeException

Perform the read method and return the Object result. This method forces a synchronous hardware read with a timeout specified in milliseconds.

Specified by:

read in interface MeasurementService

Overrides:

read in class Measurement

Parameters:

channel - The channel (ChannelService) parameter.

timeout - long

Returns:

Results of the read (Object) value.

Throws:

java.lang.RuntimeException - Thrown if the read command does not result in a response from the device.

See Also:

Measurement.read(long)

setReadCommand

public void setReadCommand(CommandService readCommand)

Sets the readCommand property.

Parameters:

readCommand - The new property value (org.eclipse.soda.dk.command.service.CommandService).

See Also:

getReadCommand()

setTimestamp

public void setTimestamp(ChannelService channel,
                         java.lang.Object timestamp)

Set timestamp with the specified channel and timestamp parameters.

Overrides:

setTimestamp in class Measurement

Parameters:

channel - The channel (ChannelService) parameter.

timestamp - The time stamp (Object) parameter.

See Also:

Measurement.getTimestamp(), Measurement.getTimestamp(ChannelService), Measurement.setTimestamp(Object)