org.eclipse.soda.dk.command
Class ParameterCommand

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.device.Control
          org.eclipse.soda.dk.command.Command
              org.eclipse.soda.dk.command.DeviceCommand
                  org.eclipse.soda.dk.command.SimpleMessageCommand
                      org.eclipse.soda.dk.command.MessageCommand
                          org.eclipse.soda.dk.command.DataCommand
                              org.eclipse.soda.dk.command.TransformCommand
                                  org.eclipse.soda.dk.command.ParameterCommand

All Implemented Interfaces:

CommandService, MessageHandler, ControlService, DeviceControl, MeasurementListener, SignalListener, ErrorListener, MessageListener

Direct Known Subclasses:

MeasurementCommand

public class ParameterCommand
extends TransformCommand

The ParameterCommand class implements the CommandService interface.

Version:

1.0.0

See Also:

Command, Control, DataCommand, DeviceCommand, MessageCommand, CommandService, ControlService, DeviceControl, ErrorListener, MeasurementListener, MessageHandler, ParameterService, SignalListener, TransportListener

Field Summary

Fields inherited from class org.eclipse.soda.dk.command.SimpleMessageCommand

message

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

ParameterCommand(java.lang.String key, MessageService message, TransformService transform, ParameterService parameter)
Constructs an ParameterCommand object using the input parameter(s).

Method Summary

void	execute(java.lang.Object data) Perform the execute action method.
ParameterService	getParameter() Gets the ParameterService parameter property value.
void	messageReceived(TransportService transportService, java.lang.Object timestamp, MessageService message) This API will be called each time the TransportService receives a valid message.
void	setParameter(ParameterService parameter) Sets the parameter property.

Methods inherited from class org.eclipse.soda.dk.command.TransformCommand

decode, encode, getTransform, setTransform

Methods inherited from class org.eclipse.soda.dk.command.SimpleMessageCommand

execute, getMessage, setMessage

Methods inherited from class org.eclipse.soda.dk.command.DeviceCommand

getDevice, setDevice

Methods inherited from class org.eclipse.soda.dk.command.Command

addCommandListener, fireCommandExecuted, fireCommandExecuted, fireErrorOccurred, fireErrorOccurred, getCommandListener, measurementChanged, removeCommandListener, reportError, setCommandListener, signalOccurred

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

getMessage

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

ParameterCommand

public ParameterCommand(java.lang.String key,
                        MessageService message,
                        TransformService transform,
                        ParameterService parameter)

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

Parameters:

key - java.lang.String

message - org.eclipse.soda.dk.message.service.MessageService

transform - org.eclipse.soda.dk.transform.service.TransformService

parameter - org.eclipse.soda.dk.tk.ParameterService

Method Detail

execute

public void execute(java.lang.Object data)

Perform the execute action method.

Specified by:

execute in interface CommandService

Overrides:

execute in class TransformCommand

Parameters:

data - java.lang.Object

See Also:

CommandService.execute()

getParameter

public ParameterService getParameter()

Gets the ParameterService parameter property value.

Returns:

Results of the get parameter (ParameterService) value.

See Also:

setParameter(ParameterService)

messageReceived

public void messageReceived(TransportService transportService,
                            java.lang.Object timestamp,
                            MessageService message)

This API will be called each time the TransportService receives a valid message. Since other notifications are blocked until this method returns, implementors of this method should:

• Not cause the device or transport to be blocked (eg calling read on a measuremnt).
• Handle this call quickly and return.

Specified by:

messageReceived in interface MessageListener

Overrides:

messageReceived in class TransformCommand

Parameters:

transportService - The transport that received the message.

timestamp - The timestamp when the message was detected.

message - The message received.

setParameter

public void setParameter(ParameterService parameter)
                  throws java.lang.IllegalArgumentException

Sets the parameter property.

Parameters:

parameter - The new property value (org.eclipse.soda.dk.tk.ParameterService).

Throws:

java.lang.IllegalArgumentException - Illegal Argument Exception.

See Also:

getParameter()