PRooFPS-dd Dev Doc 1.0
PRooFPS-dd Developer Documentation
Loading...
Searching...
No Matches
List of all members | Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes
proofps_dd::EventLister< TEvent > Class Template Reference

A specified maximum number of events stored in FIFO container for a limited amount of time. More...

Detailed Description

template<class TEvent = Event>
class proofps_dd::EventLister< TEvent >

A specified maximum number of events stored in FIFO container for a limited amount of time.

Typical event use cases: who killed who, items picked up by player, etc.

The TEvent template argument enables higher flexibility: some specialized event listers might require a more complex event object. For an example, see DeathKillEventLister.

Definition at line 59 of file EventLister.h.

#include <EventLister.h>

Classes

struct  TimeEventPair
 

Public Member Functions

CConsole & getConsole () const
 
 EventLister (const unsigned int &nEventTimeLimitSecs, const size_t &nEventCountLimit, const Orientation &eOrientation=Orientation::Vertical)
 
const unsigned int & getEventTimeLimitSecs () const
 
const size_t & getEventCountLimit () const
 
const Orientation & getOrientation () const
 
void show ()
 
void hide ()
 
bool visible () const
 
void update ()
 
void addEvent (TEvent &&evt)
 
void clear ()
 
pfl::FixFIFO< TimeEventPair > & getEvents ()
 
const pfl::FixFIFO< TimeEventPair > & getEvents () const
 

Static Public Member Functions

static const char * getLoggerModuleName ()
 

Protected Member Functions

 EventLister (const EventLister &)=delete
 
EventLister & operator= (const EventLister &)=delete
 
 EventLister (EventLister &&)=delete
 
EventLister & operator= (EventLister &&)=delete
 

Private Attributes

bool m_bVisible = false
 
pfl::FixFIFO< TimeEventPair > m_qEvents
 
unsigned int m_nEventTimeLimitSecs
 
Orientation m_eOrientation
 

Constructor & Destructor Documentation

◆ EventLister() [1/3]

template<class TEvent = Event>
proofps_dd::EventLister< TEvent >::EventLister ( const unsigned int & nEventTimeLimitSecs,
const size_t & nEventCountLimit,
const Orientation & eOrientation = Orientation::Vertical )
inline

Definition at line 107 of file EventLister.h.

◆ EventLister() [2/3]

template<class TEvent = Event>
proofps_dd::EventLister< TEvent >::EventLister ( const EventLister< TEvent > & )
protecteddelete

◆ EventLister() [3/3]

template<class TEvent = Event>
proofps_dd::EventLister< TEvent >::EventLister ( EventLister< TEvent > && )
protecteddelete

Member Function Documentation

◆ addEvent()

template<class TEvent = Event>
void proofps_dd::EventLister< TEvent >::addEvent ( TEvent && evt)
inline

Definition at line 162 of file EventLister.h.

◆ clear()

template<class TEvent = Event>
void proofps_dd::EventLister< TEvent >::clear ( )
inline

Definition at line 168 of file EventLister.h.

◆ getConsole()

template<class TEvent = Event>
CConsole & proofps_dd::EventLister< TEvent >::getConsole ( ) const
inline

Definition at line 102 of file EventLister.h.

◆ getEventCountLimit()

template<class TEvent = Event>
const size_t & proofps_dd::EventLister< TEvent >::getEventCountLimit ( ) const
inline

Definition at line 121 of file EventLister.h.

◆ getEvents() [1/2]

template<class TEvent = Event>
pfl::FixFIFO< TimeEventPair > & proofps_dd::EventLister< TEvent >::getEvents ( )
inline

Definition at line 174 of file EventLister.h.

◆ getEvents() [2/2]

template<class TEvent = Event>
const pfl::FixFIFO< TimeEventPair > & proofps_dd::EventLister< TEvent >::getEvents ( ) const
inline

Definition at line 179 of file EventLister.h.

◆ getEventTimeLimitSecs()

template<class TEvent = Event>
const unsigned int & proofps_dd::EventLister< TEvent >::getEventTimeLimitSecs ( ) const
inline

Definition at line 116 of file EventLister.h.

◆ getLoggerModuleName()

template<class TEvent = Event>
static const char * proofps_dd::EventLister< TEvent >::getLoggerModuleName ( )
inlinestatic

Definition at line 95 of file EventLister.h.

◆ getOrientation()

template<class TEvent = Event>
const Orientation & proofps_dd::EventLister< TEvent >::getOrientation ( ) const
inline

Definition at line 126 of file EventLister.h.

◆ hide()

template<class TEvent = Event>
void proofps_dd::EventLister< TEvent >::hide ( )
inline

Definition at line 136 of file EventLister.h.

◆ operator=() [1/2]

template<class TEvent = Event>
EventLister & proofps_dd::EventLister< TEvent >::operator= ( const EventLister< TEvent > & )
protecteddelete

◆ operator=() [2/2]

template<class TEvent = Event>
EventLister & proofps_dd::EventLister< TEvent >::operator= ( EventLister< TEvent > && )
protecteddelete

◆ show()

template<class TEvent = Event>
void proofps_dd::EventLister< TEvent >::show ( )
inline

Definition at line 131 of file EventLister.h.

◆ update()

template<class TEvent = Event>
void proofps_dd::EventLister< TEvent >::update ( )
inline

Definition at line 146 of file EventLister.h.

◆ visible()

template<class TEvent = Event>
bool proofps_dd::EventLister< TEvent >::visible ( ) const
inline

Definition at line 141 of file EventLister.h.

Member Data Documentation

◆ m_bVisible

template<class TEvent = Event>
bool proofps_dd::EventLister< TEvent >::m_bVisible = false
private

Definition at line 193 of file EventLister.h.

◆ m_eOrientation

template<class TEvent = Event>
Orientation proofps_dd::EventLister< TEvent >::m_eOrientation
private

Definition at line 196 of file EventLister.h.

◆ m_nEventTimeLimitSecs

template<class TEvent = Event>
unsigned int proofps_dd::EventLister< TEvent >::m_nEventTimeLimitSecs
private

Definition at line 195 of file EventLister.h.

◆ m_qEvents

template<class TEvent = Event>
pfl::FixFIFO<TimeEventPair> proofps_dd::EventLister< TEvent >::m_qEvents
private

Definition at line 194 of file EventLister.h.

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