Tools/Xabsl2/Xabsl2Engine/Xabsl2Engine.h

Go to the documentation of this file.

/** 
* @file Xabsl2Engine.h
*
* Declaration class Xabsl2Engine
*
* @author Matthias Jüngel
* @author Martin Lötzsch
*/

#ifndef __Xabsl2Engine_h_
#define __Xabsl2Engine_h_

#include "Xabsl2Agent.h"

/**
* Executes a behavior that was specified in the Xabsl language.
*
* @author Matthias Jüngel
* @author Martin Lötzsch
*
*/
class Xabsl2Engine : public Xabsl2Symbols
{
public:
  /** 
  * Constructor 
  * @param e Is invoked when there are problems during initialization
  * @param pTimeFunction a pointer to a function that returns the system time in ms.
  */
  Xabsl2Engine(Xabsl2ErrorHandler& e, unsigned long (*pTimeFunction)());

  /** Destructor */
  ~Xabsl2Engine();

  /** 
  * Executes the engine for the selected agent starting from the root option.
  * (Including the selected basic behavior)
  */
  void execute();

  /** Executes only the selected basic behavior */
  void executeSelectedBasicBehavior();

  /**
  * Reads the intermediate code from an input source and creates the option graph.
  * Note that the basic behaviors and symbols have to be registered before that function is 
  * called.
  */
  void createOptionGraph(Xabsl2InputSource& input);

  /** 
  * Registers a basic behavior at the engine. 
  * This must be done before the intermediate code is read.
  * @param basicBehavior A reference to the basic behavior
  */
  void registerBasicBehavior(Xabsl2BasicBehavior& basicBehavior);

  /** 
  * Sets the selected Agent.
  * If the last selected agent was different from the new one, 
  * the root option is changed depending on the new agent.
  * @param name The name of the agent
  * @return if the requested agent exists
  */
  bool setSelectedAgent(const char* name);

private:
  /** The agents of the engine */
  Xabsl2Array<Xabsl2Agent*> agents;

  /** The selected agent */
  Xabsl2Agent* selectedAgent;

  /** The options of the engine */
  Xabsl2Array<Xabsl2Option*> options;

  /** The option where the execution of the option graph starts */
  Xabsl2Option* rootOption;

  /** The registered basic behaviors of the engine */
  Xabsl2Array<Xabsl2BasicBehavior&> basicBehaviors;

  /** The selected basic behavior */
  Xabsl2BasicBehavior* selectedBasicBehavior;

  /** Is invoked when there are problems during initialization */
  Xabsl2ErrorHandler& errorHandler;

  /** 
  * A recursive function that is used to check for loops in the option graph.
  * @param currenOptionPath An array of the currently traced option path
  * @param currentDepth The depth of the current option path
  * @return If true, then a loop was detected.
  */
  bool checkForLoops(Xabsl2Option* currenOptionPath[], int currentDepth);

  /** If true, the engine was successfully initialized */
  bool initialized;

  /** A pointer to a function that returns the system time in ms. */
  unsigned long (*pTimeFunction)();
public:
  //!@name Debugging Interface 
  //!@{

  /** 
  * Executes the option graph starting from a given option.
  * Can be called to test a single option.
  * @param name The name of the option
  * @return When false, the option is not known to the engine
  */
  bool setRootOption(const char* name);

  /** 
  * Sets the root option of the selected agent
  */
  void setRootOption();

  /** Returns the selected root option */
  const Xabsl2Option* getRootOption() const;

  /** 
  * Sets a parameter of a option.
  * @param name The name of the option
  * @param param The name of of the parameter
  * @param value The value for the parameter
  * @return When false, the option or the parameter does not exist
  */
  bool setOptionParameter(const char* name, const char* param, double value);


  /** 
  * Sets the selected basic behavior. 
  * Can be called to test a single basic behavior.
  * @param name The name of the basic behavior.
  * @return When false, the basic behavior was not registered
  */
  bool setSelectedBasicBehavior(const char* name);

  /** 
  * Sets a parameter of a basic behavior.
  * @param name The name of the basic behavior
  * @param param The name of of the parameter
  * @param value The value for the parameter
  * @return When false, the basic behavior or the parameter were not registered
  */
  bool setBasicBehaviorParameter(const char* name, const char* param, double value);

  /** Returns the name of the selected agent */
  const char* getSelectedAgentName();

  /** Returns the selected basic behavior */
  const Xabsl2BasicBehavior* getSelectedBasicBehavior();

  //!@}
};




#endif // __Xabsl2Engine_h_

---