itasca::Signal2< Param1, Param2 > Class Template Reference

Definition of a Signal2 object, holding a list of ISlot2 objects. More...

#include <signal2.h>

Inheritance diagram for itasca::Signal2< Param1, Param2 >:

Public Types
typedef ISlot2< Param1, Param2 >	SlotType
	Define SlotType as an ISlot2 object with template arguments Param1 and Param2.

Public Member Functions
	Signal2 ()
	Default constructor - no values are set.
	Signal2 (const Signal2 &)=delete
	Signal2 (Signal2 &&)=delete
void	operator= (const Signal2 &)=delete
void	operator= (Signal2 &&)=delete
virtual	~Signal2 ()
virtual void	execute (Param1, Param2)
virtual void	attach (SlotType *, const QString &)
bool	remove (ISlotBase *slot, const QString &name=QString())
virtual void	attachNotice (ISignalBase *signal)
virtual void	removeNotice (ISignalBase *signal)
template<class T , void(T::*)(Param1, Param2) MFP>
void	attachMethod2 (T *t)
template<class T , void(T::*)(Param1) MFP>
void	attachMethod1 (T *t)
template<class T , void(T::*)() MFP>
void	attachMethod0 (T *t)
template<class T , void(T::*)(Param1, Param2) MFP>
void	removeMethod2 (T *t)
template<class T , void(T::*)(Param1) MFP>
void	removeMethod1 (T *t)
template<class T , void(T::*)() MFP>
void	removeMethod0 (T *t)
void	attachSignal (Signal2< Param1, Param2 > *sig)
void	removeSignal (Signal2< Param1, Param2 > *sig)

Detailed Description

template<class Param1, class Param2>
class itasca::Signal2< Param1, Param2 >

Definition of a Signal2 object, holding a list of ISlot2 objects.

This is part of a custom, small-granularity callback utility whose purpose is to mimic the Qt signal/slot paradigm without the overhead. A Signal2 object holds a list of ISlot2 objects. Signal2 is derived from ISlotBase so that a Signal2 can be chained or attached to another Signal2 (see attachSignal() and removeSignal()). The attached methods are invoked with execute(). Internally Slots are created via the AutoSlot0, AutoSlot1 and AutoSlot2 template classes. These classes correspond to methods taking 0, 1 or 2 arguments. Thus it is possible to attach a method taking either 0, 1 or 2 arguments to a Signal2 object. This is accomplished by the attachMethod0(), attachMethod1() and attachMethod2() functions, respectively. There are matching removeMethod0(), removeMethod1() and removeMethod2() functions as well. The attach() and remove() methods require ISlot2 arguments. The syntax for attaching a method inside the class where the method is defined (Note: the class must be derived from Slot) is

signal2->attachMethod2<Fred,&Fred::func>(this); 

where signal2 is the Signal2 object and Fred is the class (derived from Slot) where the member function func resides. Also the attach method can be used:

signal2->attach<Fred,&Fred::func>(&fred); 

where fred is a particular instance of the class Fred. The remove sytax is similar:

signal2->remove(&fred,&Fred::func); 

Constructor & Destructor Documentation

~Signal2()

template<class Param1 , class Param2 >

itasca::Signal2< Param1, Param2 >::~Signal2 ( )

virtual

Virtual destructor. Upon destruction, all Signal2 objects and SlotType objects attached to this Signal2 are removed.

Member Function Documentation

attach()

template<class Param1 , class Param2 >

void itasca::Signal2< Param1, Param2 >::attach ( SlotType *  slot, const QString &  name  )

virtual

Attach the SlotType object to this Signal2 object. SlotType is now owned by this Signal2 object, and will be deleted when the Signal2 object is destroyed. The SlotType object is identified by a QString that can be used for removal.

Parameters

slot	Pointer to a SlotType object to be attached.
name	Reference to a QString used to identify the SlotType for removal.

attachMethod0()

template<class Param1 , class Param2 >

template<class T , void(T::*)() MFP>

void itasca::Signal2< Param1, Param2 >::attachMethod0 ( T *  t )

inline

Uses the AutoSlot0 template class to attach the method MFP of the instance t of class T which takes no arguments. Warning - attempting to do this to a function that is overloaded will cause a compiler error in VS2005.

Parameters

t	Pointer to the instance of T that has the method MFP.

attachMethod1()

template<class Param1 , class Param2 >

template<class T , void(T::*)(Param1) MFP>

