org.eclipse.soda.dk.signal
Class Signals

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

All Implemented Interfaces:

ControlService, MultiplexSignalListener, SignalListener, SignalService, ErrorListener

public class Signals
extends Signal
implements MultiplexSignalListener

The Signals class implements the SignalService interface.

Since:

1.0

Version:

1.2.0

See Also:

Control, Signal, ControlService, ErrorListener, MessageHandler, SignalService, SignalListener

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

Signals(java.lang.String key, SignalService[] signals)
Constructs an Signals object using the input parameter(s).

Method Summary

protected void	addInternalSignalListener() Adds the specified listener to receive listener notification.
SignalService[]	getSignals() Gets the org.eclipse.soda.dk.signal.service.SignalService [] signals property value.
protected void	removeInternalSignalListener() Removes the specified listener from receiving listener notification.
protected void	setSignals(SignalService[] signals) Sets the signals value.
void	signalOccurred(SignalService source, java.lang.Object timestamp, ChannelService channel, java.lang.Object data) Signal occurred with the specified source, timestamp, channel and data parameters.
void	signalOccurred(SignalService source, java.lang.Object timestamp, java.lang.Object data) This method is fired to all Listeners each time the signal triggered.
void	trigger(ChannelService channel) Trigger with the specified channel parameter.
void	trigger(ChannelService channel, java.lang.Object object) Trigger with the specified channel and object parameters.

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

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

Signals

public Signals(java.lang.String key,
               SignalService[] signals)

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

Parameters:

key - The key (String) parameter.

signals - The signals (SignalService[]) parameter.

See Also:

getSignals(), setSignals(SignalService[])

Method Detail

addInternalSignalListener

protected void addInternalSignalListener()

Adds the specified listener to receive listener notification.

See Also:

removeInternalSignalListener()

getSignals

public SignalService[] getSignals()

Gets the org.eclipse.soda.dk.signal.service.SignalService [] signals property value.

Returns:

Results of the get signals (SignalService[]) value.

See Also:

Signals(String,SignalService[]), setSignals(SignalService[])

removeInternalSignalListener

protected void removeInternalSignalListener()

Removes the specified listener from receiving listener notification.

See Also:

addInternalSignalListener()

setSignals

protected void setSignals(SignalService[] signals)

Sets the signals value.

Parameters:

signals - The signals (SignalService[]) parameter.

See Also:

Signals(String,SignalService[]), getSignals()

signalOccurred

public void signalOccurred(SignalService source,
                           java.lang.Object timestamp,
                           ChannelService channel,
                           java.lang.Object data)

Signal occurred with the specified source, timestamp, channel and data parameters.

Specified by:

signalOccurred in interface MultiplexSignalListener

Parameters:

source - The source (SignalService) parameter.

timestamp - The time stamp (Object) parameter.

channel - The channel (ChannelService) parameter.

data - The data (Object) parameter.

Since:

1.2

See Also:

signalOccurred(SignalService,Object,Object)

signalOccurred

public void signalOccurred(SignalService source,
                           java.lang.Object timestamp,
                           java.lang.Object data)

This method is fired to all Listeners each time the signal triggered. The signal can be triggered when a message is received from the hardware or when the trigger method is invoked by the application. 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:

signalOccurred in interface SignalListener

Parameters:

source - The source (SignalService) parameter.

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

See Also:

signalOccurred(SignalService,Object,ChannelService,Object)

trigger

public void trigger(ChannelService channel)

Trigger with the specified channel parameter.

Specified by:

trigger in interface SignalService

Overrides:

trigger in class Signal

Parameters:

channel - The channel (ChannelService) parameter.

See Also:

trigger(ChannelService,Object)

trigger

public void trigger(ChannelService channel,
                    java.lang.Object object)

Trigger with the specified channel and object parameters.

Specified by:

trigger in interface SignalService

Overrides:

trigger in class Signal

Parameters:

channel - The channel (ChannelService) parameter.

object - The object (Object) parameter.

See Also:

trigger(ChannelService)