NRE::Event::EventEmitter< T > Class Template Reference

Manage event emission to all listener. More...

#include <NRE_EventEmitter.hpp>

Inheritance diagram for NRE::Event::EventEmitter< T >:
NRE::Event::AbstractEventEmitter

Public Member Functions

 EventEmitter ()=default
 
 EventEmitter (EventEmitter const &e)=default
 
 EventEmitter (EventEmitter &&e)=default
 
 ~EventEmitter ()=default
 
template<class... Args>
bool emit (Args &&...args)
 
EventEmitteroperator= (EventEmitter const &e)=default
 
EventEmitteroperator= (EventEmitter &&e)=default
 
- Public Member Functions inherited from NRE::Event::AbstractEventEmitter
 AbstractEventEmitter ()=default
 
 AbstractEventEmitter (AbstractEventEmitter const &e)=default
 
 AbstractEventEmitter (AbstractEventEmitter &&e)=default
 
virtual ~AbstractEventEmitter ()=default
 
bool isConsumed () const
 
void setConsumed (bool state)
 
AbstractEventEmitteroperator= (AbstractEventEmitter const &e)=default
 
AbstractEventEmitteroperator= (AbstractEventEmitter &&e)=default
 

Static Public Member Functions

static Category getCategory ()
 

Additional Inherited Members

- Public Types inherited from NRE::Event::AbstractEventEmitter
typedef std::size_t Category
 
- Static Public Attributes inherited from NRE::Event::AbstractEventEmitter
static Category counter = 0
 

Detailed Description

template<class T>
class NRE::Event::EventEmitter< T >

Manage event emission to all listener.

Constructor & Destructor Documentation

template<class T>
NRE::Event::EventEmitter< T >::EventEmitter ( )
default

Construct the emitter

template<class T>
NRE::Event::EventEmitter< T >::EventEmitter ( EventEmitter< T > const &  e)
default

Copy e into this

Parameters
ethe event emitter to copy
template<class T>
NRE::Event::EventEmitter< T >::EventEmitter ( EventEmitter< T > &&  e)
default

Move e into this

Parameters
ethe event emitter to move
template<class T>
NRE::Event::EventEmitter< T >::~EventEmitter ( )
default

EventEmitter Deconstructor

Member Function Documentation

template<class T>
template<class... Args>
bool NRE::Event::EventEmitter< T >::emit ( Args &&...  args)

Emit a T event, created from passed argument pack

Parameters
argsthe T event construction's argument
Returns
if the event has been consumed
template<class T>
static Category NRE::Event::EventEmitter< T >::getCategory ( )
static
Returns
the T event emitter category
template<class T>
EventEmitter& NRE::Event::EventEmitter< T >::operator= ( EventEmitter< T > const &  e)
default

Copy e into this

Parameters
ethe object to copy into this
Returns
the reference of himself
template<class T>
EventEmitter& NRE::Event::EventEmitter< T >::operator= ( EventEmitter< T > &&  e)
default

Move e into this

Parameters
ethe object to move into this
Returns
the reference of himself

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