otbStopwatch.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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 otbStopwatch_h
#define otbStopwatch_h
 
#include <cstdint>
#include <string>
#include <iosfwd>
 
#include "OTBCommonExport.h"
 
namespace otb
{
 
class OTBCommon_EXPORT Stopwatch final
{
public:
  using Self = Stopwatch;
 
  using DurationType = std::uint64_t;
 
  Stopwatch();
 
  void Start();
 
  void Stop();
 
  void Reset();
 
  void Restart();
 
  DurationType GetElapsedMilliseconds() const;
 
  void GetElapsedHumanReadableTime(std::ostream& oss) const;
 
  std::string GetElapsedHumanReadableTime() const;
 
  bool IsRunning() const;
 
  static Stopwatch StartNew();
 
private:
  using TimepointType = std::uint64_t;
 
  TimepointType GetTimestamp() const;
  DurationType  GetRunningElapsedTime() const;
 
  TimepointType m_StartTime;
  DurationType  m_ElapsedMilliseconds;
  bool          m_IsRunning;
};
 
} // namespace otb
 
#endif