00001 00002 /*************************************************************************** 00003 * globalpositionmodel.cpp - Abstract class defining a position model for 00004 * calculation of global position 00005 * 00006 * Created: 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 #include <models/global_position/globalpositionmodel.h> 00026 00027 namespace firevision { 00028 #if 0 /* just to make Emacs auto-indent happy */ 00029 } 00030 #endif 00031 00032 /** @class GlobalPositionModel <models/global_position/globalpositionmodel.h> 00033 * Global Position Model Interface. 00034 * This interface defines the API for global position models. 00035 * 00036 * @fn void GlobalPositionModel::set_robot_position(float x, float y, float ori) 00037 * Set the global position of the object. 00038 * @param x x coordinate of position 00039 * @param y y coordinate of position 00040 * @param ori orientation of robot 00041 * 00042 * @fn void GlobalPositionModel::set_position_in_image(unsigned int x, unsigned int y) 00043 * Set the position of the object as recognized in the image. 00044 * @param x x coordinate in pixels 00045 * @param y y coordinate in pixels 00046 * 00047 * @fn float GlobalPositionModel::get_x() const 00048 * Get global x coordinate of object. 00049 * @return x coordinate of object 00050 * 00051 * @fn float GlobalPositionModel::get_y() const 00052 * Get global y coordinate of object. 00053 * @return y coordinate of object 00054 * 00055 * @fn void GlobalPositionModel::calc() 00056 * Calculate position. 00057 * From the data set via setRobotPosition() or setPositionInImage() calculate the 00058 * objects global position. 00059 * 00060 * @fn bool GlobalPositionModel::is_pos_valid() const 00061 * Check if the position is valid. 00062 * @return true, if the calculated position is valid, false otherwise 00063 * 00064 * @author Tim Niemueller 00065 */ 00066 00067 /** Empty virtual destructor. */ 00068 GlobalPositionModel::~GlobalPositionModel() 00069 { 00070 } 00071 00072 } // end namespace firevision