sync.hpp

Go to the documentation of this file.

/*
 * Copyright 2020 Robert Bosch GmbH
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
#ifndef CLOE_SYNC_HPP_
#define CLOE_SYNC_HPP_

#include <cstdint>  // for uint64_t

#include <cloe/core.hpp>  // for Json, Duration

namespace cloe {

class Sync {
 public:
  virtual uint64_t step() const = 0;

  virtual Duration step_width() const = 0;

  virtual Duration time() const = 0;

  virtual Duration eta() const = 0;

  virtual double realtime_factor() const = 0;

  virtual bool is_realtime_factor_unlimited() const { return realtime_factor() < 0.0; }

  virtual double achievable_realtime_factor() const = 0;

  friend void to_json(Json& j, const Sync& s);
};

inline void to_json(Json& j, const Sync& s) {
  j = Json{
      {"step", s.step()},
      {"step_width", s.step_width()},
      {"time", to_convenient_json(s.time())},
      {"realtime_factor", s.realtime_factor()},
      {"achievable_realtime_factor", s.achievable_realtime_factor()},
  };
  if (s.eta().count() == 0) {
    j["eta"] = nullptr;
  } else {
    j["eta"] = to_convenient_json(s.eta());
  }
}

}  // namespace cloe

#endif  // CLOE_SYNC_HPP_