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

Monitor::Utility::Callback Class Template Reference

Callback specialised to a non const function of an instance of target class. More...

#include <callback.h>

Inheritance diagram for Monitor::Utility::Callback:

Monitor::Utility::ClassCallback Monitor::Utility::CallbackBase Monitor::Utility::ConstCallback Monitor::Utility::DataCallback Monitor::Utility::InfoCallback List of all members.

Public Types

typedef void(TargetClass::* CallbackType )()
 Type of target class method to be invoked by callback. More...


Public Methods

 Callback (TargetClass &newTargetObject, CallbackType newTargetFunction)
 Constructor. More...

 Callback (const Callback &other)
 Copy Constructor. More...

virtual ~Callback ()
 Destructor. More...

virtual CallbackBaseclone () const
 Produce a copy of callback. More...

int operator== (const Callback &other) const
 Equivalence operator. More...

virtual int isEqual (const CallbackBase &other) const
 Override of generic equivalence test. More...

virtual void invoke (const void *) const
 Invoke callback. More...

virtual int set () const
 Test if callback is set, that is can it be invoked. More...


Protected Attributes

CallbackType targetFunction

Detailed Description

template<class TargetClass>
class Monitor::Utility::Callback< TargetClass >

Callback specialised to a non const function of an instance of target class.

Definition at line 277 of file callback.h.


Member Typedef Documentation

template<class TargetClass>
typedef void(TargetClass::* Monitor::Utility::Callback::CallbackType)()
 

Type of target class method to be invoked by callback.

Reimplemented in Monitor::Utility::ConstCallback.

Definition at line 283 of file callback.h.

Referenced by Monitor::Utility::Callback< const >::Callback.


Constructor & Destructor Documentation

template<class TargetClass>
Monitor::Utility::Callback< TargetClass >::Callback TargetClass &    newTargetObject,
CallbackType    newTargetFunction
[inline]
 

Constructor.

Definition at line 289 of file callback.h.

Referenced by Monitor::Utility::Callback< const >::Callback, Monitor::Utility::Callback< const >::clone, Monitor::Utility::ConstCallback::ConstCallback, Monitor::Utility::DataCallback< const TargetClass, TargetData >::DataCallback, Monitor::Utility::InfoCallback::InfoCallback, and Monitor::Utility::Callback< const >::operator==.

template<class TargetClass>
Monitor::Utility::Callback< TargetClass >::Callback const Callback< TargetClass > &    other [inline]
 

Copy Constructor.

Definition at line 299 of file callback.h.

template<class TargetClass>
virtual Monitor::Utility::Callback< TargetClass >::~Callback   [inline, virtual]
 

Destructor.

Definition at line 308 of file callback.h.


Member Function Documentation

template<class TargetClass>
virtual CallbackBase* Monitor::Utility::Callback< TargetClass >::clone   const [inline, virtual]
 

Produce a copy of callback.

Returns:
Pointer to new instance.

Implements Monitor::Utility::CallbackBase.

Reimplemented in Monitor::Utility::ConstCallback.

Definition at line 316 of file callback.h.

template<class TargetClass>
virtual void Monitor::Utility::Callback< TargetClass >::invoke const void *    const [inline, virtual]
 

Invoke callback.

Implements Monitor::Utility::CallbackBase.

Reimplemented in Monitor::Utility::ConstCallback.

Definition at line 346 of file callback.h.

template<class TargetClass>
virtual int Monitor::Utility::Callback< TargetClass >::isEqual const CallbackBase   other const [inline, virtual]
 

Override of generic equivalence test.

Parameters:
other  Instance to test for equivalence with.

Reimplemented from Monitor::Utility::CallbackBase.

Reimplemented in Monitor::Utility::DataCallback.

Definition at line 336 of file callback.h.

template<class TargetClass>
int Monitor::Utility::Callback< TargetClass >::operator== const Callback< TargetClass > &    other const [inline]
 

Equivalence operator.

Parameters:
other  Instance to test for equivalence with.

Definition at line 324 of file callback.h.

template<class TargetClass>
virtual int Monitor::Utility::Callback< TargetClass >::set   const [inline, virtual]
 

Test if callback is set, that is can it be invoked.

Returns:
!0 if set and can be invoked, otherwise 0.

Implements Monitor::Utility::CallbackBase.

Definition at line 354 of file callback.h.


Member Data Documentation

template<class TargetClass>
CallbackType Monitor::Utility::Callback::targetFunction [protected]
 

Definition at line 357 of file callback.h.

Referenced by Monitor::Utility::Callback< const >::Callback, Monitor::Utility::Callback< const >::invoke, Monitor::Utility::Callback< const >::operator==, and Monitor::Utility::Callback< const >::set.


Generated on Wed Oct 29 21:30:12 2003 for Utility C++ by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002