EventSender< TParamType > Class Template Reference

use EventSender::SendEvent to send events. More...

#include <events.h>

Inherits EventReceiverFuncBase< TParamType >.

Collaboration diagram for EventSender< TParamType >:

[legend]

Public Member Functions
	EventSender ()
void	OnEvent (TParamType)
void	SendEvent (TParamType param)
void	Enable (bool enable=true)
void	ConnectNextTo (ListNodeBare *a)
void	ConnectPrevTo (ListNodeBare *a)
void	StepNext ()
void	StepPrev ()
void	SanityCheck ()
void	Disconnect ()
Data Fields
ListNodeBare *	prev
ListNodeBare *	next
Protected Attributes
bool	m_enabled

---

Detailed Description

template<class TParamType>
class EventSender< TParamType >

use EventSender::SendEvent to send events.

Definition at line 113 of file events.h.

---

Constructor & Destructor Documentation

template<class TParamType >

EventSender< TParamType >::EventSender

(

)

[inline]

Definition at line 115 of file events.h.

---

Member Function Documentation

void ListNodeBare::ConnectNextTo

(

ListNodeBare *

a

)

[inline, inherited]

connecting next to itself is equivalent to disconnect.

Definition at line 19 of file events.h.

void ListNodeBare::ConnectPrevTo

(

ListNodeBare *

a

)

[inline, inherited]

connecting prev to itself is equivalent to disconnect.

Definition at line 26 of file events.h.

void ListNodeBare::Disconnect

(

)

[inline, inherited]

Definition at line 63 of file events.h.

template<class TParamType >

void EventSender< TParamType >::Enable

(

bool

enable = true

)

[inline]

Definition at line 140 of file events.h.

template<class TParamType >

void EventSender< TParamType >::OnEvent

(

TParamType

)

[inline, virtual]

you may want to put assert(0) here, or log a message. This method is only called when you have multiple senders sharing same event list. Which happens when you unnecessarily make a copy of sender.

Reimplemented from EventReceiverFuncBase< TParamType >.

Definition at line 119 of file events.h.

void ListNodeBare::SanityCheck

(

)

[inline, inherited]

Definition at line 56 of file events.h.

template<class TParamType >

void EventSender< TParamType >::SendEvent

(

TParamType

param

)

[inline]

Definition at line 124 of file events.h.

void ListNodeBare::StepNext

(

)

[inline, inherited]

moves itself forward in the ring

disconnect itself

reconnect itself after next

Definition at line 33 of file events.h.

void ListNodeBare::StepPrev

(

)

[inline, inherited]

moves itself backward in the ring

disconnect itself

reconnect itself before prev

Definition at line 44 of file events.h.

---

Field Documentation

template<class TParamType >

bool EventSender< TParamType >::m_enabled [protected]

Definition at line 146 of file events.h.

ListNodeBare* ListNodeBare::next [inherited]

Definition at line 18 of file events.h.

ListNodeBare* ListNodeBare::prev [inherited]

Definition at line 17 of file events.h.

---

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

• /home/buildbot/slaves/docs/docs/build/src/utils/events.h