Modules/BehaviorControl/CommonXabsl2Symbols/RoboCupGameManagerSymbols.h

Go to the documentation of this file.

/** 
* @file RoboCupGameManagerSymbols.h
*
* Declaration of class RoboCupGameManagerSymbols.
*
* @author Matthias Jüngel
*/

#ifndef __RoboCupGameManagerSymbols_h_
#define __RoboCupGameManagerSymbols_h_

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


/**
* The Xabsl2 symbols that are defined in "robocup-game-manager-symbols.xml"
*
* @author Matthias Jüngel
*/ 
class RoboCupGameManagerSymbols : public Xabsl2FunctionProvider, public BehaviorControlInterfaces
{
public:
/*
* Constructor.
* @param interfaces The paramters of the BehaviorControl module.
  */
  RoboCupGameManagerSymbols(const BehaviorControlInterfaces& interfaces);
  
  /** registers the symbols at an engine */
  void registerSymbols(Xabsl2Engine& engine);
  
    /** updates the symbols */
  void update();

  //!@name Input symbols
  //!@{
  int getState(); /*!< A function for the symbol "game.state" */
  int getKickoff(); /*!< A function for the symbol "game.kickoff" */
  int getTeamColor(); /*!< A function for the symbol "game.team-color" */
  bool getOwnTeamScored(); /*!< A function for the symbol "game.own-team-scored"  */
  bool getOpponentTeamScored(); /*!< A function for the symbol "game.opponent-team-scored"  */
  double getOwnScore(); /*!< A function for the symbol "game.own-score" */
  double getOpponentScore(); /*!< A function for the symbol "game.opponent-score" */
  double getTimeSinceLastMessage(); /*!< A function for the symbol "game.time-since-last-message" */
  //!@}

  /* A function for the output symbol "set-team-color". */
  void setTeamColor(int teamColor);

private:
  /** the game control state we received the last time */
  int lastGameControlDataState;

  /** keeps the recent own score value */
  int lastOwnScore;

  /** keeps the recent opponent score value */
  int lastOpponentScore;

  /** keeps the time when the last own goal was shot */
  unsigned long timeWhenOwnTeamScored;

  /** keeps the time when the last opponent goal was shot */
  unsigned long timeWhenOpponentTeamScored;

  /** The current game state (set by the behavior)*/
  GameControlData::State currentState;
};


#endif // __RoboCupGameManagerSymbols_h_

---