Rate.hpp

Go to the documentation of this file.

/**********************************************************************
 * Software License Agreement (BSD License)
 *
 * Copyright (c) 2018, Remo Diethelm
 * 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 Robotic Systems Lab nor ETH Zurich
 *     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 THE COPYRIGHT HOLDERS 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 THE
 *  COPYRIGHT OWNER OR 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.
 */

#pragma once

// std
#include <ctime>

// any worker
#include "bota_worker/RateOptions.hpp"

namespace bota_worker
{
class Rate
{
protected:
  static constexpr long int N_SEC_PER_SEC = static_cast<long int>(1e9);
  static constexpr double SEC_PER_N_SEC = 1.0 / N_SEC_PER_SEC;

  RateOptions options_{};

  timespec sleepStartTime_{};
  timespec sleepEndTime_{};
  timespec stepTime_{};
  unsigned int numTimeSteps_ = 0;
  unsigned int numWarnings_ = 0;
  unsigned int numErrors_ = 0;
  timespec lastWarningPrintTime_{};
  timespec lastErrorPrintTime_{};
  double awakeTime_ = 0.0;
  double awakeTimeMean_ = 0.0;
  double awakeTimeM2_ = 0.0;

public:
  Rate(const std::string& name, const double timeStep);

  explicit Rate(RateOptions options);

  Rate(Rate&& other) noexcept;

  RateOptions& getOptions()
  {
    return options_;
  }

  const RateOptions& getOptions() const
  {
    return options_;
  }

  void reset();

  void sleep();

  const timespec& getSleepStartTime() const
  {
    return sleepStartTime_;
  }

  const timespec& getSleepEndTime() const
  {
    return sleepEndTime_;
  }

  const timespec& getStepTime() const
  {
    return stepTime_;
  }

  unsigned int getNumTimeSteps() const
  {
    return numTimeSteps_;
  }

  unsigned int getNumWarnings() const
  {
    return numWarnings_;
  }

  unsigned int getNumErrors() const
  {
    return numErrors_;
  }

  double getAwakeTime() const;

  double getAwakeTimeMean() const;

  double getAwakeTimeVar() const;

  double getAwakeTimeStdDev() const;

  static double getDuration(const timespec& start, const timespec& end);  // NOLINT(readability-identifier-naming)

  static void addDuration(timespec& time, const double duration);  // NOLINT(readability-identifier-naming)
};

}  // namespace bota_worker