Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_M_Listener Class Reference

Mix-in class to allow objects to listen for messages from CP_M_Broadcasters.

List of all members.

Public Member Functions

Constructor / Destructor
virtual ~CP_M_Listener ()
 Destructor.
Broadcasters
void AddBroadcaster (CP_M_Broadcaster *inBroadcaster)
void RemoveBroadcaster (CP_M_Broadcaster *inBroadcaster)
Listing
virtual void ListenForMessage (CP_Message &inMessage)=0
void StartListening ()
void StopListening ()
bool IsListening () const

Protected Member Functions

Constructor / Destructor
 CP_M_Listener ()

Protected Attributes

CP_BroadcastersfBroadcasters
bool fIsListening

Private Member Functions

Constructor / Destructor
 CP_M_Listener (const CP_M_Listener &)
operators
CP_M_Listeneroperator= (const CP_M_Listener &)


Constructor & Destructor Documentation

CP_M_Listener::~CP_M_Listener  )  [virtual]
 

Destructor.

CPLAT_Begin_Namespace_CPLAT CP_M_Listener::CP_M_Listener  )  [protected]
 

Constructor.

CP_M_Listener::CP_M_Listener const CP_M_Listener  )  [private]
 


Member Function Documentation

void CP_M_Listener::AddBroadcaster CP_M_Broadcaster inBroadcaster  ) 
 

Add a new CP_M_Broadcaster to our list of. If the object is already registered with us, then it is not added.

Parameters:
inBroadcaster The CP_M_Broadcaster object we are adding to our list.
Returns:
void

void CP_M_Listener::RemoveBroadcaster CP_M_Broadcaster inBroadcaster  ) 
 

Remove a CP_M_Broadcaster object from our list.

Parameters:
inBroadcaster The CP_M_Broadcaster object to remove from the list.
void

virtual void CP_M_Listener::ListenForMessage CP_Message inMessage  )  [pure virtual]
 

Virtual method that subclasses must override.

Parameters:
inMessage The message to listen for.
Exceptions:
none 
Returns:
void

void CP_M_Listener::StartListening  ) 
 

Turns off classes from receiving messages.

Exceptions:
none 
Returns:
void

void CP_M_Listener::StopListening  ) 
 

Turns on classes to receive messages.

Exceptions:
none 
Returns:
void

bool CP_M_Listener::IsListening  )  const
 

Returns the flag to indicate if we are currently listening for messages.

Exceptions:
none 
Returns:
bool Flag to indicate if we are listening for messages.

CP_M_Listener& CP_M_Listener::operator= const CP_M_Listener  )  [private]
 


Member Data Documentation

CP_Broadcasters* CP_M_Listener::fBroadcasters [protected]
 

bool CP_M_Listener::fIsListening [protected]
 

List of broadcasters for this listener.


The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:01:49 2005 for CPLAT by  doxygen 1.4.0