org.eclipse.soda.dk.signal
Class Signal

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.device.Control
          org.eclipse.soda.dk.signal.Signal

All Implemented Interfaces:

ControlService, SignalService, ErrorListener

Direct Known Subclasses:

MessageSignal, MethodSignal, SignalFieldSignal, Signals

public class Signal
extends Control
implements SignalService

The Signal class implements the SignalService interface.

Since:

1.0

Version:

1.2.0

See Also:

Control, ControlService, ErrorListener, MessageHandler, SignalService

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

Signal(java.lang.String key)
Constructs an Signal object using the input parameter(s).

Method Summary

void	addSignalListener(SignalListener signalListener) Adds the specified listener to receive listener notification.
void	fireErrorOccurred(java.lang.Object timestamp, java.lang.Object data) Fire error occurred with the specified timestamp and data parameters.
protected void	fireErrorOccurred(SignalListener signalListener, java.lang.Object timestamp, java.lang.Object data) Fire error occurred with the specified signal listener, timestamp and data parameters.
void	fireSignalOccurred(SignalListener signalListener, java.lang.Object timestamp) Fire signal occurred with the specified signal listener and timestamp parameters.
void	fireSignalOccurred(SignalListener signalListener, java.lang.Object timestamp, ChannelService channel) Fire signal occurred with the specified signal listener, timestamp and channel parameters.
void	fireSignalOccurred(SignalListener signalListener, java.lang.Object timestamp, ChannelService channel, java.lang.Object data) Fire signal occurred with the specified signal listener, timestamp, channel and data parameters.
void	fireSignalOccurred(SignalListener signalListener, java.lang.Object timestamp, java.lang.Object data) Fire signal occurred with the specified signal listener, timestamp and data parameters.
protected SignalListener	getSignalListener() Gets the SignalListener signalListener property value.
void	removeSignalListener(SignalListener signalListener) Removes the specified listener from receiving listener notification.
protected void	reportError(int errorNumber, java.lang.Throwable error, java.lang.Object[] errorObjects) Report error with the specified error number, error and error objects parameters.
void	setSignalListener(SignalListener signalListener) Sets the signalListener.
void	trigger() Perform the trigger action method.
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.
void	trigger(ChannelService channel, java.lang.Object data, java.lang.Object timestamp) Trigger with the specified channel, data and timestamp parameters.
void	trigger(java.lang.Object value) Perform the trigger action method.
void	trigger(java.lang.Object data, java.lang.Object timestamp) Perform the trigger action method.

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.service.ControlService

getKey

Constructor Detail

Signal

public Signal(java.lang.String key)

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

Parameters:

key - The key (String) parameter.

Method Detail

addSignalListener

public void addSignalListener(SignalListener signalListener)

Adds the specified listener to receive listener notification.

Specified by:

addSignalListener in interface SignalService

Parameters:

signalListener - The signal listener (SignalListener) parameter.

See Also:

SignalService.addSignalListener(org.eclipse.soda.dk.signal.service.SignalListener), getSignalListener(), removeSignalListener(SignalListener), setSignalListener(SignalListener)

fireErrorOccurred

public void fireErrorOccurred(java.lang.Object timestamp,
                              java.lang.Object data)

Fire error occurred with the specified timestamp and data parameters.

Parameters:

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

See Also:

fireErrorOccurred(SignalListener,Object,Object)

fireErrorOccurred

protected void fireErrorOccurred(SignalListener signalListener,
                                 java.lang.Object timestamp,
                                 java.lang.Object data)

Fire error occurred with the specified signal listener, timestamp and data parameters.

Parameters:

signalListener - The signal listener (SignalListener) parameter.

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

See Also:

fireErrorOccurred(Object,Object)

fireSignalOccurred

public void fireSignalOccurred(SignalListener signalListener,
                               java.lang.Object timestamp)

Fire signal occurred with the specified signal listener and timestamp parameters.

Parameters:

signalListener - The signal listener (SignalListener) parameter.

timestamp - The time stamp (Object) parameter.

See Also:

fireSignalOccurred(SignalListener,Object,ChannelService), fireSignalOccurred(SignalListener,Object,ChannelService,Object), fireSignalOccurred(SignalListener,Object,Object)

fireSignalOccurred

public void fireSignalOccurred(SignalListener signalListener,
                               java.lang.Object timestamp,
                               ChannelService channel)

Fire signal occurred with the specified signal listener, timestamp and channel parameters.

Parameters:

signalListener - The signal listener (SignalListener) parameter.

timestamp - The time stamp (Object) parameter.

channel - The channel (ChannelService) parameter.

Since:

1.2

See Also:

fireSignalOccurred(SignalListener,Object), fireSignalOccurred(SignalListener,Object,ChannelService,Object), fireSignalOccurred(SignalListener,Object,Object)

fireSignalOccurred

