message_mediator.h

00001 
00002 /***************************************************************************
00003  *  message_mediator.h - Fawkes BlackBoard Message Mediator
00004  *
00005  *  Created: Sun Oct 29 17:58:19 2006
00006  *  Copyright  2006-2009  Tim Niemueller [www.niemueller.de]
00007  *
00008  ****************************************************************************/
00009 
00010 /*  This program is free software; you can redistribute it and/or modify
00011  *  it under the terms of the GNU General Public License as published by
00012  *  the Free Software Foundation; either version 2 of the License, or
00013  *  (at your option) any later version. A runtime exception applies to
00014  *  this software (see LICENSE.GPL_WRE file mentioned below for details).
00015  *
00016  *  This program is distributed in the hope that it will be useful,
00017  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  *  GNU Library General Public License for more details.
00020  *
00021  *  Read the full text in the LICENSE.GPL_WRE file in the doc directory.
00022  */
00023 
00024 #ifndef __MESSAGE_MEDIATOR_H_
00025 #define __MESSAGE_MEDIATOR_H_
00026 
00027 namespace fawkes {
00028 
00029 class Interface;
00030 class Message;
00031 
00032 /** Message mediator interface.
00033  * The message mediator is used by an interface to communicate messages to the
00034  * BlackBoard for dispatching.
00035  * @author Tim Niemueller
00036  */
00037 class MessageMediator
00038 {
00039  public:
00040   /** Virtual destructor */
00041   virtual ~MessageMediator() {}
00042 
00043   /** Transmit message.
00044    * The mediator may modify the message ID of the message.
00045    * @param message message to transmit.
00046    * @exception BlackBoardNoWritingInstanceException thrown if there is no writing
00047    *instance for the transmitting interface
00048    */
00049   virtual void transmit(Message *message)                        = 0;
00050 
00051 };
00052 
00053 } // end namespace fawkes
00054 
00055 #endif