Class EventModule
- java.lang.Object
-
- laas.openrobots.ontology.modules.events.EventModule
-
- All Implemented Interfaces:
IServiceProvider
public class EventModule extends java.lang.Object implements IServiceProvider
This class allows the registration of event by external client through the#registerEvent(String, String, Set, IEventConsumer)
RPC method.
-
-
Constructor Summary
Constructors Constructor Description EventModule(IOntologyBackend oro)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearEvent(java.lang.String eventId)
Removes one event trigger from the model.void
clearEvents()
java.util.UUID
registerEvent(java.lang.String type, java.lang.String triggeringType, java.lang.String variable, java.util.List<java.lang.String> pattern, IEventConsumer consumer)
java.util.UUID
registerEvent(java.lang.String type, java.lang.String triggeringType, java.util.List<java.lang.String> pattern, IEventConsumer consumer)
-
-
-
Constructor Detail
-
EventModule
public EventModule(IOntologyBackend oro)
-
-
Method Detail
-
registerEvent
@RPCMethod(category="events", desc="registers an event. Expected parameters are: type, triggering type, event pattern.") public java.util.UUID registerEvent(java.lang.String type, java.lang.String triggeringType, java.util.List<java.lang.String> pattern, IEventConsumer consumer) throws InvalidEventDescriptorException, EventRegistrationException
-
registerEvent
@RPCMethod(category="events", desc="registers an event. Expected parameters are: type, triggering type, variable, event pattern.") public java.util.UUID registerEvent(java.lang.String type, java.lang.String triggeringType, java.lang.String variable, java.util.List<java.lang.String> pattern, IEventConsumer consumer) throws InvalidEventDescriptorException, EventRegistrationException
-
clearEvents
@RPCMethod(category="events", desc="Remove all events associated to the main model.") public void clearEvents()
-
clearEvent
@RPCMethod(category="events", desc="Remove one specific event from the main model.") public void clearEvent(java.lang.String eventId) throws OntologyServerException
Removes one event trigger from the model.- Parameters:
eventId
- the string representation of the UUID of the event, as returned by #addEvent- Throws:
OntologyServerException
-
-