EventGenerator
¶
-
class
EventGenerator
(name, events_active=True)[source]¶ Bases:
taurus.core.util.object.Object
Base class capable of firing events
-
WaitTimeout
= 0.1¶
-
getEventsActive
()[source]¶ Determines is events are active :return: True if events are active or False otherwise :rtype: bool
-
isSubscribed
(cb, data=None)[source]¶ Determines if the given callback is registered for this event.
Parameters: - cb (callable) – a callable object
- data (object) – extra data to send each time an event is triggered on the given callback. Default is None
Returns: True if callback is registered or False otherwise
Return type: bool
-
setEventsActive
(events_active)[source]¶ (De)activates events on this event generator.
Parameters: events_active (bool) – activate/deactivate events
-
subscribeEvent
(cb, data=None)[source]¶ Subscribes to the event
Parameters: - cb (callable) – a callable object
- data (object) – extra data to send each time an event is triggered on the given callback. Default is None
-
unsubscribeEvent
(cb, data=None)[source]¶ Unsubscribes the given callback from the event. If the callback is not a listener for this event a debug message is generated an nothing happens.
Parameters: - cb (callable) – a callable object
- data (object) – extra data to send each time an event is triggered on the given callback. Default is None
-
waitEvent
(val=None, equal=True, any=False, timeout=None, stack=None)[source]¶ Waits for an event to occur
Parameters: - val (object) – event value
- equal (bool) – check for equality. Default is True
- any (bool) – if True unblock after first event, not matter what value it has. Default is False.
- timeout (float) – maximum time to wait (seconds). Default is None meaning wait forever.
- stack – For internal usage only.
Returns: the value of the event that unblocked the wait
Return type: object
-