obs::EventVar Class Reference

Generic event handling between for example MVC Model and Controller based on a shared EventVar variable. More...

#include <evtvar.h>

Inheritance diagram for obs::EventVar:

Public Member Functions
void	Notify () override
	Notify all listeners, no data supplied.
void	Notify (void *data)
	Notify all listeners about variable change with ClientData.
void	Notify (const std::string &s)
	Notify all listeners about variable change with a string.
void	Notify (int n, const std::string &s)
	Notify all listeners about variable change with a string and an int.
void	Notify (int n, void *p)
	Notify all listeners about variable change with an int and ClientData.
void	Notify (const std::shared_ptr< void > &p, const std::string &s, int n=0)
	Notify all listeners about variable change with shared_ptr, a string and an optional number.
void	Notify (const std::shared_ptr< const void > &p) override
	Notify all listeners about variable change with const* shared_ptr,.
Public Member Functions inherited from obs::Observable
	Observable (const std::string &_key)
	Initiate an object which can apply Notify() and Listen() to given key.
	Observable (const KeyProvider &kp)
	Initiate an object which can apply Notify() and Listen() to given key.
bool	Unlisten (wxEvtHandler *listener, wxEventType ev)
	Remove window listening to ev from list of listeners.
std::string	GetKey () const override
	Return the key given to the constructor.

Additional Inherited Members
Public Attributes inherited from obs::Observable
const std::string	key
	The key used to create and clone.
Protected Member Functions inherited from obs::Observable
void	Notify (const std::shared_ptr< const void > &ptr, const std::string &s, int num, void *client_data)
	Notify all listeners: send them a 'type' ObservedEvt message as defined by Listen() with optional data available using GetString(), GetClientData(), GetInt() and/or GetSharedPtr()
void	Notify (const std::string &s, void *client_data)
	Notify all listeners: send them a 'type' ObservedEvt message as defined by Listen() with optional data available using GetString(), and/or GetClientData().

Detailed Description

Generic event handling between for example MVC Model and Controller based on a shared EventVar variable.

Model usage:

class Model: ...
public:
  EventVar change;
 
  void SomeMethod() {
    ...
    change.Notify("new value");
    wxYield();    // See note below
  }

Controller/GUI usage:

class Gui: public wxEvtHandler {
public:
  Gui:Gui(Model& model) {
    auto action = [&](wxCommandEvent ev) {
      auto s = ev.GetString();    // s -> "new value"
      ... do something;
    });
    change_listener.Init(model.change, action);
  }
private:
  ObsListener change_listener;
}

Note

: The Notify() method actually generates an event which is added to the global event queue. If listeners should process the event immediately, a wxYield() directly after the Notify() keeps the listener delay at a minimum.

Definition at line 78 of file evtvar.h.

Constructor & Destructor Documentation

EventVar()

obs::EventVar::EventVar ( )

inline

Definition at line 80 of file evtvar.h.

Member Function Documentation

Notify() [1/7]

void obs::EventVar::Notify ( )

inlineoverridevirtual

Notify all listeners, no data supplied.

Reimplemented from obs::Observable.

Definition at line 83 of file evtvar.h.

Notify() [2/7]

void obs::EventVar::Notify ( const std::shared_ptr< const void > &  p )

inlineoverridevirtual

Notify all listeners about variable change with const* shared_ptr,.

Reimplemented from obs::Observable.

Definition at line 108 of file evtvar.h.

Notify() [3/7]

void obs::EventVar::Notify ( const std::shared_ptr< void > &  p, const std::string &  s, int  n = 0  )

inline

Notify all listeners about variable change with shared_ptr, a string and an optional number.

Definition at line 103 of file evtvar.h.

Notify() [4/7]

void obs::EventVar::Notify ( const std::string &  s )

inline

Notify all listeners about variable change with a string.

Definition at line 89 of file evtvar.h.

Notify() [5/7]

void obs::EventVar::Notify ( int  n, const std::string &  s  )

inline

Notify all listeners about variable change with a string and an int.

Definition at line 92 of file evtvar.h.

Notify() [6/7]

void obs::EventVar::Notify ( int  n, void *  p  )

inline

Notify all listeners about variable change with an int and ClientData.

Definition at line 97 of file evtvar.h.

Notify() [7/7]

void obs::EventVar::Notify ( void *  data )

inline

Notify all listeners about variable change with ClientData.

Definition at line 86 of file evtvar.h.

---

The documentation for this class was generated from the following file:

• /home/runner/work/main/main/opencpn/libs/observable/include/observable/evtvar.h