org.eclipse.soda.dk.signal.service
Interface SignalService

All Superinterfaces:

ControlService

All Known Implementing Classes:

ConcreteSignal, ConcreteSignalFieldSignal, DataSignal, MessageSignal, MethodSignal, ParameterSignal, Signal, SignalFieldSignal, Signals, TransformSignal

public interface SignalService
extends ControlService

The SignalService interface defines the SignalService concept. A SignalService is a notification of a message received from a hardware device. An application may register interest by using the SignalListener interface, and be notified whenever the SignalService occurs.

Since:

1.0

Version:

1.2.0

See Also:

ControlService, SignalListener

Method Summary

void	addSignalListener(SignalListener signalListener) Adds the specified listener to receive listener notification.
void	removeSignalListener(SignalListener signalListener) Removes the specified listener from receiving listener notification.
void	trigger() This method causes the SignalService to be written out.
void	trigger(ChannelService channel) This method causes the SignalService to be written out.
void	trigger(ChannelService channel, java.lang.Object value) This method causes the SignalService to be written out with data equal to the value argument.
void	trigger(java.lang.Object value) This method causes the SignalService to be written out with data equal to the value argument.

Methods inherited from interface org.eclipse.soda.dk.device.service.ControlService

getKey

Method Detail

addSignalListener

void addSignalListener(SignalListener signalListener)

Adds the specified listener to receive listener notification. This method adds a Listener to the list of current listeners on this SignalService. Each time this signal is read, all the Listeners of this signal will be notified using the SignalListener interface.

Parameters:

signalListener - The signal listener (SignalListener) parameter.

See Also:

removeSignalListener(SignalListener)

removeSignalListener

void removeSignalListener(SignalListener signalListener)

Removes the specified listener from receiving listener notification. This method removes a Listener to the list of current listeners on this SignalService. The SignalListener will no longer be notified each time this signal is received.

Parameters:

signalListener - The signal listener (SignalListener) parameter.

See Also:

addSignalListener(SignalListener)

trigger

void trigger()

This method causes the SignalService to be written out. Effectively this allows a SignalService to behave as a CommandService. This method is used for simulation, not for runtime systems.

See Also:

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

trigger

void trigger(ChannelService channel)

This method causes the SignalService to be written out. Effectively this allows a SignalService to behave as a CommandService. This method is used for simulation, not for runtime systems.

Parameters:

channel - The channel (ChannelService) parameter.

Since:

1.2

See Also:

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

trigger

void trigger(ChannelService channel,
             java.lang.Object value)

This method causes the SignalService to be written out with data equal to the value argument. Effectively this allows a SignalService to behave as a CommandService which has data. This method is used for simulation, not for runtime systems.

Parameters:

channel - The channel (ChannelService) parameter.

value - The value (Object) parameter.

Since:

1.2

See Also:

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

trigger

void trigger(java.lang.Object value)

This method causes the SignalService to be written out with data equal to the value argument. Effectively this allows a SignalService to behave as a CommandService which has data. This method is used for simulation, not for runtime systems.

Parameters:

value - The value (Object) parameter.

See Also:

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