gz/math/Stopwatch.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
 
#ifndef GZ_MATH_STOPWATCH_HH_
#define GZ_MATH_STOPWATCH_HH_
 
#include <chrono>
#include <memory>
#include <gz/math/Export.hh>
#include <gz/math/config.hh>
 
namespace ignition
{
  namespace math
  {
    // Use a steady clock
    using clock = std::chrono::steady_clock;
 
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_MATH_VERSION_NAMESPACE {
    //
    // Forward declarations.
    class StopwatchPrivate;
 
    //
    class IGNITION_MATH_VISIBLE Stopwatch
    {
      public: Stopwatch();
 
      public: Stopwatch(const Stopwatch &_watch);
 
      public: Stopwatch(Stopwatch &&_watch) noexcept;
 
      public: virtual ~Stopwatch();
 
      public: bool Start(const bool _reset = false);
 
      public: clock::time_point StartTime() const;
 
      public: bool Stop();
 
      public: clock::time_point StopTime() const;
 
      public: bool Running() const;
 
      public: void Reset();
 
      public: clock::duration ElapsedRunTime() const;
 
      public: clock::duration ElapsedStopTime() const;
 
      public: bool operator==(const Stopwatch &_watch) const;
 
      public: bool operator!=(const Stopwatch &_watch) const;
 
      public: Stopwatch &operator=(const Stopwatch &_watch);
 
      public: Stopwatch &operator=(Stopwatch &&_watch);
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
      private: std::unique_ptr<StopwatchPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
    };
  }
  }
}
#endif