org.eclipse.soda.dk.signal
Class ParameterSignal

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.device.Control
          org.eclipse.soda.dk.signal.Signal
              org.eclipse.soda.dk.signal.MessageSignal
                  org.eclipse.soda.dk.signal.DataSignal
                      org.eclipse.soda.dk.signal.TransformSignal
                          org.eclipse.soda.dk.signal.ParameterSignal

All Implemented Interfaces:

MessageHandler, ControlService, SignalService, ErrorListener, MessageListener, MultiplexMessageListener

Direct Known Subclasses:

ConcreteSignal

public class ParameterSignal
extends TransformSignal

The ParameterSignal class implements the SignalService interface.

Since:

1.0

Version:

1.2.0

See Also:

Control, DataSignal, MessageSignal, Signal, ControlService, ErrorListener, MessageHandler, ParameterService, SignalService, TransportListener

Field Summary

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

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

Method Summary

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

Methods inherited from class org.eclipse.soda.dk.signal.TransformSignal

decode, getTransform, setTransform

Methods inherited from class org.eclipse.soda.dk.signal.MessageSignal

getMessage, setMessage

Methods inherited from class org.eclipse.soda.dk.signal.Signal

addSignalListener, fireErrorOccurred, fireErrorOccurred, fireSignalOccurred, fireSignalOccurred, fireSignalOccurred, fireSignalOccurred, getSignalListener, removeSignalListener, reportError, setSignalListener, trigger, trigger, trigger, trigger, trigger, trigger

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

Constructor Detail

ParameterSignal

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

Constructs an ParameterSignal 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

getParameter

public ParameterService getParameter()

Gets the ParameterService parameter property value.

Overrides:

getParameter in class DataSignal

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 (e.g. calling read on a measurement).
• Handle this call quickly and return.

Specified by:

messageReceived in interface MessageListener

Overrides:

messageReceived in class TransformSignal

Parameters:

transportService - The transport service (TransportService) parameter.

timestamp - The time stamp (Object) parameter.

message - The message (MessageService) parameter.

See Also:

messageReceived(TransportService,Object,ChannelService,MessageService)

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 TransformSignal

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:

messageReceived(TransportService,Object,MessageService)

setParameter

public void setParameter(ParameterService parameter)

Sets the parameter value.

Parameters:

parameter - The parameter (ParameterService) parameter.

See Also:

getParameter()