Modules/BehaviorControl/Xabsl2BehaviorControl.h

Go to the documentation of this file.

/**
* @file Xabsl2BehaviorControl.h
* 
* Implementation of class Xabsl2BehaviorControl.
*
* @author Matthias Jüngel
* @author Martin Lötzsch
*/

#ifndef __Xabsl2BehaviorControl_h_
#define __Xabsl2BehaviorControl_h_

#include "BehaviorControl.h"
#include "Tools/Xabsl2/GT/GTXabsl2EngineExecutor.h"


/**
* @class Xabsl2BehaviorControl
*
* Base class for all BehaviorControl solutions that use a Xabsl2Engine
*
* @author Matthias Jüngel
* @author Martin Lötzsch
*/ 
class Xabsl2BehaviorControl : public BehaviorControl, public GTXabsl2EngineExecutor
{
public:
/** 
* Constructor.
* @param interfaces The paramters of the BehaviorControl module.
* @param id The id of the Xabsl2Engine.
  */
  Xabsl2BehaviorControl(const BehaviorControlInterfaces& interfaces, 
    SolutionRequest::xabsl2EngineID id);
  
  /** destructor */
  ~Xabsl2BehaviorControl() {};

  /** 
  * Is called for every incoming debug message.
  * @param message An interface to read the message from the queue
  * @return if the messag was read
  */
  virtual bool handleMessage(InMessage& message);
  
protected:

  /** Is called if the engine could not be created */
  virtual void executeIfEngineCouldNotBeCreated();

  /** 
  * Prints the main action that was generated by the execution of the engine to a string
  * @param buf the string where to print the action
  */
  virtual void printGeneratedMainActionToString(char* buf);

};

/**
* Allows to register the same Xabsl2BehaviorControl instance more than once
* at a ModuleHandler to be able to switch between different agents using the
* GT Module mechanism.
*/
class Xabsl2BehaviorControlAgentInterface : public BehaviorControl, public Xabsl2NamedItem
{
public:
/**
* Constructor
* @param name The name of the agent
* @param behaviorControl A newly created Xabsl2BehaviorControl can contains the agent.
* @param interfaces The paramters of the BehaviorControl module.
  */
  Xabsl2BehaviorControlAgentInterface(const char* name,
    Xabsl2BehaviorControl* behaviorControl,
    const BehaviorControlInterfaces& interfaces);
  
  /** Destructor. Deletes the Xabsl2BehaviorControl */
  ~Xabsl2BehaviorControlAgentInterface();

  /** Executes the agent */
  virtual void execute();
  
  /** 
  * Is called for every incoming debug message.
  * @param message An interface to read the message from the queue
  * @return if the messag was read
  */
  virtual bool handleMessage(InMessage& message);
  
private:
  /** A pointer to the Xabsl2BehaviorControl can contains the agent. */
  Xabsl2BehaviorControl* behaviorControl;
};

#endif// __Xabsl2BehaviorControl_h_

---