Bromeon
Time/Timer.hpp
Go to the documentation of this file.
00001 
00002 //
00003 // Thor C++ Library
00004 // Copyright (c) 2011 Jan Haller
00005 // 
00006 // This software is provided 'as-is', without any express or implied
00007 // warranty. In no event will the authors be held liable for any damages
00008 // arising from the use of this software.
00009 // 
00010 // Permission is granted to anyone to use this software for any purpose,
00011 // including commercial applications, and to alter it and redistribute it
00012 // freely, subject to the following restrictions:
00013 // 
00014 // 1. The origin of this software must not be misrepresented; you must not
00015 //    claim that you wrote the original software. If you use this software
00016 //    in a product, an acknowledgment in the product documentation would be
00017 //    appreciated but is not required.
00018 // 
00019 // 2. Altered source versions must be plainly marked as such, and must not be
00020 //    misrepresented as being the original software.
00021 // 
00022 // 3. This notice may not be removed or altered from any source distribution.
00023 //
00025 
00028 
00029 #ifndef THOR_TIMER_HPP
00030 #define THOR_TIMER_HPP
00031 
00032 #include <Thor/Time/StopWatch.hpp>
00033 #include <Thor/Config.hpp>
00034 
00035 
00036 namespace thor
00037 {
00038 
00041 
00045 class THOR_API Timer
00046 {
00047     // ---------------------------------------------------------------------------------------------------------------------------
00048     // Public member functions
00049     public:
00052                                     Timer();
00053 
00056         virtual                     ~Timer();
00057     
00061         explicit                    Timer(float timeLimit, bool initiallyRunning = false);
00062         
00065         float                       GetRemainingTime() const;
00066         
00069         bool                        IsRunning() const;
00070         
00073         bool                        IsExpired() const;
00074         
00077         void                        Start();
00078         
00081         void                        Stop();
00082         
00086         virtual void                Reset(float timeLimit, bool continueRunning = false);
00087         
00088 
00089     // ---------------------------------------------------------------------------------------------------------------------------
00090     // Private variables
00091     private:
00092         StopWatch                   mStopWatch;
00093         float                       mLimit;
00094 };
00095 
00097 
00098 } // namespace thor
00099 
00100 #endif // THOR_TIMER_HPP