public interface IWatcher
A class which implements IWatcher is expected to represent an "event trigger
pattern" for the ontology. A watcher has a event type
and a watch pattern. See IWatcher.EventType
for details regarding
how the pattern should look like according to the event type.
When the event is triggered, its #notifySubscriber(OroEvent)
method
is called and expected to warn the event subscribers that the event they were
watching occurred.
The way the trigger is actually fired depends on the triggering mode, as
returned by getTriggeringType()
. Supported trigger mode are defined
in IWatcher.TriggeringType
.
Modifier and Type | Interface and Description |
---|---|
static class |
IWatcher.EventType
Constants that defines the type of event the event module can handle.
|
static class |
IWatcher.TriggeringType
Constants that defines the way an event is triggered.
|
Modifier and Type | Method and Description |
---|---|
void |
addSubscriber(IEventConsumer e) |
boolean |
equals(IWatcher gw) |
java.util.UUID |
getId()
Returns a unique (at least for this instance of the server) identifier
for the current event watcher.
|
IWatcher.EventType |
getPatternType() |
IWatcher.TriggeringType |
getTriggeringType() |
java.util.List<java.lang.String> |
getWatchPattern() |
void |
notifySubscribers(OroEvent e) |
java.util.List<java.lang.String> getWatchPattern()
IWatcher.EventType getPatternType()
IWatcher.TriggeringType getTriggeringType()
void notifySubscribers(OroEvent e)
void addSubscriber(IEventConsumer e)
java.util.UUID getId()
boolean equals(IWatcher gw)
ORO is a part of the OpenRobots framework.
openrobots@laas.fr
LAAS-CNRS 2009-2011