Tools/Player.h

Go to the documentation of this file.

/**
* @file Player.h
*
* Definition of class Player
* 
* @author Martin Lötzsch
*/
#ifndef __Player_h_
#define __Player_h_

#include <string.h>
#include "Tools/Streams/InOut.h"

class Player;

/**
* Returns a reference to a process wide player configuration.
*/
Player& getPlayer();

/**
* The function sets the player data for this process.
* @param player A pointer to the player data.
*/
void setPlayer(Player* player);

/** 
* @class Player
*
* A class that represents the team color and player number of the robot. 
*
* @author Martin Lötzsch
*/
class Player
{
public:
  /** Constructor. */
  Player();

  /** Loads the data from player.cfg */
  void load();

  /** possible team colors */
  enum teamColor {red, blue, undefinedTeamColor};

  /** returns the name of a color */
  static const char* getTeamColorName(teamColor color)
  {
    switch (color)
    {
    case red: return "red";
    case blue: return "blue";
    default: return "undefined";
    }
  }

  /** returns the team color */
  teamColor getTeamColor() const { return theTeamColor; }

  /** sets the team color */
  void setTeamColor(teamColor t) { theTeamColor=t; }

  /** returns the color for a given name */
  static teamColor getTeamColorFromString(char* name)
  {
    if (strcmp(name,"red") == 0) return red;
    else if (strcmp(name,"blue") == 0) return blue;
    else return undefinedTeamColor;
  }

 // #define FIVEDOGS  
/* -> Martin : Bitte vorläufig drinlassen.
 * Ich Überblicke es im Augenblick nicht was mehr als 4 TeamMessageSender / Receiver
 * für Auswirkungen in RobotControl haben. Wenn FIVEDOGS nicht gesetzt ist, werden nur 3 
 * angelegt.
 *
 * Michael.
 */

  /** the possible player numbers */
  enum playerNumber
  {
    one = 0, two, three, four,
#ifdef FIVEDOGS
    five, 
#endif
      undefinedPlayerNumber, numOfPlayerNumbers = undefinedPlayerNumber
  };

  /** returns the name of a number */
  static const char* getPlayerNumberName(playerNumber number)
  {
    switch (number)
    {
    case one: return "1";
    case two: return "2";
    case three: return "3";
    case four: return "4";
#ifdef FIVEDOGS
    case five: return "5";
#endif
    default: return "undefined";
    }
  }

  char* getTeamName()
  {
    return(theTeamName);
  }

  int getGameControllerTeamNumber()
  {
     return theGameControllerTeamNumber;
  }

  /** returns the player number */
  playerNumber getPlayerNumber() const { return thePlayerNumber; }

  /** sets the player number */
  void setPlayerNumber(playerNumber n) { thePlayerNumber=n; }

  /** returns the number for a given name */
  static playerNumber getPlayerNumberFromString(char* name)
  {
    if (strcmp(name,"1")==0) return one;
    else if (strcmp(name,"2")==0) return two; 
    else if (strcmp(name,"3")==0) return three; 
    else if (strcmp(name,"4")==0) return four; 
#ifdef FIVEDOGS
    else if (strcmp(name,"5")==0) return five; 
#endif
    else return undefinedPlayerNumber;
  }

private:
  /** the team color of the player */
  teamColor theTeamColor;

  /** the number of the player */
  playerNumber thePlayerNumber;

  /** the team-name of the player */
  char theTeamName[16];

  /** the Game-Controller-Team-Number of the Robot */
  int theGameControllerTeamNumber;
};

/**
 * Streaming operator that reads a Player from a stream.
 * @param stream The stream from which is read.
 * @param player The Player object.
 * @return The stream.
 */ 
In& operator>>(In& stream,Player& player);
 
/**
 * Streaming operator that writes a Player to a stream.
 * @param stream The stream to write on.
 * @param player The Player object.
 * @return The stream.
 */ 
Out& operator<<(Out& stream, const Player& player);


#endif //__Player_h_

---