calibrationinterface.hpp

机器人开源项目orocos的源代码

/***************************************************************************
  tag: Peter Soetens  Tue May 4 16:49:13 CEST 2004  CalibrationInterface.hpp 

                        CalibrationInterface.hpp -  description
                           -------------------
    begin                : Tue May 04 2004
    copyright            : (C) 2004 Peter Soetens
    email                : [e-mail]
 
 ***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU General Public                   *
 *   License as published by the Free Software Foundation;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/ 
 
#ifndef CALIBRATION_INTERFACE_HPP
#define CALIBRATION_INTERFACE_HPP

namespace RTT
{
    /**
     * @brief A class which will calibrate a sensor. It is
     * useful for making 'calibration' objects.
     * @see SensorInterface
     * @ingroup DeviceInterface
     */
    class CalibrationInterface
    {
    protected:
        bool calibrated;
    public:
        CalibrationInterface() : calibrated(false) {}
        virtual ~CalibrationInterface() {}
        /**
         * @brief Start or perform calibration.
         */
        virtual void calibrate() { calibrated  = true;}

        /** 
         * @brief Inspect if a calibration has been done.
         * 
         * 
         * @return True if so.
         */
        virtual bool isCalibrated() const { return calibrated; }

        /** 
         * @brief Undo any previous calibration
         * ( this function may have no effect ).
         */
        virtual void unCalibrate() { calibrated = false; }
    };
}

#endif