00001
00002 /***************************************************************************
00003  *  globalpositionmodel.cpp - Abstract class defining a position model for
00004  *                            calculation of global position
00005  *
00006  *  Generated: Wed Mar 21 15:44:10 2007
00007  *  Copyright  2005-2007  Tim Niemueller [www.niemueller.de]
00008  *
00009  ****************************************************************************/
00010
00011 /*  This program is free software; you can redistribute it and/or modify
00012  *  it under the terms of the GNU General Public License as published by
00013  *  the Free Software Foundation; either version 2 of the License, or
00014  *  (at your option) any later version. A runtime exception applies to
00015  *  this software (see LICENSE.GPL_WRE file mentioned below for details).
00016  *
00017  *  This program is distributed in the hope that it will be useful,
00018  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00019  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00020  *  GNU Library General Public License for more details.
00021  *
00022  *  Read the full text in the LICENSE.GPL_WRE file in the doc directory.
00023  */
00024 
00025 /** @class GlobalPositionModel <models/global_position/globalpositionmodel.h>
00026  * Global Position Model Interface.
00027  * This interface defines the API for global position models.
00028  *
00029  * @fn void GlobalPositionModel::set_robot_position(float x, float y, float ori)
00030  * Set the global position of the object.
00031  * @param x x coordinate of position
00032  * @param y y coordinate of position
00033  * @param ori orientation of robot
00034  *
00035  * @fn void GlobalPositionModel::set_position_in_image(unsigned int x, unsigned int y)
00036  * Set the position of the object as recognized in the image.
00037  * @param x x coordinate in pixels
00038  * @param y y coordinate in pixels
00039  *
00040  * @fn float GlobalPositionModel::get_x() const
00041  * Get global x coordinate of object.
00042  * @return x coordinate of object
00043  *
00044  * @fn float GlobalPositionModel::get_y() const
00045  * Get global y coordinate of object.
00046  * @return y coordinate of object
00047  *
00048  * @fn void GlobalPositionModel::calc()
00049  * Calculate position.
00050  * From the data set via setRobotPosition() or setPositionInImage() calculate the
00051  * objects global position.
00052  *
00053  * @fn bool GlobalPositionModel::is_pos_valid() const
00054  * Check if the position is valid.
00055  * @return true, if the calculated position is valid, false otherwise
00056  *
00057  * @author Tim Niemueller
00058  */
00059
00060 #include <models/global_position/globalpositionmodel.h>
00061 
00062 /** Empty virtual destructor. */
00063 GlobalPositionModel::~GlobalPositionModel()
00064 {
00065 }