OpenWalnut  1.4.0
WTimer.h
00001 //---------------------------------------------------------------------------
00002 //
00003 // Project: OpenWalnut ( http://www.openwalnut.org )
00004 //
00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
00006 // For more information see http://www.openwalnut.org/copying
00007 //
00008 // This file is part of OpenWalnut.
00009 //
00010 // OpenWalnut is free software: you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as published by
00012 // the Free Software Foundation, either version 3 of the License, or
00013 // (at your option) any later version.
00014 //
00015 // OpenWalnut is distributed in the hope that it will be useful,
00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018 // GNU Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public License
00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
00022 //
00023 //---------------------------------------------------------------------------
00024 
00025 #ifndef WTIMER_H
00026 #define WTIMER_H
00027 
00028 #include <boost/shared_ptr.hpp>
00029 
00030 
00031 
00032 /**
00033  * Base class for timing. Derive from it to write several timers like a frame-timer or realtime-timer.
00034  */
00035 class WTimer      // NOLINT - no does not need an virtual destructor.
00036 {
00037 public:
00038     /**
00039      * Convenience typedef for a shared_ptr
00040      */
00041     typedef boost::shared_ptr< WTimer > SPtr;
00042 
00043     /**
00044      * Convenience typedef for a const shared_ptr.
00045      */
00046     typedef boost::shared_ptr< const WTimer > ConstSPtr;
00047 
00048     /**
00049      * Constructs a animation timer.
00050      */
00051     WTimer();
00052 
00053     /**
00054      * Destructor.
00055      */
00056     virtual ~WTimer();
00057 
00058     /**
00059      * Resets the start-tick.
00060      */
00061     virtual void reset() = 0;
00062 
00063     /**
00064      * Returns the elapsed time since the last reset in seconds with milliseconds precision.
00065      *
00066      * \return elapsed time in seconds with millisecond precision.
00067      */
00068     virtual double elapsed() const = 0;
00069 
00070 private:
00071 };
00072 
00073 #endif  // WTIMER_H