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, MultiplexMeasurementListener, MultiplexSignalListener, SignalListener, ErrorListener, MessageListener, MultiplexMessageListener, ResponseListener

Direct Known Subclasses:

MeasurementCommand

public class ParameterCommand
extends TransformCommand

The ParameterCommand class implements the CommandService interface.

Since:

1.0

Version:

1.2.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, 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

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

Method Summary

void	execute(ChannelService channel, java.lang.Object data) Execute with the specified channel and data parameters.
ParameterService	getParameter() Gets the ParameterService parameter property value.
void	messageReceived(TransportService transportService, java.lang.Object timestamp, ChannelService channel, MessageService message) Message received with the specified transport service, timestamp, channel and message parameters.
void	setParameter(ParameterService parameter) Sets the parameter value.

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

decode, encode, getTransform, setTransform

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

messageReceived, responseReceived

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

execute, getMessage, noResponseReceived, responseReceived, setMessage

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

getDevice, setDevice

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

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

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.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 - The key (String) parameter.

message - The message (MessageService) parameter.

transform - The transform (TransformService) parameter.

parameter - The parameter (ParameterService) parameter.

Method Detail

execute

public void execute(ChannelService channel,
                    java.lang.Object data)

Execute with the specified channel and data parameters.

Specified by:

execute in interface CommandService

Overrides:

execute in class TransformCommand

Parameters:

channel - The channel (ChannelService) parameter.

data - The data (Object) parameter.

See Also:

SimpleMessageCommand.execute(ChannelService)

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,
                            ChannelService channel,
                            MessageService message)

Message received with the specified transport service, timestamp, channel and message parameters.

Specified by:

messageReceived in interface MultiplexMessageListener

Overrides:

messageReceived in class TransformCommand

Parameters:

transportService - The transport service (TransportService) parameter.

timestamp - The time stamp (Object) parameter.

channel - The channel (ChannelService) parameter.

message - The message (MessageService) parameter.

See Also:

MessageCommand.messageReceived(TransportService,Object,MessageService), MessageCommand.responseReceived(TransportService,ChannelService,Object)

setParameter

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

Sets the parameter value.

Parameters:

parameter - The parameter (ParameterService) parameter.

Throws:

java.lang.IllegalArgumentException - Illegal Argument Exception.

See Also:

getParameter()