IEventOwner Class Reference
[EventTimer event handling]

Any class that wants to use timer events inherits this. More...

#include <IEventOwner.h>

Collaboration diagram for IEventOwner:

[legend]

List of all members.

Public Member Functions
	IEventOwner (IEventHandler &h)
virtual	~IEventOwner ()
long	AddEvent (long sec, long usec)
	Schedule event.
void	ClearEvents ()
	Clear all events scheduled by this owner.
void	RemoveEvent (long eid)
	Remove one event scheduled by this owner.
virtual void	OnEvent (int)=0
	Event callback will fire when time is up.
IEventHandler &	GetEventHandler ()
void	SetHandlerInvalid (bool x=true)
Private Attributes
IEventHandler &	m_event_handler
bool	m_handler_invalid

---

Detailed Description

Any class that wants to use timer events inherits this.

Definition at line 45 of file IEventOwner.h.

---

Constructor & Destructor Documentation

IEventOwner::IEventOwner

(

IEventHandler &

h

)

Definition at line 40 of file IEventOwner.cpp.

                                         : m_event_handler(h), m_handler_invalid(false)
{
}

IEventOwner::~IEventOwner

(

)

[virtual]

Definition at line 45 of file IEventOwner.cpp.

References IEventHandler::ClearEvents(), m_event_handler, and m_handler_invalid.

{
        if (!m_handler_invalid)
        {
                m_event_handler.ClearEvents(this);
        }
}

---

Member Function Documentation

long IEventOwner::AddEvent	(	long	sec,
		long	usec
	)

Schedule event.

Parameters:

	sec	Seconds until event
	usec	Microseconds until event

Returns:

Event ID

Definition at line 60 of file IEventOwner.cpp.

References IEventHandler::AddEvent(), and m_event_handler.

{
        return m_event_handler.AddEvent(this, sec, usec);
}

void IEventOwner::ClearEvents

(

)

Clear all events scheduled by this owner.

Definition at line 66 of file IEventOwner.cpp.

References IEventHandler::ClearEvents(), and m_event_handler.

{
        m_event_handler.ClearEvents(this);
}

void IEventOwner::RemoveEvent

(

long

eid

)

Remove one event scheduled by this owner.

Parameters:

eid

Event ID to remove

Definition at line 72 of file IEventOwner.cpp.

References m_event_handler, and IEventHandler::RemoveEvent().

{
        m_event_handler.RemoveEvent(this, eid);
}

virtual void IEventOwner::OnEvent

(

int

)

[pure virtual]

Event callback will fire when time is up.

IEventHandler & IEventOwner::GetEventHandler

(

)

Definition at line 54 of file IEventOwner.cpp.

References m_event_handler.

{
        return m_event_handler;
}

void IEventOwner::SetHandlerInvalid

(

bool

x = true

)

[inline]

Definition at line 65 of file IEventOwner.h.

{ m_handler_invalid = x; }

---

Member Data Documentation

IEventHandler& IEventOwner::m_event_handler [private]

Definition at line 68 of file IEventOwner.h.

Referenced by AddEvent(), ClearEvents(), GetEventHandler(), RemoveEvent(), and ~IEventOwner().

bool IEventOwner::m_handler_invalid [private]

Definition at line 69 of file IEventOwner.h.

Referenced by ~IEventOwner().

---

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

• IEventOwner.h
• IEventOwner.cpp