org.eclipse.soda.dk.measurement
Class Measurement

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

All Implemented Interfaces:

ControlService, MeasurementService, ErrorListener

Direct Known Subclasses:

Measurements, MethodMeasurement, ReadOnlyMeasurement, UnitsMeasurement

public class Measurement
extends Control
implements MeasurementService

The DkMeasurement class implements the MeasurementService interface.

Version:

1.0.0

See Also:

Control, ControlService, ErrorListener, MeasurementService, MessageHandler, Object

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

Measurement(java.lang.String key)
Constructs an Measurement object using the input parameter(s).

Measurement(java.lang.String key, java.lang.Object value)
Constructs an Measurement object using the input parameter(s).

Method Summary

void	addMeasurementListener(MeasurementListener measurementListener) Adds the specified listener to receive listener notification.
void	executeRead() Perform the executeRead action method.
void	executeWrite(java.lang.Object value) Perform the executeWrite action method.
protected void	fireErrorOccurred(MeasurementListener measurementListener, java.lang.Object timestamp, java.lang.Object data) Fire error occurred with the specified measurement listener, timestamp and data parameters.
void	fireErrorOccurred(java.lang.Object timestamp, java.lang.Object data) Fire error occurred with the specified timestamp and data parameters.
protected void	fireValueChanged(MeasurementListener measurementListener, java.lang.Object timestamp, java.lang.Object newValue, java.lang.Object oldValue) Perform the fireValueChanged action method.
protected MeasurementListener	getMeasurementListener() Gets the MeasurementListener measurementListener property value.
java.lang.Object	getTimestamp() Gets the Object timestamp property value.
UnitsService	getUnits() Gets the UnitsService units property value.
java.lang.Object	getValue() Gets the Object value property value.
java.lang.Object	getValueRaw() Gets the value raw (Object) value.
java.lang.Object	read(long timeout) Perform the read method and return the Object result.
void	removeMeasurementListener(MeasurementListener measurementListener) Removes the specified listener from receiving listener notification.
protected void	reportError(int errorNumber, java.lang.Throwable error, java.lang.Object[] errorObjects) Report error with the specified error number, error and error objects parameters.
void	setMeasurementListener(MeasurementListener measurementListener) Sets the measurementListener.
protected void	setRawValue(java.lang.Object data, java.lang.Object timestamp) Perform the setRawValue action method.
void	setTimestamp(java.lang.Object timestamp) Sets the timestamp property.
void	setValue(java.lang.Object value) This method forces a synchronous write of the locally cached value.
void	setValue(java.lang.Object value, java.lang.Object timestamp) Perform the setValue action method.

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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getKey

Constructor Detail

Measurement

public Measurement(java.lang.String key)

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

Parameters:

key - java.lang.String

See Also:

Measurement(String,Object)

Measurement

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

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

Parameters:

key - java.lang.String

value - java.lang.Object

See Also:

Measurement(String)

Method Detail

addMeasurementListener

public void addMeasurementListener(MeasurementListener measurementListener)

Adds the specified listener to receive listener notification.

Specified by:

addMeasurementListener in interface MeasurementService

Parameters:

measurementListener - The org.eclipse.soda.dk.measurement.service.MeasurementListener listener to be added.

See Also:

MeasurementService.addMeasurementListener(org.eclipse.soda.dk.measurement.service.MeasurementListener), getMeasurementListener(), removeMeasurementListener(MeasurementListener), setMeasurementListener(MeasurementListener)

executeRead

public void executeRead()

Perform the executeRead action method.

Specified by:

executeRead in interface MeasurementService

See Also:

MeasurementService.executeRead()

executeWrite

public void executeWrite(java.lang.Object value)

Perform the executeWrite action method.

Specified by:

executeWrite in interface MeasurementService

Parameters:

value - java.lang.Object

See Also:

MeasurementService.executeWrite(java.lang.Object)

fireErrorOccurred

protected void fireErrorOccurred(MeasurementListener measurementListener,
                                 java.lang.Object timestamp,
                                 java.lang.Object data)

Fire error occurred with the specified measurement listener, timestamp and data parameters.

Parameters:

measurementListener - The measurement listener (MeasurementListener) parameter.

timestamp - The timestamp (Object) parameter.

data - The data (Object) parameter.

See Also:

fireErrorOccurred(Object,Object)

fireErrorOccurred

public void fireErrorOccurred(java.lang.Object timestamp,
                              java.lang.Object data)

Fire error occurred with the specified timestamp and data parameters.

