Tools/Module/ModuleHandler.h

Go to the documentation of this file.

/**
* @file ModuleHandler.h
*
* Declaration of class ModuleHandler
*
* @author Max Risler
* @author Martin Lötzsch
*/

#ifndef __ModuleHandler_h_
#define __ModuleHandler_h_

#include "ModuleSelector.h"

/**
* @class ModuleHandler
* 
* Manages runtime exhangeable modules.
* 
* @author Max Risler
* @author Martin Lötzsch
*/
class ModuleHandler : public MessageHandler
{
private: 
  /** Pointers to all module selectors */
  ModuleSelector *pModuleSelectors[SolutionRequest::numOfModules];

public:
  /** Constructor */
  ModuleHandler();
  
  /**
  * Returns pointer to selector module.
  * @param id id of module.
  */
  ModuleSelector *pGetModuleSelector(SolutionRequest::ModuleID id) const;
  
  /**
  * Set pointer to selector module.
  * @param id id of module.
  * @param module a pointer to the module selector
  */
  void setModuleSelector(SolutionRequest::ModuleID id, 
    ModuleSelector* module);
  
  /** Returns the id of the selected solution for a module id */
  SolutionRequest::ModuleSolutionID getSelectedSolution(SolutionRequest::ModuleID id) const;
  
  /** Selects solution defined by solution in module id */
  void selectSolution(SolutionRequest::ModuleID id, SolutionRequest::ModuleSolutionID solution);
  
  /** Selects solutions as defined by a solution request */
  void selectSolutions(SolutionRequest request);
  
  /** 
  * Called from a MessageQueue to distribute messages.
  * Use message.getMessageID to decide if the message is relavant for 
  * the MesssageHandler derivate.
  * Use message.bin, message.text or message.config as In streams to get the data from.
  * @param message The message that can be read.
  * @return true if the message was read (handled).
  */
  virtual bool handleMessage(InMessage& message);
};


#endif //__ModuleHandler_h_

---