Modules/BehaviorControl/GT2005BehaviorControl/GT2005BasicBehaviors/GT2005PotentialFieldBasicBehaviors.h

Go to the documentation of this file.

/** 
* @file GT2005PotentialFieldBasicBehaviors.h
*
* Declaration of basic behaviors defined in potential-field-basic-behaviors.xml.
*
* @author <a href="mailto:timlaue@tzi.de">Tim Laue</a>
*/

#ifndef __GT2005PotentialFieldBasicBehaviors_h_
#define __GT2005PotentialFieldBasicBehaviors_h_

#include "Tools/Xabsl2/Xabsl2Engine/Xabsl2Engine.h"
#include "Tools/PotentialFields/GTStandardConverter.h"
#include "Modules/BehaviorControl/BehaviorControl.h"
#include "Tools/Xabsl2/Xabsl2Engine/Xabsl2BasicBehavior.h"


/**
* An abstract base class for all potential field based basic behaviors
*
* @author Tim Laue
*/
class GT2005PotentialFieldBasicBehavior : public Xabsl2BasicBehavior, 
                                          public BehaviorControlInterfaces
{
public:
/*
* Constructor.
* @param errorHandler Is invoked when errors occur
* @param interfaces The paramters of the BehaviorControl module.
  */
  GT2005PotentialFieldBasicBehavior(const BehaviorControlInterfaces& interfaces,
    Xabsl2ErrorHandler& errorHandler, const char* behaviorName, const char* pfcFileName):
            Xabsl2BasicBehavior(behaviorName, errorHandler),
            BehaviorControlInterfaces(interfaces)
  {
    potentialfields.load(pfcFileName);
  };
    
  /**  Executes the basic behavior. */
  virtual void execute() = 0;

protected:
  /** An instance of the potential field architecture*/
  GTStandardConverter potentialfields;
  /** A standard instance of a result structure*/
  PotentialfieldResult result;
};


class GT2005PotentialFieldBasicBehaviorSupport : public GT2005PotentialFieldBasicBehavior
{
public:
  /*
* Constructor.
* @param errorHandler Is invoked when errors occur
* @param interfaces The paramters of the BehaviorControl module.
  */
  GT2005PotentialFieldBasicBehaviorSupport(const BehaviorControlInterfaces& interfaces,
                                           Xabsl2ErrorHandler& errorHandler);
    
  /**  Executes the basic behavior. */
  virtual void execute();

private:
  /** Parameter potential-field-support.x*/
  double x;
  /** Parameter potential-field-support.y*/
  double y;
  /** Parameter potential-field-support.max-speed*/
  double maxSpeed;
};


class GT2005PotentialFieldBasicBehaviorOffensiveSupport : public GT2005PotentialFieldBasicBehavior
{
public:
  /*
* Constructor.
* @param errorHandler Is invoked when errors occur
* @param interfaces The paramters of the BehaviorControl module.
  */
  GT2005PotentialFieldBasicBehaviorOffensiveSupport(const BehaviorControlInterfaces& interfaces,
                                                    Xabsl2ErrorHandler& errorHandler);
    
  /**  Executes the basic behavior. */
  virtual void execute();

private:
  /** Parameter potential-field-offensive-support.x*/
  double x;
  /** Parameter potential-field-offensive-support.y*/
  double y;
  /** Parameter potential-field-offensive-support.max-speed*/
  double maxSpeed;
};


class GT2005PotentialFieldBasicBehaviorAvoidRobots : public GT2005PotentialFieldBasicBehavior
{
public:
  /*
* Constructor.
* @param errorHandler Is invoked when errors occur
* @param interfaces The paramters of the BehaviorControl module.
  */
  GT2005PotentialFieldBasicBehaviorAvoidRobots(const BehaviorControlInterfaces& interfaces,
                                                    Xabsl2ErrorHandler& errorHandler);
    
  /**  Executes the basic behavior. */
  virtual void execute();

private:
  /** Parameter potential-field-offensive-support.x*/
  double x;
  /** Parameter potential-field-offensive-support.y*/
  double y;
  /** Parameter potential-field-offensive-support.max-speed*/
  double maxSpeed;
};


/**
* @class PotentialFieldBasicBehaviors
*
* Creates and registers potential field basic behaviors
*/
class GT2005PotentialFieldBasicBehaviors : public BehaviorControlInterfaces
{
public:
  /**
  * Constructor
  */
  GT2005PotentialFieldBasicBehaviors(BehaviorControlInterfaces& interfaces,
    Xabsl2ErrorHandler& errorHandler):
  BehaviorControlInterfaces(interfaces),
  errorHandler(errorHandler),
  potentialFieldSupport(interfaces, errorHandler),
  potentialFieldOffensiveSupport(interfaces, errorHandler),
  potentialFieldAvoidRobots(interfaces, errorHandler)
  {}

  /** Registers basic behaviors at the engine */
  void registerBasicBehaviors(Xabsl2Engine& engine)
  {
    engine.registerBasicBehavior(potentialFieldSupport);
    engine.registerBasicBehavior(potentialFieldOffensiveSupport);
    engine.registerBasicBehavior(potentialFieldAvoidRobots);
  }

  /** updates some variables */
  void update() {};

private:
  /** Is invoked when errors occurs */
  Xabsl2ErrorHandler& errorHandler;

  //!@name Basic Behaviors
  //!@{
  GT2005PotentialFieldBasicBehaviorSupport potentialFieldSupport;
  GT2005PotentialFieldBasicBehaviorOffensiveSupport potentialFieldOffensiveSupport;
  GT2005PotentialFieldBasicBehaviorAvoidRobots potentialFieldAvoidRobots;
  //!@}
};

#endif // __GT2005PotentialFieldBasicBehaviors_h_

---