org.eclipse.soda.dk.base.device
Class BaseDevice

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.device.Control
          org.eclipse.soda.dk.device.Container
              org.eclipse.soda.dk.device.Device
                  org.eclipse.soda.dk.base.device.BaseDevice

All Implemented Interfaces:

java.lang.Runnable, BaseDeviceService, ControlService, DeviceService, ErrorListener

public abstract class BaseDevice
extends Device
implements DeviceService, BaseDeviceService

Base Device. The BaseDevice class implements the BaseDeviceService and provides the controls for the device.

The list of exported services:

Since:

1.0

Version:

1.2.0

See Also:

BaseDeviceService, DeviceService

Field Summary

protected Measurement	capabilities Defines the Capabilities measurement.
static java.lang.String	CLASS_NAME Defines the full class name.
protected Measurement	configuration Defines the Configuration measurement.
protected Measurement	status Defines the Status measurement.

Fields inherited from class org.eclipse.soda.dk.device.Device

channelChanged, channels, closeChannel, openChannel, POLL_COMMAND_NAME, START_COMMAND_NAME, STARTED_MASK, STOP_COMMAND_NAME

Fields inherited from class org.eclipse.soda.dk.device.Container

broadcastCommandCount, broadcastMeasurementCount, broadcastSignalCount, CHANNEL_CHANGED_EXCEPTION_RESOURCE, DEVICE_ACTIVE_STATE_RESOURCE, DEVICE_ALIVE_STATE_RESOURCE, DEVICE_CHANGED_EXCEPTION_RESOURCE, DEVICE_CONNECTED_STATE_RESOURCE, DEVICE_CREATED_STATE_RESOURCE, DEVICE_DEAD_STATE_RESOURCE, DEVICE_STARTED_STATE_RESOURCE, DEVICE_STATE_RESOURCE_TABLE, EXCEPTION_NO_TRANSPORT_RESOURCE, INITIALIZE_CONFIGURATION_EXCEPTION_RESOURCE, INITIALIZE_CONFIGURATION_MISCOMPARE_RESOURCE, INITIALIZE_CONFIGURATION_RESOURCE, INITIALIZE_CONFIGURATION_SAME_RESOURCE, INITIALIZE_READ_EXCEPTION_RESOURCE, INITIALIZE_WRITE_EXCEPTION_RESOURCE, logLevel, MESSAGE_RECEIVED_EXCEPTION_RESOURCE, metrics, NOTIFICATION_PRIORITY_DEFAULT, notificationPriority, PROCESSING_UNABLE_TO_KEEP_UP_EXCEPTION_RESOURCE, RUN_EXCEPTION_RESOURCE, SEND_EXCEPTION_RESOURCE, stateChanged, TOPIC_DELIMITER

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

Fields inherited from interface org.eclipse.soda.dk.base.device.service.BaseDeviceService

ALL_COMMANDS, ALL_MEASUREMENTS, ALL_SIGNALS, BaseDevice, Capabilities, CAPABILITIES_ERROR_EXTERNAL_KEY, CAPABILITIES_EXTERNAL_KEY, CAPABILITIES_GET_EXTERNAL_KEY, CAPABILITIES_READ_EXTERNAL_KEY, CAPABILITIES_WRITE_EXTERNAL_KEY, Configuration, CONFIGURATION_ERROR_EXTERNAL_KEY, CONFIGURATION_EXTERNAL_KEY, CONFIGURATION_GET_EXTERNAL_KEY, CONFIGURATION_READ_EXTERNAL_KEY, CONFIGURATION_WRITE_EXTERNAL_KEY, SERVICE_DESCRIPTION, SERVICE_NAME, Status, STATUS_ERROR_EXTERNAL_KEY, STATUS_EXTERNAL_KEY, STATUS_GET_EXTERNAL_KEY, STATUS_READ_EXTERNAL_KEY, STATUS_WRITE_EXTERNAL_KEY

Constructor Summary

BaseDevice()
Constructs a new instance of the BaseDevice class.

Method Summary

MeasurementService	getCapabilities() Defines the Capabilities measurement.
MeasurementService	getConfiguration() Defines the Configuration measurement.
int	getControlCapacity() Gets the control capacity.
java.lang.String	getDefaultKey() Gets the default key of the device.
TransportService	getDefaultTransport() Gets the default TransportService.
int	getMessageCapacity() Gets the message capacity.
MeasurementService	getStatus() Defines the Status measurement.
void	setup() Method setup.

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

