CVBpy 15.0
NotifyObservable Class Reference

Single notify event observable. More...

Inherits object.

Public Member Functions

cvb.EventCookie register_event (self, Callable[[cvb.NotifyArgs], None] handler)
 Register a listener to this observable. More...
 
None unregister_event (self, cvb.EventCookie event_cookie)
 Manually unregister a listener to this observable. More...
 

Properties

 description = property
 str: The string identifier of this event.
 
 id = property
 int: Get the native ID.
 
 is_available = property
 bool: Gets whether the current device can actually handle this event.
 

Detailed Description

Single notify event observable.

Member Function Documentation

◆ register_event()

cvb.EventCookie register_event (   self,
Callable[[cvb.NotifyArgs], None]  handler 
)

Register a listener to this observable.

Parameters

handler : Callable[[cvb.NotifyArgs], None] Listener, to this observable.

Returns

cvb.EventCookie Event cookie, to manually unregister the listener.

◆ unregister_event()

None unregister_event (   self,
cvb.EventCookie  event_cookie 
)

Manually unregister a listener to this observable.

Parameters

event_cookie : cvb.EventCookie Event cookie, obtained from registering the listener.