Health-GPS  1.2.2.0
Global Health Policy Simulation model (Health-GPS)
hgps::EventSubscriberHandler Class Referencefinal

Implements the event subscriber handler data type. More...

#include <event_subscriber.h>

Inheritance diagram for hgps::EventSubscriberHandler:
[legend]
Collaboration diagram for hgps::EventSubscriberHandler:
[legend]

Public Member Functions

 EventSubscriberHandler ()=delete
 
 EventSubscriberHandler (EventHandlerIdentifier id, EventAggregator *hub)
 Initialise a new instance of the EventSubscriberHandler class. More...
 
 EventSubscriberHandler (const EventSubscriberHandler &other)=delete
 
EventSubscriberHandleroperator= (const EventSubscriberHandler &other)=delete
 
 EventSubscriberHandler (EventSubscriberHandler &&other)=delete
 
EventSubscriberHandleroperator= (EventSubscriberHandler &&other)=delete
 
 ~EventSubscriberHandler ()
 Destroys a EventSubscriberHandler instance. More...
 
void unsubscribe () const override
 Unsubscribes from the event. More...
 
const EventHandlerIdentifier id () const noexcept override
 Gets the subscriber unique identifier. More...
 
- Public Member Functions inherited from hgps::EventSubscriber
 EventSubscriber ()=default
 Initialises a new instance of the EventSubscriber class. More...
 
 EventSubscriber (const EventSubscriber &)=delete
 
 EventSubscriber (EventSubscriber &&)=delete
 
EventSubscriberoperator= (const EventSubscriber &)=delete
 
EventSubscriberoperator= (EventSubscriber &&)=delete
 
virtual ~EventSubscriber ()=default
 Destroys a EventSubscriber instance. More...
 

Detailed Description

Implements the event subscriber handler data type.

Constructor & Destructor Documentation

◆ EventSubscriberHandler() [1/4]

hgps::EventSubscriberHandler::EventSubscriberHandler ( )
delete

◆ EventSubscriberHandler() [2/4]

hgps::EventSubscriberHandler::EventSubscriberHandler ( EventHandlerIdentifier  id,
EventAggregator hub 
)

Initialise a new instance of the EventSubscriberHandler class.

Parameters
idThe event handler identifier
hubThe event aggregator instance to subscribe
Exceptions
std::invalid_argumentfor null event aggregator hub argument

◆ EventSubscriberHandler() [3/4]

hgps::EventSubscriberHandler::EventSubscriberHandler ( const EventSubscriberHandler other)
delete

◆ EventSubscriberHandler() [4/4]

hgps::EventSubscriberHandler::EventSubscriberHandler ( EventSubscriberHandler &&  other)
delete

◆ ~EventSubscriberHandler()

hgps::EventSubscriberHandler::~EventSubscriberHandler ( )

Destroys a EventSubscriberHandler instance.

Here is the call graph for this function:

Member Function Documentation

◆ id()

const EventHandlerIdentifier hgps::EventSubscriberHandler::id ( ) const
overridevirtualnoexcept

Gets the subscriber unique identifier.

Returns
The event handler identifier

Implements hgps::EventSubscriber.

◆ operator=() [1/2]

EventSubscriberHandler& hgps::EventSubscriberHandler::operator= ( const EventSubscriberHandler other)
delete

◆ operator=() [2/2]

EventSubscriberHandler& hgps::EventSubscriberHandler::operator= ( EventSubscriberHandler &&  other)
delete

◆ unsubscribe()

void hgps::EventSubscriberHandler::unsubscribe ( ) const
overridevirtual

Unsubscribes from the event.

Implements hgps::EventSubscriber.

Here is the call graph for this function:
Here is the caller graph for this function:

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