Modules/BehaviorControl/CommonXabsl2Symbols/PassSymbols.h

Go to the documentation of this file.

/** 
* @file PassSymbols.h
*
* Declaration of class PassSymbols.
* The Xabsl2 symbols that are defined in "pass-symbols.xml"
* @author Marc Dassler
*/

#ifndef __PassSymbols_h_
#define __PassSymbols_h_

#include "../BehaviorControl.h"
#include "Tools/Xabsl2/Xabsl2Engine/Xabsl2Engine.h"


class PassSymbols : public Xabsl2FunctionProvider, public BehaviorControlInterfaces
{
public:
/*
* Constructor.
* @param interfaces The paramters of the BehaviorControl module.
  */
  PassSymbols(const BehaviorControlInterfaces& interfaces);
  
  /** registers the symbols at an engine */
  void registerSymbols(Xabsl2Engine& engine);
  
    /** updates the symbols */
  void update();

  //!@name Input symbols
  //!@{
  bool getPassExists();  /*!< A function for the symbol "pass.found" */
  double getPassQuality(); /*!< A function for the symbol "pass.quality" */
  double getPassDistance(); /*!< A function for the symbol "pass.distance" */
  double getPlayerNumberOfReceiver(); /*!< A function for the symbol "pass.player-number-of-pass-receiver" */
  double getAngleToPassSender(); /*!< A function for the symbol "pass.angle-to-pass-sender". Angle is relative */
  double getAngleToPassReceiver(); /*!< A function for the symbol "pass.angle-to-pass-receiver". Angle is relative */
  //!@}

private:
  long preparingAPassMessageTimeStamp;
  Player::playerNumber preparingAPassMessagePlayerNumber;
};


#endif // __PassSymbols_h_

---