itpp::Data_Event< ObjectType, DataType > Class Template Reference

An Event class that executes a function with some data as input when the event expires. More...

#include <itpp/protocol/events.h>

Inheritance diagram for itpp::Data_Event< ObjectType, DataType >:

List of all members.

Public Member Functions
	Data_Event (ObjectType *object_pointer, void(ObjectType::*object_function_pointer)(DataType data), DataType data, const Ttype delta_time)
	Construct an Event to expire delta_time from now by calling the function (*object_pointer.*object_function_pointer)(data).
virtual	~Data_Event ()
	Destructor.
virtual void	exec (void)
	Execute (call) the assigned function with user data.
void	cancel ()
	Cancel an event.
Protected Attributes
Ttype	delta_t
Ttype	expire_t
bool	active
unsigned long long int	id
Static Protected Attributes
unsigned long long int	global_id = 0
Friends
class	Base_Signal
class	Event_Queue
struct	Compare_Base_Event_Times

---

Detailed Description

template<class ObjectType, class DataType>
class itpp::Data_Event< ObjectType, DataType >

An Event class that executes a function with some data as input when the event expires.

Since Events are objects you need supply both a pointer to the object and the function pointer to create the Event

Definition at line 169 of file events.h.

---

Constructor & Destructor Documentation

template<class ObjectType, class DataType> itpp::Data_Event< ObjectType, DataType >::Data_Event (  ObjectType *  object_pointer, void(ObjectType::*)(DataType data)  object_function_pointer, DataType  data, const Ttype  delta_time )  [inline]

Construct an Event to expire delta_time from now by calling the function (*object_pointer.*object_function_pointer)(data). Definition at line 172 of file events.h.

template<class ObjectType, class DataType> virtual itpp::Data_Event< ObjectType, DataType >::~Data_Event (   )  [inline, virtual]

Destructor. Definition at line 181 of file events.h.

---

Member Function Documentation

template<class ObjectType, class DataType> virtual void itpp::Data_Event< ObjectType, DataType >::exec (  void   )  [inline, virtual]

Execute (call) the assigned function with user data. Implements itpp::Base_Event. Definition at line 184 of file events.h.

void itpp::Base_Event::cancel (   )  [inline, inherited]

Cancel an event. Definition at line 78 of file events.h. Referenced by itpp::Signal< DataType >::cancel().

---

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

• itpp/protocol/events.h

Generated on Fri Jan 11 08:17:32 2008 for IT++ by Doxygen 1.3.9.1