Fawkes API Fawkes Development Version
globalpositionmodel.cpp
1
2/***************************************************************************
3 * globalpositionmodel.cpp - Abstract class defining a position model for
4 * calculation of global position
5 *
6 * Created: Wed Mar 21 15:44:10 2007
7 * Copyright 2005-2007 Tim Niemueller [www.niemueller.de]
8 *
9 ****************************************************************************/
10
11/* This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version. A runtime exception applies to
15 * this software (see LICENSE.GPL_WRE file mentioned below for details).
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
21 *
22 * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
23 */
24
25#include <fvmodels/global_position/globalpositionmodel.h>
26
27namespace firevision {
28
29/** @class GlobalPositionModel <fvmodels/global_position/globalpositionmodel.h>
30 * Global Position Model Interface.
31 * This interface defines the API for global position models.
32 *
33 * @fn void GlobalPositionModel::set_robot_position(float x, float y, float ori)
34 * Set the global position of the object.
35 * @param x x coordinate of position
36 * @param y y coordinate of position
37 * @param ori orientation of robot
38 *
39 * @fn void GlobalPositionModel::set_position_in_image(unsigned int x, unsigned int y)
40 * Set the position of the object as recognized in the image.
41 * @param x x coordinate in pixels
42 * @param y y coordinate in pixels
43 *
44 * @fn float GlobalPositionModel::get_x() const
45 * Get global x coordinate of object.
46 * @return x coordinate of object
47 *
48 * @fn float GlobalPositionModel::get_y() const
49 * Get global y coordinate of object.
50 * @return y coordinate of object
51 *
52 * @fn void GlobalPositionModel::calc()
53 * Calculate position.
54 * From the data set via setRobotPosition() or setPositionInImage() calculate the
55 * objects global position.
56 *
57 * @fn bool GlobalPositionModel::is_pos_valid() const
58 * Check if the position is valid.
59 * @return true, if the calculated position is valid, false otherwise
60 *
61 * @author Tim Niemueller
62 */
63
64/** Empty virtual destructor. */
66{
67}
68
69} // end namespace firevision
virtual ~GlobalPositionModel()
Empty virtual destructor.