RateOptions.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 <atomic>
#include <cmath>
#include <string>

namespace bota_worker
{
struct RateOptions
{
  std::string name_{};
  std::atomic<double> timeStep_{ 0.0 };
  std::atomic<double> maxTimeStepFactorWarning_{ 1.0 };
  std::atomic<double> maxTimeStepFactorError_{ 10.0 };
  std::atomic<bool> enforceRate_{ true };
  std::atomic<clockid_t> clockId_{ CLOCK_MONOTONIC };

  explicit RateOptions(std::string name = "", const double timeStep = 0.0, const double maxTimeStepFactorWarning = 1.0,
                       const double maxTimeStepFactorError = 10.0, const bool enforceRate = true,
                       const clockid_t clockId = CLOCK_MONOTONIC)
    : name_(std::move(name))
    , timeStep_(timeStep)
    , maxTimeStepFactorWarning_(maxTimeStepFactorWarning)
    , maxTimeStepFactorError_(maxTimeStepFactorError)
    , enforceRate_(enforceRate)
    , clockId_(clockId)
  {
  }

  RateOptions(const RateOptions& other)
  {
    *this = other;
  }

  RateOptions(RateOptions&& other) noexcept
    : name_(std::move(other.name_))
    , timeStep_(other.timeStep_.load())
    , maxTimeStepFactorWarning_(other.maxTimeStepFactorWarning_.load())
    , maxTimeStepFactorError_(other.maxTimeStepFactorError_.load())
    , enforceRate_(other.enforceRate_.load())
    , clockId_(other.clockId_.load())
  {
  }

  RateOptions& operator=(const RateOptions& other)
  {
    name_ = other.name_;
    timeStep_ = other.timeStep_.load();
    maxTimeStepFactorWarning_ = other.maxTimeStepFactorWarning_.load();
    maxTimeStepFactorError_ = other.maxTimeStepFactorError_.load();
    enforceRate_ = other.enforceRate_.load();
    clockId_ = other.clockId_.load();
    return *this;
  }

  virtual ~RateOptions() = default;

  virtual bool isValid() const
  {
    return (timeStep_ >= 0.0 && !std::isinf(timeStep_) && !std::isnan(timeStep_) && maxTimeStepFactorWarning_ >= 0.0 &&
            !std::isnan(maxTimeStepFactorWarning_) && maxTimeStepFactorError_ >= 0.0 &&
            !std::isnan(maxTimeStepFactorError_));
  }
};

}  // namespace bota_worker