gz/common/Timer.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 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 IGNITION_COMMON_TIMER_HH_
#define IGNITION_COMMON_TIMER_HH_
 
#include <gz/common/config.hh>
#include <gz/common/Time.hh>
#include <gz/common/Export.hh>
 
namespace ignition
{
  namespace common
  {
    class IGNITION_COMMON_VISIBLE Timer
    {
      public: Timer();
 
      public: virtual ~Timer();
 
      public: virtual void Start();
 
      public: virtual void Stop();
 
      public: bool Running() const;
 
      public: Time IGN_DEPRECATED(4) Elapsed() const;
 
      public: std::chrono::duration<double> ElapsedTime() const;
 
      public: friend std::ostream &operator<<(std::ostream &out,
                                              const ignition::common::Timer &t)
              {
                out << t.ElapsedTime().count();
                return out;
              }
 
      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::chrono::steady_clock::time_point start;
 
      private: std::chrono::steady_clock::time_point stop;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
 
      private: bool running;
    };
  }
}
#endif