Tools/Module/Module.h

Go to the documentation of this file.

/** 
* @file Module.h
*
* Definition of class Module.
*
* @author <a href="mailto:juengel@informatik.hu-berlin.de">Matthias Jüngel</a>
* @author <a href="mailto:martin@martin-loetzsch.de">Martin Lötzsch</a>
*/

#ifndef __Module_h_
#define __Module_h_

#include "Platform/SystemCall.h"
#include "Tools/MessageQueue/InMessage.h"

/**
* @class Module
*
* Base class for all modules.
*
* @author <a href="mailto:juengel@informatik.hu-berlin.de">Matthias Jüngel</a>
* @author <a href="mailto:martin@martin-loetzsch.de">Martin Lötzsch</a>
*/
class Module : public MessageHandler
{
public:
  /** executes the module */
#ifdef NDEBUG
  virtual void execute() = 0;
#else
  /**
  * When doing a debug build, we save the time, when we entered the module, so we can find endless loops
  */
  virtual void execute() {
    entryTime = SystemCall::getCurrentSystemTime ();
  };
#endif

  /** 
  * 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) {return false;}

  virtual ~Module() {};

#ifndef NDEBUG
  /**
  * Used for finding endless loops
  */
  unsigned long entryTime;
#endif
};

#endif //__Module_h_

---