Tools/Module/ModuleSelector.h

Go to the documentation of this file.

/**
* @file ModuleSelector.h
*
* Definition of class ModuleSelector.
*
* @author Max Risler
* @author Martin Lötzsch
*/

#ifndef __ModuleSelector_h_
#define __ModuleSelector_h_

#include "SolutionRequest.h"
#include "Module.h"

/**
* @class ModuleSelector
* 
* Base class for module selectors. Module selectors allow to switch between different
* solutions for a modules.
*
* @author Max Risler
* @author Martin Lötzsch
*/
class ModuleSelector : public MessageHandler
{
protected:
  /** The id of the selected solution */
  SolutionRequest::ModuleSolutionID selectedSolutionID;
  
public:
  /** 
  * Constructor 
  * @param id The id of the module. 
  */
  ModuleSelector(SolutionRequest::ModuleID id);
  
  /** Destructor */
  ~ModuleSelector();
  
  /** 
  * Is called on start and when the selected solution changes
  * to create a specific solution.
  * @param id The id of the solution to create
  * @return The created solution or 0
  */
  virtual Module* createSolution(SolutionRequest::ModuleSolutionID id) = 0;

  /** 
  * Creates the default solution.
  * This can not be done in the constructor, 
  * as the derived selector class is not created yet.
  */
  void init();

  /**
  * Selects a module.
  * @param id id of module to select
  */
  virtual void selectSolution(SolutionRequest::ModuleSolutionID id);
  
  /** Returns the index of the selected solution. */
  SolutionRequest::ModuleSolutionID getSelectedSolution() const;
  
  /** Executes the selected module */
  virtual void execute();

  /** 
  * Called from a MessageQueue to distribute messages.
  * Use message.getMessageID to decide if the message is relavant for 
  * the MesssageHandler derivate.
  * @param message The message that can be read.
  * @return true if the message was read (handled).
  */
  virtual bool handleMessage(InMessage& message);

  /** RunTime */
  unsigned int frameCounter;
  /** RunTime */
  double averageRunTime;
  /** RunTime */
  unsigned long maxRunTime;
  /** RunTime */
  unsigned long minRunTime;


protected:

  /** The id of the module, needed only for error messages. */
  SolutionRequest::ModuleID moduleID;

  /** The selected solution */
  Module *selectedSolution;
};


#endif /// __ModuleSelector_h_

---