•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Search Results
mpqc::utility::Observer Class Reference
Documentation
helps to set up messaging between objects via the Observer pattern
Use as a base class for any class that wants to receive messages from Observable objects.
Public Member Functions | |
Observer ()=default | |
template<typename Observee > | |
Observer (Observee *observee, std::function< void()> message) | |
Observer (const Observer &other)=delete | |
Observer & operator= (const Observer &other)=delete | |
Observer (Observer &&other)=default | |
Observer & operator= (Observer &&other)=default | |
virtual ~Observer () | |
Protected Member Functions | |
template<typename Observee > | |
void register_message (Observee *observee, std::function< void()> message) | |
void clear_messages () | |
Constructor & Destructor Documentation
◆ Observer() [1/4]
|
default |
The default ctor
- Note
- using the default ctor requires you to call register_message manually
◆ Observer() [2/4]
template<typename Observee >
|
inline |
This constructor registers one message
- Parameters
-
observee the Observee object to send us the message
message the message to be sent
◆ Observer() [3/4]
|
delete |
◆ Observer() [4/4]
|
default |
◆ ~Observer()
|
inlinevirtual |
Member Function Documentation
◆ clear_messages()
|
inlineprotected |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ register_message()
template<typename Observee >
|
inlineprotected |
registers a message with an Observee object, will be called whenever Observee::update() is called on observee
- Template Parameters
-
Observee a class derived from Observable
The documentation for this class was generated from the following file:
- mpqc/util/misc/observer.h