FREE::CallbackEventBase Class Reference
[Events]

Abstract event object in f.r.e.e., used for every kind of callback... More...

#include <freEvents.h>

Inheritance diagram for FREE::CallbackEventBase:

[legend]

List of all members.

Public Types
typedef bool(*	CallEvent )(CallbackType callbackID, CallbackFlagType flag, void *pData, void *pSender, long threadID)
typedef itk::SmartPointer < CallbackEventBase >	Pointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual bool	Execute (CallbackType callbackID, CallbackFlagType flag, void *pData, void *pSender, long threadID=0)
Static Public Member Functions
static Pointer	New (CallEvent pE)
Protected Member Functions
	CallbackEventBase (CallEvent pCE)
	CallbackEventBase ()
Private Attributes
CallEvent	m_CallEvent

---

Detailed Description

Abstract event object in f.r.e.e., used for every kind of callback...

CallbackEventBase is the generic event object within f.r.e.e. and used to realize callbacks to nonstatic member functions of f.r.e.e. objects. This Event is used for callback based data retrieval or other situations, where a part of f.r.e.e. should get the possibility to interact or make a request.

Definition at line 97 of file freEvents.h.

---

Member Typedef Documentation

typedef bool(* FREE::CallbackEventBase::CallEvent)(CallbackType callbackID, CallbackFlagType flag, void *pData, void *pSender, long threadID)

Reimplemented in FREE::CallbackEvent< T >.

Definition at line 100 of file freEvents.h.

typedef itk::SmartPointer<CallbackEventBase> FREE::CallbackEventBase::Pointer

Reimplemented in FREE::CallbackEvent< T >.

Definition at line 102 of file freEvents.h.

---

Constructor & Destructor Documentation

FREE::CallbackEventBase::CallbackEventBase

(

CallEvent

pCE

)

[protected]

Implementation of FREE::CallbackEventBase //////////////////////////

Definition at line 60 of file freEvents.cxx.

References m_CallEvent.

FREE::CallbackEventBase::CallbackEventBase

(

)

[protected]

Definition at line 66 of file freEvents.cxx.

References m_CallEvent.

---

Member Function Documentation

static Pointer FREE::CallbackEventBase::New

(

CallEvent

pE

)

[inline, static]

Definition at line 104 of file freEvents.h.

virtual const char* FREE::CallbackEventBase::GetNameOfClass

(

)

const [inline, virtual]

Reimplemented in FREE::CallbackEvent< T >.

Definition at line 105 of file freEvents.h.

bool FREE::CallbackEventBase::Execute	(	CallbackType	callbackID,
		CallbackFlagType	flag,
		void *	pData,
		void *	pSender,
		long	threadID = 0
	)			[virtual]

This Event is used for callback based data retrieval or other situations, where a part of f.r.e.e. should get the possibility to interact or make a request.

Parameters:

[in]	callbackID	Defines the callback type and so the meaning of flag and pData. Typical callbacks of f.r.e.e. are defined in freConstCallbackIDs.h, where the meaning of flag and pData are also explained.
[in]	flag	Possibility of an additional specification of the callback. Meaning depends on the callbackID.
[in]	pData	Void pointer to other data structures may be passed or wanted with the callback. Meaning and use depends on the callbackID.
[in]	pSender	Pointer to the object who called the event.
[in]	threadID	ID of the Thread executing the event. By default this value is 0. This ID is not unique over the complete system, it should only be assumed that it is unique in the context of the sender

Returns:

If return is true, pData is valid,

Reimplemented in FREE::CallbackEvent< T >.

Definition at line 73 of file freEvents.cxx.

References m_CallEvent.

---

Member Data Documentation

CallEvent FREE::CallbackEventBase::m_CallEvent [private]

Reimplemented in FREE::CallbackEvent< T >.

Definition at line 105 of file freEvents.h.

Referenced by CallbackEventBase(), and Execute().

---

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

• freEvents.h
• freEvents.cxx

---