org.eclipse.soda.dk.measurement
Class Measurements

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.Measurements

All Implemented Interfaces:

ControlService, MeasurementListener, MeasurementService, MultiplexMeasurementListener, ErrorListener

public class Measurements
extends Measurement
implements MultiplexMeasurementListener

The Measurements class implements the MeasurementService interface.

Since:

1.0

Version:

1.2.0

See Also:

Control, Measurement, ControlService, ErrorListener, MeasurementService, MeasurementListener, MessageHandler

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

Measurements(java.lang.String key, java.lang.Object value, MeasurementService[] measurements)
Constructs an Measurements object using the input parameter(s).

Method Summary

void	addInternalMeasurementListener() Adds the specified listener to receive listener notification.
void	executeRead(ChannelService channel) Execute read with the specified channel parameter.
void	executeWrite(ChannelService channel, java.lang.Object value) Execute write with the specified channel and value parameters.
MeasurementService[]	getMeasurements() Gets the org.eclipse.soda.dk.measurement.service.MeasurementService [] measurements property value.
void	measurementChanged(MeasurementService source, java.lang.Object timestamp, ChannelService channel, java.lang.Object newValue, java.lang.Object oldValue) Measurement changed with the specified source, timestamp, channel, new value and old value parameters.
void	measurementChanged(MeasurementService source, java.lang.Object timestamp, java.lang.Object newValue, java.lang.Object oldValue) This method is fired to all Listeners each time the value of the measurement changes.
java.lang.Object	read(ChannelService channel, long timeout) Read with the specified channel and timeout parameters and return the Object result.
protected void	setMeasurements(MeasurementService[] measurements) Sets the measurements value.
void	setValue(ChannelService channel, java.lang.Object value) Set value with the specified channel and value parameters.

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

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

Measurements

public Measurements(java.lang.String key,
                    java.lang.Object value,
                    MeasurementService[] measurements)

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

Parameters:

key - The key (String) parameter.

value - The value (Object) parameter.

measurements - The measurements (MeasurementService[]) parameter.

See Also:

getMeasurements(), setMeasurements(MeasurementService[])

Method Detail

addInternalMeasurementListener

public void addInternalMeasurementListener()

Adds the specified listener to receive listener notification.

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

executeWrite

public void executeWrite(ChannelService channel,
                         java.lang.Object value)

Execute write with the specified channel and value parameters.

Specified by:

executeWrite in interface MeasurementService

Overrides:

executeWrite in class Measurement

Parameters:

channel - The channel (ChannelService) parameter.

value - The value (Object) parameter.

See Also:

Measurement.executeWrite(Object)

getMeasurements

public MeasurementService[] getMeasurements()

Gets the org.eclipse.soda.dk.measurement.service.MeasurementService [] measurements property value.

Returns:

Results of the get measurements (MeasurementService[]) value.

See Also:

Measurements(String,Object,MeasurementService[]), setMeasurements(MeasurementService[])

measurementChanged

public void measurementChanged(MeasurementService source,
                               java.lang.Object timestamp,
                               ChannelService channel,
                               java.lang.Object newValue,
                               java.lang.Object oldValue)

Measurement changed with the specified source, timestamp, channel, new value and old value parameters.

Specified by:

measurementChanged in interface MultiplexMeasurementListener

Parameters:

source - The source (MeasurementService) parameter.

timestamp - The time stamp (Object) parameter.

channel - The channel (ChannelService) parameter.

newValue - The new value (Object) parameter.

oldValue - The old value (Object) parameter.

Since:

1.2

See Also:

measurementChanged(MeasurementService,Object,Object,Object)

measurementChanged

public void measurementChanged(MeasurementService source,
                               java.lang.Object timestamp,
                               java.lang.Object newValue,
                               java.lang.Object oldValue)

This method is fired to all Listeners each time the value of the measurement changes. 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:

measurementChanged in interface MeasurementListener

Parameters:

source - The source (MeasurementService) parameter.

timestamp - The time stamp (Object) parameter.

newValue - The new value (Object) parameter.

oldValue - The old value (Object) parameter.

See Also:

measurementChanged(MeasurementService,Object,ChannelService,Object,Object)

read

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

Read with the specified channel and timeout parameters and return the Object result.

Specified by:

read in interface MeasurementService

Overrides:

read in class Measurement

Parameters:

channel - The channel (ChannelService) parameter.

timeout - The timeout (long) parameter.

Returns:

Results of the read (Object) value.

Throws:

java.lang.RuntimeException - Runtime Exception.

See Also:

Measurement.read(long)

setMeasurements

protected void setMeasurements(MeasurementService[] measurements)

Sets the measurements value.

Parameters:

measurements - The measurements (MeasurementService[]) parameter.

See Also:

Measurements(String,Object,MeasurementService[]), getMeasurements()

setValue

public void setValue(ChannelService channel,
                     java.lang.Object value)

Set value with the specified channel and value parameters.

Specified by:

setValue in interface MeasurementService

Overrides:

setValue in class Measurement

Parameters:

channel - The channel (ChannelService) parameter.

value - The value (Object) parameter.

See Also:

Measurement.getValue(), Measurement.getValue(ChannelService), Measurement.setRawValue(ChannelService,Object,Object), Measurement.setRawValue(Object,Object), Measurement.setValue(ChannelService,Object,Object), Measurement.setValue(Object), Measurement.setValue(Object,Object)