Robot Simulator of the Robotics Group for Self-Organization of Control: imeasure.h Source File

# imeasure.h

Go to the documentation of this file.

    00001 /***************************************************************************
    00002  *   Copyright (C) 2005-2011 LpzRobots development team                    *
    00003  *    Georg Martius  <georg dot martius at web dot de>                     *
    00004  *    Frank Guettler <guettler at informatik dot uni-leipzig dot de        *
    00005  *    Frank Hesse    <frank at nld dot ds dot mpg dot de>                  *
    00006  *    Ralf Der       <ralfder at mis dot mpg dot de>                       *
    00007  *                                                                         *
    00008  *   This program is free software; you can redistribute it and/or modify  *
    00009  *   it under the terms of the GNU General Public License as published by  *
    00010  *   the Free Software Foundation; either version 2 of the License, or     *
    00011  *   (at your option) any later version.                                   *
    00012  *                                                                         *
    00013  *   This program is distributed in the hope that it will be useful,       *
    00014  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
    00015  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
    00016  *   GNU General Public License for more details.                          *
    00017  *                                                                         *
    00018  *   You should have received a copy of the GNU General Public License     *
    00019  *   along with this program; if not, write to the                         *
    00020  *   Free Software Foundation, Inc.,                                       *
    00021  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
    00022  *                                                                         *
    00023  ***************************************************************************/
    00024 /*
    00025  * imeasure.h
    00026  *
    00027  *  Created on: 26.01.2009
    00028  *      Author: guettler
    00029  */
    00030
    00031 #ifndef IMEASURE_H_
    00032 #define IMEASURE_H_
    00033
    00034 /**
    00035  * Class used by StatisticTools.
    00036  * Provides an interface for any kind of time series analysis.
    00037  * Every step the StatisticTools calls step.
    00038  * @sa StatisticTools
    00039  * @sa HUDStatisticsManager
    00040  * @sa AbstractMeasure
    00041  */
    00042 class IMeasure {
    00043 public:
    00044
    00045         virtual ~IMeasure() {};
    00046
    00047         virtual void step() = 0;
    00048
    00049         virtual std::string getName() const = 0;
    00050
    00051         virtual double getValue() const = 0;
    00052
    00053         virtual double& getValueAddress()  = 0;
    00054
    00055         virtual void setStepSize(int newStepSize) = 0;
    00056
    00057         virtual int getStepSize() const = 0;
    00058
    00059         virtual long getActualStep() const = 0;
    00060 };
    00061
    00062 #endif /* IMEASURE_H_ */