addDeviceListener, channelChanged, channelChanged, closeChannel, controlAdded, controlRemoved, finalize, fireChannelChanged, fireContainerChanged, fireErrorOccurred, getChannel, getChannelChanged, getChannels, getCloseChannel, getDeviceListener, getMessageKey, getMultiplexDeviceListener, getNotificationPriorityDefault, getOpenChannel, getPriority, getReadTimeout, getThread, handleMethodChannels, handleMethodCloseChannel, handleMethodMetrics, handleMethodOpenChannel, hasListeners, initialize, initialize, isAutoStart, isBlockProcessing, isEvenProcessing, isRunning, isStarted, isThreadNeeded, load, openChannel, put, remove, removeDeviceListener, restart, run, setDeviceListener, setReadTimeout, setRunning, setStarted, setThread, start, startup, stop

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

activate, activate, addData, addQualifiedKeys, attemptRecoveryFromError, broadcast, broadcastStatus, broadcastStatus, changeIds, collectMetrics, createFilter, deactivate, deactivate, elements, errorOccurred, exit, get, getBroadcastCommandCount, getBroadcastMeasurementCount, getBroadcastSignalCount, getBundleContext, getCommand, getConfigurationInformation, getConfigurationInformation, getConfigurationService, getControls, getDefaultStyle, getErrorSeverity, getInformation, getLogDetails4, getLogDetails5, getLogDetails6, getLogLevel, getMeasurement, getMetrics, getNotificationController, getNotificationPriority, getNotificationService, getNumberValue, getPrefix, getSignal, getState, getStatusDictionary, getString, getStyle, getTransport, handleMethodMetrics, initializeMeasurements, initializeMeasurements, isInitializeMeasurements, keys, notificationReceived, prependPrefix, prependPrefix, put, putConfigurationInformation, register, register, removeListeners, removeQualifiedKeys, send, send, send, send, setBroadcastCommandCount, setBroadcastMeasurementCount, setBroadcastSignalCount, setBundleContext, setConfigurationInformation, setInformation, setListenersNull, setLogLevel, setMetrics, setNotificationController, setNotificationPriority, setNotificationService, setState, setStateLocal, setStyle, setTransport, setupCustom, setupNotification, setupNotificationCustom, startupCommands, startupCommands, toString, toStringInfo, transportStartedWait, unregister, unsubscribe, updateBroadcastCommandCount, updateBroadcastMeasurementCount, updateBroadcastSignalCount, validConfigurationId

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

equalsValue, findMethod, getCodeKey, getKey, getQualifiedKey, getResource, setKey, setQualifiedKey

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

createBoolean, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getByte, getChar, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getDouble, getFloat, getId, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails7, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, getShort, getSimpleClassName, getStaticBoolean, getStaticByte, getStaticChar, getStaticDouble, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticShort, getStaticString, 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, reportError, reportSystemInfo, setBackward, setDebug, setDefaultLogService, setLogService, setTraceLevel, setUnmodifiable, shouldLog, sleep, startupEscStatic, toStringConfigurationKeys

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME

Defines the full class name.

Since:

1.0

See Also:

Constant Field Values

status

protected final Measurement status

Defines the Status measurement.

Since:

1.0

configuration

protected final Measurement configuration

Defines the Configuration measurement.

Since:

1.0

capabilities

protected final Measurement capabilities

Defines the Capabilities measurement.

Since:

1.0

Constructor Detail

BaseDevice

public BaseDevice()

Constructs a new instance of the BaseDevice class.

Since:

1.0

Method Detail

getDefaultKey

public java.lang.String getDefaultKey()

Gets the default key of the device.

Overrides:

getDefaultKey in class Device

Returns:

String The default key

Since:

1.0

See Also:

Container.getDefaultKey()

getDefaultTransport

public TransportService getDefaultTransport()

Gets the default TransportService.

Returns:

TransportService The default TransportService.

Since:

1.0

getControlCapacity

public int getControlCapacity()

Gets the control capacity.

Overrides:

getControlCapacity in class Container

Returns:

The control capacity value.

Since:

1.0

getMessageCapacity

public int getMessageCapacity()

Gets the message capacity.

Overrides:

getMessageCapacity in class Device

Returns:

int The message capacity.

Since:

1.0

getStatus

public MeasurementService getStatus()

Defines the Status measurement.

Overrides:

getStatus in class Device

Returns:

The status value.

Since:

1.0

See Also:

Container.broadcastStatus(), Container.broadcastStatus(Object,int,int)

getConfiguration

public MeasurementService getConfiguration()

Defines the Configuration measurement.

Overrides:

getConfiguration in class Device

Returns:

The configuration value.

Since:

1.0

getCapabilities

public MeasurementService getCapabilities()

Defines the Capabilities measurement.

Overrides:

getCapabilities in class Device

Returns:

The capabilities value.

Since:

1.0

setup

public void setup()

Description copied from class: Container

Method setup.

Overrides:

setup in class Container

Since:

1.2

See Also:

Container.setup()