SigSlot::Slot Class Reference

#include <Slot.hxx>

Inheritance diagram for SigSlot::Slot:

SigSlot::Slotv0 SigSlot::Slotv1< ParmType1 > SigSlot::Slotv2< ParmType1, ParmType2 > SigSlot::Slotv3< ParmType1, ParmType2, ParmType3 > SigSlot::Slotv4< ParmType1, ParmType2, ParmType3, ParmType4 > List of all members.

Detailed Description

The receiver of a Signal.

If the Signal represents the concept of Event Notifying, the Slot represents the 'Event handler'

See also:
Signal

Definition at line 39 of file Slot.hxx.

Public Member Functions

void Bind (const Connection &conn)
 Binds the Slot with a Signal.
void Unbind ()
 Disconnects the Slot.
void Unbind (Connection::tConnectionId conn)
 Disconnects the Slot.
unsigned ActiveConnections () const
 Tells how many signals are connected.
 ~Slot ()
 Destructor.


Constructor & Destructor Documentation

SigSlot::Slot::~Slot (  ) 

Destructor.

Destructor method.

Definition at line 47 of file Slot.cxx.

References Unbind().


Member Function Documentation

void SigSlot::Slot::Bind ( const Connection conn  ) 

Binds the Slot with a Signal.

This method keeps the Slot bound to a given Signal ( identified by a Connection ).

Parameters:
conn The connection to establish

Definition at line 57 of file Slot.cxx.

Referenced by SigSlot::Signalv4< ParmType1, ParmType2, ParmType3, ParmType4 >::Connect(), SigSlot::Signalv3< ParmType1, ParmType2, ParmType3 >::Connect(), SigSlot::Signalv2< ParmType1, ParmType2 >::Connect(), SigSlot::Signalv1< ParmType1 >::Connect(), and SigSlot::Signalv0::Connect().

void SigSlot::Slot::Unbind (  ) 

Disconnects the Slot.

Calling this method severs all the existing connections between the present slot and any signal.

Definition at line 52 of file Slot.cxx.

Referenced by ~Slot().

void SigSlot::Slot::Unbind ( Connection::tConnectionId  conn  ) 

Disconnects the Slot.

Calling this method severs the connection between the Slot and the Signal identified by the connection Id number.

Parameters:
conn The connection to be severed.

Definition at line 62 of file Slot.cxx.

unsigned SigSlot::Slot::ActiveConnections (  )  const [inline]

Tells how many signals are connected.

This method tells the client how many connections are already established with Signals for the present Slot.

Returns:
The number of Signals connected to the Slot

Definition at line 76 of file Slot.hxx.


The documentation for this class was generated from the following files:
Generated on Tue Jun 19 20:35:09 2007 for CLAM-Development by  doxygen 1.5.2