Parameters:

timestamp - The timestamp (Object) parameter.

data - The data (Object) parameter.

See Also:

fireErrorOccurred(MeasurementListener,Object,Object)

fireValueChanged

protected void fireValueChanged(MeasurementListener measurementListener,
                                java.lang.Object timestamp,
                                java.lang.Object newValue,
                                java.lang.Object oldValue)

Perform the fireValueChanged action method.

Parameters:

measurementListener - The measurement listener to notify (must not be null).

timestamp - java.lang.Object

newValue - java.lang.Object

oldValue - java.lang.Object

getMeasurementListener

protected MeasurementListener getMeasurementListener()

Gets the MeasurementListener measurementListener property value.

Returns:

Results of the get measurement listener (MeasurementListener) value.

See Also:

addMeasurementListener(MeasurementListener), removeMeasurementListener(MeasurementListener), setMeasurementListener(MeasurementListener)

getTimestamp

public java.lang.Object getTimestamp()

Gets the Object timestamp property value.

Specified by:

getTimestamp in interface MeasurementService

Returns:

Results of the get timestamp (Object) value.

See Also:

MeasurementService.getTimestamp(), setTimestamp(Object)

getUnits

public UnitsService getUnits()

Gets the UnitsService units property value.

Returns:

Results of the get units (UnitsService) value.

getValue

public java.lang.Object getValue()

Gets the Object value property value.

Specified by:

getValue in interface MeasurementService

Returns:

Results of the get value (Object) value.

See Also:

MeasurementService.getValue(), setRawValue(Object,Object), setValue(Object), setValue(Object,Object)

getValueRaw

public java.lang.Object getValueRaw()

Gets the value raw (Object) value.

Returns:

The value raw (Object) value.

read

public java.lang.Object read(long timeout)

Perform the read method and return the Object result.

Specified by:

read in interface MeasurementService

Parameters:

timeout - long

Returns:

Results of the read (Object) value.

See Also:

MeasurementService.read(long)

removeMeasurementListener

public void removeMeasurementListener(MeasurementListener measurementListener)

Removes the specified listener from receiving listener notification.

Specified by:

removeMeasurementListener in interface MeasurementService

Parameters:

measurementListener - The org.eclipse.soda.dk.measurement.service.MeasurementListener listener to be removed.

See Also:

MeasurementService.removeMeasurementListener(org.eclipse.soda.dk.measurement.service.MeasurementListener), addMeasurementListener(MeasurementListener), getMeasurementListener(), setMeasurementListener(MeasurementListener)

reportError

protected void reportError(int errorNumber,
                           java.lang.Throwable error,
                           java.lang.Object[] errorObjects)
                    throws java.lang.RuntimeException

Report error with the specified error number, error and error objects parameters.

Overrides:

reportError in class EscObject

Parameters:

errorNumber - The error number (int) parameter.

error - The error (Throwable) parameter.

errorObjects - The error objects (Object[]) parameter.

Throws:

java.lang.RuntimeException - Runtime Exception.

See Also:

EscObject.handleStaticError(String), EscObject.attemptRecoveryFromError(int,Throwable), EscObject.handleError(Throwable,int), EscObject.handleError(Throwable,int,Object), EscObject.handleError(Throwable,int,Object[])

setMeasurementListener

public void setMeasurementListener(MeasurementListener measurementListener)

Sets the measurementListener.

Parameters:

measurementListener - The measurementListener to set

See Also:

addMeasurementListener(MeasurementListener), getMeasurementListener(), removeMeasurementListener(MeasurementListener)

setRawValue

protected void setRawValue(java.lang.Object data,
                           java.lang.Object timestamp)

Perform the setRawValue action method.

Parameters:

data - java.lang.Object

timestamp - java.lang.Object

setTimestamp

public void setTimestamp(java.lang.Object timestamp)

Sets the timestamp property.

Parameters:

timestamp - The new property value (java.lang.Object).

See Also:

getTimestamp()

setValue

public void setValue(java.lang.Object value)

This method forces a synchronous write of the locally cached value. This method should only be used for simulation and testing purposes, as it will insert false data into the measurement.

Specified by:

setValue in interface MeasurementService

Parameters:

value - The new property value (java.lang.Object).

See Also:

getValue(), setRawValue(Object,Object), setValue(Object,Object)

setValue

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

Perform the setValue action method.

Parameters:

value - java.lang.Object

timestamp - java.lang.Object

See Also:

getValue(), setRawValue(Object,Object), setValue(Object)