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

corelinux::Colleague Class Reference

Colleague knows its Mediator object, communicates with its mediator whenever it would have otherwise communicated with another Colleague. More...

#include <Colleague.hpp>

Inheritance diagram for corelinux::Colleague

Inheritance graph
[legend]
List of all members.

Public Methods

 Colleague ( MediatorPtr ) throw ( NullPointerException )
 Default constructor requires a Mediator. More...

 Colleague ( ColleagueCref )
 Copy constructor copies the mediator reference. More...

virtual ~Colleague ( void )
 Virtual destructor.

ColleagueRef operator= ( ColleagueCref )
 Assignment operator.

bool operator== ( ColleagueCref ) const
 Equality operator.

virtual void getEventsGenerated ( EventIdentifiersRef ) = 0
 Implementation defined to return the identifiers of the events that this Colleague generates. More...

virtual void getInterestedEvents ( EventIdentifiersRef ) = 0
 Implementation defined to return the identifiers of the events that this Colleague is interested in. More...

virtual void action ( Event<Identifier> * ) = 0
 Called by the mediator when another Colleague has generated an event that this colleague instance is interested in. More...


Protected Methods

 Colleague ( void ) throw ( Assertion )
 Default constructor not allowed.

virtual void invokeMediator ( Event<Identifier> * ) throw ( NullPointerException )
 Called by the Colleague implementation to have the Mediator::action called with the event type. More...


Detailed Description

Colleague knows its Mediator object, communicates with its mediator whenever it would have otherwise communicated with another Colleague.


Constructor & Destructor Documentation

corelinux::Colleague::Colleague ( MediatorPtr aMediator ) throw ( NullPointerException )
 

Default constructor requires a Mediator.

Parameters:
Mediator   pointer
Exceptions:
NullPointerException   if MediatorPtr is NULLPTR

corelinux::Colleague::Colleague ( ColleagueCref aColleague )
 

Copy constructor copies the mediator reference.

Parameters:
Colleague   const referencee


Member Function Documentation

void corelinux::Colleague::action ( Event< Identifier >* aEvent ) [pure virtual]
 

Called by the mediator when another Colleague has generated an event that this colleague instance is interested in.

Parameters:
Event   pointer to event

Reimplemented in EditColleague, ListColleague, and SelectColleague.

void corelinux::Colleague::getEventsGenerated ( EventIdentifiersRef aVector ) [pure virtual]
 

Implementation defined to return the identifiers of the events that this Colleague generates.

Parameters:
EventIdentifiers   vector reference

Reimplemented in EditColleague, ListColleague, and SelectColleague.

void corelinux::Colleague::getInterestedEvents ( EventIdentifiersRef aVector ) [pure virtual]
 

Implementation defined to return the identifiers of the events that this Colleague is interested in.

Parameters:
EventIdentifiers   vector reference

Reimplemented in EditColleague, ListColleague, and SelectColleague.

void corelinux::Colleague::invokeMediator ( Event< Identifier >* anEvent ) throw ( NullPointerException ) [protected, virtual]
 

Called by the Colleague implementation to have the Mediator::action called with the event type.

Parameters:
Event   pointer to event
Exceptions:
NullPointerException   if EventPtr is NULLPTR


The documentation for this class was generated from the following files:
This is the CoreLinux++ reference manual
Provided by The CoreLinux Consortium