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, SignalListener, SignalService, ErrorListener

public class Signals
extends Signal
implements SignalListener

The Signals class implements the SignalService interface.

Version:

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

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 property.
void	signalOccurred(SignalService source, java.lang.Object timestamp, java.lang.Object data) This method is fired to all Listeners each time the signal triggerred.
void	trigger() Perform the trigger action method.
void	trigger(java.lang.Object object) Perform the trigger action method.

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

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

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.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 - java.lang.String

signals - org.eclipse.soda.dk.signal.service.SignalService[]

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

Parameters:

signals - The new property value (org.eclipse.soda.dk.signal.service.SignalService[]).

See Also:

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

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 triggerred. The signal can be triggered when a message is recevied 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 (eg calling read on a measuremnt).
• Handle this call quickly and return.

Specified by:

signalOccurred in interface SignalListener

Parameters:

source - The SignalService which fired.

timestamp - The time at which the signal was detected.

data - Contains any data which was contained within the signal.

trigger

public void trigger()

Perform the trigger action method.

Specified by:

trigger in interface SignalService

Overrides:

trigger in class Signal

See Also:

SignalService.trigger(), trigger(Object)

trigger

public void trigger(java.lang.Object object)

Perform the trigger action method.

Specified by:

trigger in interface SignalService

Overrides:

trigger in class Signal

Parameters:

object - java.lang.Object

See Also:

SignalService.trigger(), trigger()