001:
002:
003:
004:
005:
006:
007:
008:
009:
010:
011:
012:
013:
014:
015:
016:
017:
018:
019:
020:
021:
022:
023:
024:
025:
026:
027:
028:
029:
030:
031:
032:
033:
034:
035:
036:
037:
038:
039:
040:
041:
042:
043:
044:
045:
046:
047:
048:
049:
050:
051:
052:
053:
054:
055:
056:
057:
058:
059:
060:
061:
062:
063:
064:
065:
066:
067:
068:
069:
070:
071:
072:
073:
074:
075:
076:
077:
078:
079:
080:
081:
082:
083:
084:
085:
086:
087:
088:
089:
090:
091:
092:
093:
094:
095:
096:
097:
098:
099:
100:
101:
102:
103:
104:
105:
106:
107:
108:
109:
110:
111:
112:
113:
114:
115:
116:
/*
* This file is part of the Omni C++ framework
*
* Copyright (c) 2016, Zeriph Enterprises, LLC
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of Zeriph, Zeriph Enterprises, LLC, nor the names
* of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY ZERIPH AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL ZERIPH AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#if !defined(OMNI_STOPWATCH_HPP)
#define OMNI_STOPWATCH_HPP 1
#include <omni/defs/class_macros.hpp>
#include <omni/chrono/tick.hpp>
namespace omni {
/**
* @brief The stopwatch class is a simple timer class that will keep track of monotonic time.
*
* @details
*
* @exception Errors
*
* @warning Consideration
*
* @attention Platform
*
* @note Notes
*/
class stopwatch
{
public:
stopwatch();
stopwatch(const omni::stopwatch &cp);
~stopwatch();
// TODO: omni::timespan elapsed();
std::size_t elapsed_us() const;
std::size_t elapsed_ms() const;
std::size_t elapsed_s() const;
bool is_running() const;
omni::stopwatch& reset();
omni::stopwatch& restart();
/**
* @brief Brief
*
* @details Details
*
* @exception Errors
*
* @warning Consideration
*
* @attention Platform
*
* @note Notes
*
* @param offset_ms Parameter_Description
*
* @return Return_Description
*/
omni::stopwatch& restart(unsigned long offset_ms);
omni::stopwatch& start();
omni::stopwatch& start(unsigned long offset_ms);
omni::stopwatch& stop();
omni::stopwatch& operator=(const omni::stopwatch &other);
omni::stopwatch& operator=(bool enable);
bool operator==(const omni::stopwatch &o) const;
bool operator!=(const omni::stopwatch &o) const;
friend std::ostream& operator<<(std::ostream& os, const omni::stopwatch& sw)
{ os << sw.elapsed_ms() << " ms"; return os; }
friend std::wostream& operator<<(std::wostream& os, const omni::stopwatch& sw)
{ os << sw.elapsed_ms() << " ms"; return os; }
OMNI_MEMBERS_FW(omni::stopwatch) // disposing,name,type(),hash()
private:
/** zero's the clocks */
void _zero();
#if defined(OMNI_TYPE_INFO)
omni::type<omni::stopwatch> m_type;
#endif
/** The internal end clock */
omni::chrono::tick_t m_end;
/** The internal start clock */
omni::chrono::tick_t m_init;
/** Determines of the current stopwatch is running (start called but not stop) */
volatile bool m_isrun;
/** Determines if the stopwatch has been started and not reset */
volatile bool m_isstrt;
};
}
#endif // OMNI_STOPWATCH_HPP