Fawkes API Fawkes Development Version
|
00001 00002 /*************************************************************************** 00003 * state_handler.cpp - Fawkes RefBox State Handler Pure Virtual Class 00004 * 00005 * Created: Mon Apr 20 09:49:06 2009 (German Open 2009) 00006 * Copyright 2009 Tim Niemueller [www.niemueller.de] 00007 * 00008 ****************************************************************************/ 00009 00010 /* This program is free software; you can redistribute it and/or modify 00011 * it under the terms of the GNU General Public License as published by 00012 * the Free Software Foundation; either version 2 of the License, or 00013 * (at your option) any later version. 00014 * 00015 * This program is distributed in the hope that it will be useful, 00016 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00017 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00018 * GNU Library General Public License for more details. 00019 * 00020 * Read the full text in the LICENSE.GPL file in the doc directory. 00021 */ 00022 00023 #include "state_handler.h" 00024 00025 /** @class RefBoxStateHandler "processor/state_handler.h" 00026 * Referee Box state handler for RefBoxProcessor. 00027 * Handlers that implement this interface are used by processors to announce 00028 * received information. 00029 * @author Tim Niemueller 00030 * 00031 * 00032 * @fn void RefBoxStateHandler::set_gamestate(int game_state, fawkes::worldinfo_gamestate_team_t state_team) = 0 00033 * Set current game state. 00034 * @param game_state current game state 00035 * @param state_team team referenced by the game state 00036 * 00037 * @fn void RefBoxStateHandler::set_score(unsigned int score_cyan, unsigned int score_magenta) = 0 00038 * Set score. 00039 * @param score_cyan current score of team cyan 00040 * @param score_magenta current score of team magenta 00041 * 00042 * @fn void RefBoxStateHandler::set_team_goal(fawkes::worldinfo_gamestate_team_t our_team, fawkes::worldinfo_gamestate_goalcolor_t goal_color) = 0 00043 * Set team and goal info. 00044 * @param our_team our team color 00045 * @param goal_color our goal color 00046 * 00047 * @fn void RefBoxStateHandler::set_half(fawkes::worldinfo_gamestate_half_t half, bool kickoff = false) = 0 00048 * Set current half of the game time. 00049 * @param half current half 00050 * @param kickoff whether we have kickoff 00051 * 00052 * @fn void RefBoxStateHandler::add_penalty(unsigned int penalty, unsigned int seconds_remaining) = 0 00053 * Add penalty. 00054 * @param penalty penalty code 00055 * @param seconds_remaining estimated time when the penalty will be lifted 00056 * 00057 * @fn void RefBoxStateHandler::handle_refbox_state() = 0 00058 * Process the information set up to now. 00059 */ 00060 00061 /** Empty destructor. */ 00062 RefBoxStateHandler::~RefBoxStateHandler() 00063 { 00064 }