org.eclipse.soda.dk.measurement
Class MeasurementFieldMeasurement

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

All Implemented Interfaces:

ControlService, MeasurementListener, MeasurementService, MultiplexMeasurementListener, ErrorListener

Direct Known Subclasses:

ConcreteMeasurementFieldMeasurement

public class MeasurementFieldMeasurement
extends Measurement
implements MultiplexMeasurementListener

Since:

1.0

Version:

1.2.0

Field Summary

protected java.lang.String	fieldName Define the field name (String) field.
protected MeasurementService	measurement Define the measurement (MeasurementService) 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

MeasurementFieldMeasurement(java.lang.String key)
Constructs an instance of this class from the specified key parameter.

MeasurementFieldMeasurement(java.lang.String key, MeasurementService measurement, java.lang.String fieldName)
Constructs an instance of this class from the specified key, measurement and field name parameters.

MeasurementFieldMeasurement(java.lang.String key, java.lang.Object value)
Constructs an instance of this class from the specified key and value parameters.

MeasurementFieldMeasurement(java.lang.String key, java.lang.Object value, MeasurementService measurement, java.lang.String fieldName)
Constructs an instance of this class from the specified key, value, measurement and field name parameters.

Method Summary

void	executeRead(ChannelService channel) Execute read with the specified channel parameter.
java.lang.String	getFieldName() Gets the field name (String) value.
MeasurementService	getMeasurement() Gets the measurement (MeasurementService) 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) Measurement changed with the specified source, timestamp, new value and old value parameters.
java.lang.Object	read(ChannelService channel, long timeout) Read with the specified channel and timeout parameters and return the Object result.
void	setFieldName(java.lang.String fieldName) Sets the field name value.
void	setMeasurement(MeasurementService measurement) Sets the measurement value.
void	setValue(ChannelService channel, java.lang.Object value, java.lang.Object timestamp) Set value with the specified channel, value and timestamp parameters.

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

addMeasurementListener, addMeasurementListener, executeRead, executeWrite, 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

Field Detail

fieldName

protected java.lang.String fieldName

Define the field name (String) field.

measurement

protected MeasurementService measurement

Define the measurement (MeasurementService) field.

Constructor Detail

MeasurementFieldMeasurement

public MeasurementFieldMeasurement(java.lang.String key)

Constructs an instance of this class from the specified key parameter.

Parameters:

key - The key (String) parameter.

See Also:

MeasurementFieldMeasurement(String,MeasurementService,String), MeasurementFieldMeasurement(String,Object), MeasurementFieldMeasurement(String,Object,MeasurementService,String)

MeasurementFieldMeasurement

public MeasurementFieldMeasurement(java.lang.String key,
                                   MeasurementService measurement,
                                   java.lang.String fieldName)

Constructs an instance of this class from the specified key, measurement and field name parameters.

Parameters:

key - The key (String) parameter.

measurement - The measurement (MeasurementService) parameter.

fieldName - The field name (String) parameter.

See Also:

MeasurementFieldMeasurement(String), MeasurementFieldMeasurement(String,Object), MeasurementFieldMeasurement(String,Object,MeasurementService,String)

MeasurementFieldMeasurement

public MeasurementFieldMeasurement(java.lang.String key,
                                   java.lang.Object value)

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

Parameters:

key - The key (String) parameter.

value - The value (Object) parameter.

See Also:

MeasurementFieldMeasurement(String), MeasurementFieldMeasurement(String,MeasurementService,String), MeasurementFieldMeasurement(String,Object,MeasurementService,String)

MeasurementFieldMeasurement

public MeasurementFieldMeasurement(java.lang.String key,
                                   java.lang.Object value,
                                   MeasurementService measurement,
                                   java.lang.String fieldName)

Constructs an instance of this class from the specified key, value, measurement and field name parameters.

Parameters:

key - The key (String) parameter.

value - The value (Object) parameter.

measurement - The measurement (MeasurementService) parameter.

fieldName - The field name (String) parameter.

See Also:

MeasurementFieldMeasurement(String), MeasurementFieldMeasurement(String,MeasurementService,String), MeasurementFieldMeasurement(String,Object)

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

getFieldName

public java.lang.String getFieldName()

Gets the field name (String) value.

Returns:

The field name (String) value.

See Also:

setFieldName(String)

getMeasurement

public MeasurementService getMeasurement()

Gets the measurement (MeasurementService) value.

Returns:

The measurement (MeasurementService) value.

See Also:

MeasurementFieldMeasurement(String), MeasurementFieldMeasurement(String,MeasurementService,String), MeasurementFieldMeasurement(String,Object), MeasurementFieldMeasurement(String,Object,MeasurementService,String), setMeasurement(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)

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

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)

setFieldName

public void setFieldName(java.lang.String fieldName)

Sets the field name value.

Parameters:

fieldName - The field name (String) parameter.

See Also:

getFieldName()

setMeasurement

public void setMeasurement(MeasurementService measurement)

Sets the measurement value.

Parameters:

measurement - The measurement (MeasurementService) parameter.

See Also:

MeasurementFieldMeasurement(String), MeasurementFieldMeasurement(String,MeasurementService,String), MeasurementFieldMeasurement(String,Object), MeasurementFieldMeasurement(String,Object,MeasurementService,String), getMeasurement()

setValue

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

Set value with the specified channel, value and timestamp parameters.

Overrides:

setValue in class Measurement

Parameters:

channel - The channel (ChannelService) parameter.

value - The value (Object) parameter.

timestamp - The time stamp (Object) parameter.

See Also:

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