system/CTicTac.h

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          http://www.mrpt.org/                          |
   |                                                                        |
   | Copyright (c) 2005-2018, Individual contributors, see AUTHORS file     |
   | See: http://www.mrpt.org/Authors - All rights reserved.                |
   | Released under BSD License. See details in http://www.mrpt.org/License |
   +------------------------------------------------------------------------+ */
#pragma once

namespace mrpt::system
{
/** A high-performance stopwatch, with typical resolution of nanoseconds.
 *  \note The class is named after the Spanish equivalent of "Tic-Toc" ;-)
 * \ingroup mrpt_system_grp
 */
class CTicTac
{
   public:
    /** Default constructor. Implicitly calls Tic() */
    CTicTac() noexcept;
    CTicTac(const CTicTac&) = delete;
    CTicTac& operator=(const CTicTac&) = delete;
    /** Starts the stopwatch. \sa Tac() */
    void Tic() noexcept;
    /** Stops the stopwatch.  \return Returns the ellapsed time in seconds.
     * \sa Tic() */
    double Tac() noexcept;

   private:
    alignas(16) unsigned long largeInts[4];
};  // End of class def.

}