Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

Monitor::Utility::CallbackList Class Reference

List of callback instances accessed via generic base class interface. More...

#include <cllbklst.h>

List of all members.

Public Methods

 CallbackList ()
 Constructor. More...

virtual ~CallbackList ()
 Destructor. More...

const CallbackBaseaddCallback (const CallbackBase &newCallback)
 Add a new callback to the list. More...

void removeCallback (const CallbackBase &oldCallback)
 Remove a call back from the list. More...

void removeTarget (const void *target)
 Remove all callbacks with a given target object. More...

virtual void invoke (const void *invocationData=0)
 Invoke all callbacks in list. More...


Private Types

typedef TIListImp< CallbackBaseList
 Callback list type. More...

typedef TIListIteratorImp<
CallbackBase
ListIterator
 Callback list iterator type. More...


Private Attributes

ListmyList
 Callback list. More...


Detailed Description

List of callback instances accessed via generic base class interface.

Definition at line 52 of file cllbklst.h.


Member Typedef Documentation

typedef TIListImp< CallbackBase > Monitor::Utility::CallbackList::List [private]
 

Callback list type.

Definition at line 105 of file cllbklst.h.

typedef TIListIteratorImp< CallbackBase > Monitor::Utility::CallbackList::ListIterator [private]
 

Callback list iterator type.

Definition at line 109 of file cllbklst.h.

Referenced by invoke, removeCallback, and removeTarget.


Constructor & Destructor Documentation

CallbackList::CallbackList  
 

Constructor.

Definition at line 50 of file cllbklst.cpp.

References _USEMYTRACE_.

CallbackList::~CallbackList   [virtual]
 

Destructor.

Definition at line 59 of file cllbklst.cpp.

References _USEMYTRACE_, and myList.


Member Function Documentation

const CallbackBase & CallbackList::addCallback const CallbackBase   newCallback
 

Add a new callback to the list.

Parameters:
newCallback  Callback to add to list
Returns:
The callback added to the list.

Definition at line 74 of file cllbklst.cpp.

References _USEMYTRACE_, and myList.

void CallbackList::invoke const void *    invocationData = 0 [virtual]
 

Invoke all callbacks in list.

Parameters:
invocationData  Optional data to pass to callbacks.

Definition at line 139 of file cllbklst.cpp.

References _USEMYTRACE_, ListIterator, and myList.

void CallbackList::removeCallback const CallbackBase   oldCallback
 

Remove a call back from the list.

Parameters:
oldCallback  Callback to remove.

Definition at line 86 of file cllbklst.cpp.

References _USEMYTRACE_, ListIterator, and myList.

Referenced by removeTarget.

void CallbackList::removeTarget const void *    target
 

Remove all callbacks with a given target object.

Parameters:
target  Object for which callbacks are to be to removed.

Definition at line 112 of file cllbklst.cpp.

References _USEMYTRACE_, ListIterator, myList, and removeCallback.


Member Data Documentation

List* Monitor::Utility::CallbackList::myList [private]
 

Callback list.

Definition at line 114 of file cllbklst.h.

Referenced by addCallback, invoke, removeCallback, removeTarget, and ~CallbackList.


Generated on Wed Oct 29 20:51:59 2003 for Utility BC Common by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002