Representations/RoboCup/GameControlData.h

Go to the documentation of this file.

/**
* @file GameControlData.h
*
* Declaration of class GameControlData
*
* @author Martin Lötzsch
*/ 

#ifndef __GameControlData_h_
#define __GameControlData_h_

typedef long unsigned int uint32;

#include "RoboCupGameControlData.h"
#include "Tools/Streams/InOut.h"
#include "Tools/Player.h"

/** 
* @class GameControlData
*
* Encapsulates the RoboCupGameControlData struct for the GT2005 project.
*
* @author Michael Wachter
*/
class GameControlData 
{
public:
  enum State 
  { 
    initial = STATE_INITIAL, 
    ready = STATE_READY, 
    set = STATE_SET,
    playing = STATE_PLAYING, 
    finished = STATE_FINISHED
  };
  
  enum Penalties 
  { 
    notPenalized = PENALTY_NONE,
    illegalDefender = PENALTY_ILLEGAL_DEFENDER,
    illegalDefense = PENALTY_ILLEGAL_DEFENSE,
    obstruction = PENALTY_OBSTRUCTION,
    goaliePushing = PENALTY_GOALIE_PUSHING, 
    playerPushing = PENALTY_PLAYER_PUSHING, 
    ballHolding = PENALTY_BALL_HOLDING, 
    requestForPickup = PENALTY_REQ_FOR_PICKUP,  //WARNING ! PICKUP was spelled PICUP in original RoboCupGameControlData.h
    leaving = PENALTY_LEAVING,
    damage = PENALTY_DAMAGE,
    numOfPenalties
  };

  enum KickoffTeam 
  {
    undefinedTeam, 
    ownTeam, 
    opponentTeam
  };

  /**
   * Constuctor
   */
  GameControlData();

  /** returns the name of the state */
  static const char* getStateName(State state);

  /** returns the name for the variable kickoff */
  static const char* getKickoffTeamName(KickoffTeam kickoffTeam);
  
  /** returns the name of the current penalty */
  static const char* getPenaltyName(Penalties penalty);

  /** returns the penalty of the player */
  Penalties getPenalty(Player player = getPlayer()) const;
  
  /** returns the number (0,1) of the data.teams -array the robot belongs to. */
  unsigned int getOwnTeamNumber(Player player = getPlayer()) const;

  /** returns a reference to the teamInfo of the team of the Player */
  const TeamInfo& getOwnTeam(Player player = getPlayer()) const;
  TeamInfo& getOwnTeam(Player player = getPlayer());

   /** returns the number (0,1) of the data.teams -array of the robots opponents. */
  unsigned int getOpponentTeamNumber(Player player = getPlayer()) const;

  /** returns the robot-info for a player **/
  const RobotInfo& getRobot(Player player = getPlayer()) const;
  RobotInfo& getRobot(Player player = getPlayer());

  /** returns a reference to the teamInfo of the team of the robots opponents */
  const TeamInfo& getOpponentTeam(Player player = getPlayer()) const;
  TeamInfo& getOpponentTeam(Player Player = getPlayer());

  /** returns the Kickoff-Team as own/opponent */
  KickoffTeam getKickoffTeam(Player player = getPlayer()) const;

  /** returns the Team by the GameControlerTeamNumber) */
  const TeamInfo& getTeamByNumber(int number) const;
  TeamInfo& getTeamByNumber(int number);

  const TeamInfo& getTeamByColor(int color) const;
  TeamInfo& getTeamByColor(int color);

  /** the == operator */
  bool operator == (const GameControlData& other);
  
  /** the != operator */
  bool operator != (const GameControlData& other)
  {
    return ! (*this == other);
  }

  /**
   * The data send by the game-controller
   */
  mutable RoboCupGameControlData data;

  mutable bool switchOff;

  /** 
  * The timestamp when the last request was received.
  * Note that this value is set in the In streaming operator.
  */
  unsigned long timeStamp;
};


/**
* Streaming operator that reads a GameControlData from a stream.
* @param stream The stream from which is read.
* @param gameControlData The GameControlData object.
* @return The stream.
*/ 
In& operator>>(In& stream,GameControlData& gameControlData);

/**
* Streaming operator that writes a GameControlData to a stream.
* @param stream The stream to write on.
* @param gameControlData The GameControlData object.
* @return The stream.
*/ 
Out& operator<<(Out& stream, const GameControlData& gameControlData);

#endif //__GameControlData_h_

---