Fawkes API Fawkes Development Version
state_handler.cpp
1
2/***************************************************************************
3 * state_handler.cpp - Fawkes RefBox State Handler Pure Virtual Class
4 *
5 * Created: Mon Apr 20 09:49:06 2009 (German Open 2009)
6 * Copyright 2009 Tim Niemueller [www.niemueller.de]
7 *
8 ****************************************************************************/
9
10/* This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Library General Public License for more details.
19 *
20 * Read the full text in the LICENSE.GPL file in the doc directory.
21 */
22
23#include "state_handler.h"
24
25/** @class RefBoxStateHandler "processor/state_handler.h"
26 * Referee Box state handler for RefBoxProcessor.
27 * Handlers that implement this interface are used by processors to announce
28 * received information.
29 * @author Tim Niemueller
30 *
31 *
32 * @fn void RefBoxStateHandler::set_gamestate(int game_state, fawkes::worldinfo_gamestate_team_t state_team) = 0
33 * Set current game state.
34 * @param game_state current game state
35 * @param state_team team referenced by the game state
36 *
37 * @fn void RefBoxStateHandler::set_score(unsigned int score_cyan, unsigned int score_magenta) = 0
38 * Set score.
39 * @param score_cyan current score of team cyan
40 * @param score_magenta current score of team magenta
41 *
42 * @fn void RefBoxStateHandler::set_team_goal(fawkes::worldinfo_gamestate_team_t our_team, fawkes::worldinfo_gamestate_goalcolor_t goal_color) = 0
43 * Set team and goal info.
44 * @param our_team our team color
45 * @param goal_color our goal color
46 *
47 * @fn void RefBoxStateHandler::set_half(fawkes::worldinfo_gamestate_half_t half, bool kickoff = false) = 0
48 * Set current half of the game time.
49 * @param half current half
50 * @param kickoff whether we have kickoff
51 *
52 * @fn void RefBoxStateHandler::add_penalty(unsigned int penalty, unsigned int seconds_remaining) = 0
53 * Add penalty.
54 * @param penalty penalty code
55 * @param seconds_remaining estimated time when the penalty will be lifted
56 *
57 * @fn void RefBoxStateHandler::handle_refbox_state() = 0
58 * Process the information set up to now.
59 */
60
61/** Empty destructor. */
63{
64}
virtual ~RefBoxStateHandler()
Empty destructor.