The observable notify/listen basic nuts and bolts. More...

#include <observable.h>

Inheritance diagram for Observable:

Public Member Functions
	Observable (const std::string &_key)

	Observable (const KeyProvider &kp)

	~Observable () override=default
	Destroy the Observable object.

virtual void	Notify ()
	Notify all listeners about variable change.

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

bool	Unlisten (wxEvtHandler *listener, wxEventType ev)
	Remove window listening to ev from list of listeners.

std::string	GetKey () const override
	Get the Key object from the Key Provider.

Public Member Functions inherited from KeyProvider
virtual	~KeyProvider ()=default
	Destroy the Key Provider object.

Public Attributes
const std::string	key
	The key used to create and clone.

Protected Member Functions
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() and/or GetClientData().

void	Notify (const std::string &s, void *client_data)

Friends
class	ObservableListener

Detailed Description

The observable notify/listen basic nuts and bolts.

Definition at line 100 of file observable.h.

Constructor & Destructor Documentation

◆ Observable() [1/2]

Observable::Observable ( const std::string & _key )

inlineexplicit

Definition at line 104 of file observable.h.

◆ Observable() [2/2]

Observable::Observable ( const KeyProvider & kp )

inlineexplicit

Definition at line 107 of file observable.h.

Member Function Documentation

◆ GetKey()

std::string Observable::GetKey ( ) const

inlineoverridevirtual

Get the Key object from the Key Provider.

Returns: std::string Key Object.

Implements KeyProvider.

Definition at line 125 of file observable.h.

◆ Notify() [1/4]

void Observable::Notify ( )

virtual

Notify all listeners about variable change.

Reimplemented in EventVar.

Definition at line 98 of file observable.cpp.

◆ Notify() [2/4]

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

inline

Definition at line 117 of file observable.h.

◆ Notify() [3/4]

void Observable::Notify	(	const std::shared_ptr< const void > &	ptr,
		const std::string &	s,
		int	num,
		void *	client_data
	)

protected

Notify all listeners: send them a 'type' ObservedEvt message as defined by listen() with optional data available using GetString() and/or GetClientData().

Definition at line 82 of file observable.cpp.

◆ Notify() [4/4]

void Observable::Notify	(	const std::string &	s,
		void *	client_data
	)

inlineprotected

Definition at line 139 of file observable.h.

◆ Unlisten()

bool Observable::Unlisten	(	wxEvtHandler *	listener,
		wxEventType	ev
	)

Remove window listening to ev from list of listeners.

Returns: true if such a listener existed, else false.

Definition at line 71 of file observable.cpp.

Friends And Related Symbol Documentation

◆ ObservableListener

friend class ObservableListener

friend

Definition at line 101 of file observable.h.

Member Data Documentation

◆ key

const std::string Observable::key

The key used to create and clone.

Definition at line 128 of file observable.h.

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

/home/runner/work/main/main/opencpn/libs/observable/include/observable.h
/home/runner/work/main/main/opencpn/libs/observable/src/observable.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Friends