void itasca::Signal2< Param1, Param2 >::attachMethod1 ( T *  t )

inline

Uses the AutoSlot1 template class to attach the method MFP of the instance t of class T which takes one argument. Warning - attempting to do this to a function that is overloaded will cause a compiler error in VS2005.

Parameters

t	Pointer to the instance of T that has the method MFP.

attachMethod2()

template<class Param1 , class Param2 >

template<class T , void(T::*)(Param1, Param2) MFP>

void itasca::Signal2< Param1, Param2 >::attachMethod2 ( T *  t )

inline

Uses the AutoSlot2 template class to attach the method MFP of the instance t of class T which takes two arguments. Warning - attempting to do this to a function that is overloaded will cause a compiler error in VS2005.

Parameters

t	Pointer to the instance of T that has the method MFP.

attachNotice()

template<class Param1 , class Param2 >

void itasca::Signal2< Param1, Param2 >::attachNotice ( ISignalBase *  signal )

virtual

Used to signal that an ISignalBase object is to be attached to this Signal2.

Parameters

signal

ISignalBase pointer that is attached.

Implements itasca::ISlotBase.

attachSignal()

template<class Param1 , class Param2 >

void itasca::Signal2< Param1, Param2 >::attachSignal ( Signal2< Param1, Param2 > *  sig )

inline

The Signal2 sig with the same two arguments is attached to this Signal2 object, resulting in chained signals (e.g., when the methods in this Signal2 object are executed, the methods in all attached Signal2 objects are also executed with the same arguments).

Parameters

sig	Signal2 to be attached to this Signal2 object.

execute()

template<class Param1 , class Param2 >

void itasca::Signal2< Param1, Param2 >::execute ( Param1  v1, Param2  v2  )

virtual

Invokes execute() on all attached Signal2 and SlotType objects. Depending on the method, either 0, 1 or 2 arguments are passed to the method.

Parameters

v1	First parameter conveyed to the attached method.
v2	Second parameter conveyed to the attached method.

remove()

template<class Param1 , class Param2 >

bool itasca::Signal2< Param1, Param2 >::remove ( ISlotBase *  slot, const QString &  name = QString()  )

virtual

Remove the SlotType slot from this Signal2 object. The defualt null QString name is used for removal. If name is null then all SlotType objects with matching base are removed. If slot is null then all SlotType objects with matching base are removed. If both are null then all SlotTypes are removed.

Parameters

slot	Pointer to a SlotType object to be removed.
name	Default null QString name of the SlotType to remove.

Implements itasca::ISignalBase.

removeMethod0()

template<class Param1 , class Param2 >

template<class T , void(T::*)() MFP>

void itasca::Signal2< Param1, Param2 >::removeMethod0 ( T *  t )

inline

Removes the method MFP of the instance t of class T taking no argument by creating a temporary AutoSlot0 object and removing it.

Parameters

t	Pointer to the instance of T that has the method MFP.

removeMethod1()

template<class Param1 , class Param2 >

template<class T , void(T::*)(Param1) MFP>

void itasca::Signal2< Param1, Param2 >::removeMethod1 ( T *  t )

inline

Removes the method MFP of the instance t of class T taking 1 argument by creating a temporary AutoSlot1 object and removing it.

Parameters

t	Pointer to the instance of T that has the method MFP.

removeMethod2()

template<class Param1 , class Param2 >

template<class T , void(T::*)(Param1, Param2) MFP>

void itasca::Signal2< Param1, Param2 >::removeMethod2 ( T *  t )

inline

Removes the method MFP of the instance t of class T taking 2 arguments by creating a temporary AutoSlot2 object and removing it.

Parameters

t	Pointer to the instance of T that has the method MFP.

removeNotice()

template<class Param1 , class Param2 >

void itasca::Signal2< Param1, Param2 >::removeNotice ( ISignalBase *  signal )

virtual

Used to signal that an ISignalBase object is to be removed from this Signal2.

Parameters

signal

ISignalBase pointer that is removed.

Implements itasca::ISlotBase.

removeSignal()

template<class Param1 , class Param2 >

void itasca::Signal2< Param1, Param2 >::removeSignal ( Signal2< Param1, Param2 > *  sig )

inline

The Signal2 sig that has previously been attached is removed from this Signal2 object.

Parameters

sig	Signal2 to be removed from this Signal2 object.

---

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

• C:/Source/itasca-suite/common/utility/interface/isignalbase.h
• C:/Source/itasca-suite/common/utility/interface/signal2.h