public void fireSignalOccurred(SignalListener signalListener,
                               java.lang.Object timestamp,
                               ChannelService channel,
                               java.lang.Object data)

Fire signal occurred with the specified signal listener, timestamp, channel and data parameters.

Parameters:

signalListener - The signal listener (SignalListener) parameter.

timestamp - The time stamp (Object) parameter.

channel - The channel (ChannelService) parameter.

data - The data (Object) parameter.

Since:

1.2

See Also:

fireSignalOccurred(SignalListener,Object), fireSignalOccurred(SignalListener,Object,ChannelService), fireSignalOccurred(SignalListener,Object,Object)

fireSignalOccurred

public void fireSignalOccurred(SignalListener signalListener,
                               java.lang.Object timestamp,
                               java.lang.Object data)

Fire signal occurred with the specified signal listener, timestamp and data parameters.

Parameters:

signalListener - The signal listener (SignalListener) parameter.

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

See Also:

fireSignalOccurred(SignalListener,Object), fireSignalOccurred(SignalListener,Object,ChannelService), fireSignalOccurred(SignalListener,Object,ChannelService,Object)

getSignalListener

protected SignalListener getSignalListener()

Gets the SignalListener signalListener property value.

Returns:

Results of the get signal listener (SignalListener) value.

See Also:

addSignalListener(SignalListener), removeSignalListener(SignalListener), setSignalListener(SignalListener)

removeSignalListener

public void removeSignalListener(SignalListener signalListener)

Removes the specified listener from receiving listener notification.

Specified by:

removeSignalListener in interface SignalService

Parameters:

signalListener - The signal listener (SignalListener) parameter.

See Also:

SignalService.removeSignalListener(org.eclipse.soda.dk.signal.service.SignalListener), addSignalListener(SignalListener), getSignalListener(), setSignalListener(SignalListener)

reportError

protected void reportError(int errorNumber,
                           java.lang.Throwable error,
                           java.lang.Object[] errorObjects)
                    throws java.lang.RuntimeException

Report error with the specified error number, error and error objects parameters.

Overrides:

reportError in class EscObject

Parameters:

errorNumber - The error number (int) parameter.

error - The error (Throwable) parameter.

errorObjects - The error objects (Object[]) parameter.

Throws:

java.lang.RuntimeException - Runtime Exception.

See Also:

EscObject.handleStaticError(String), EscObject.attemptRecoveryFromError(int,Throwable), EscObject.handleError(Throwable,int), EscObject.handleError(Throwable,int,Object), EscObject.handleError(Throwable,int,Object,Object), EscObject.handleError(Throwable,int,Object[])

setSignalListener

public void setSignalListener(SignalListener signalListener)

Sets the signalListener.

Parameters:

signalListener - The signal listener (SignalListener) parameter.

See Also:

addSignalListener(SignalListener), getSignalListener(), removeSignalListener(SignalListener)

trigger

public void trigger()

Perform the trigger action method.

Specified by:

trigger in interface SignalService

See Also:

SignalService.trigger(), trigger(ChannelService), trigger(ChannelService,Object), trigger(ChannelService,Object,Object), trigger(Object), trigger(Object,Object)

trigger

public void trigger(ChannelService channel)

Trigger with the specified channel parameter.

Specified by:

trigger in interface SignalService

Parameters:

channel - The channel (ChannelService) parameter.

Since:

1.2

See Also:

trigger(), trigger(ChannelService,Object), trigger(ChannelService,Object,Object), trigger(Object), trigger(Object,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

Parameters:

channel - The channel (ChannelService) parameter.

object - The object (Object) parameter.

Since:

1.2

See Also:

trigger(), trigger(ChannelService), trigger(ChannelService,Object,Object), trigger(Object), trigger(Object,Object)

trigger

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

Trigger with the specified channel, data and timestamp parameters.

Parameters:

channel - The channel (ChannelService) parameter.

data - The data (Object) parameter.

timestamp - The time stamp (Object) parameter.

Since:

1.2

See Also:

trigger(), trigger(ChannelService), trigger(ChannelService,Object), trigger(Object), trigger(Object,Object)

trigger

public void trigger(java.lang.Object value)

Perform the trigger action method.

Specified by:

trigger in interface SignalService

Parameters:

value - The value (Object) parameter.

See Also:

SignalService.trigger(Object), trigger(), trigger(ChannelService), trigger(ChannelService,Object), trigger(ChannelService,Object,Object), trigger(Object,Object)

trigger

public void trigger(java.lang.Object data,
                    java.lang.Object timestamp)

Perform the trigger action method.

Parameters:

data - The data (Object) parameter.

timestamp - The time stamp (Object) parameter.

See Also:

trigger(), trigger(ChannelService), trigger(ChannelService,Object), trigger(ChannelService,Object,Object), trigger(Object)