model.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_MODEL_HPP_
#define CLOE_MODEL_HPP_

#include <cloe/core.hpp>    // for Duration, Error, Confable
#include <cloe/entity.hpp>  // for Entity

namespace cloe {

// Forward declaration:
class Sync;       // from cloe/sync.hpp
class Registrar;  // from cloe/registrar.hpp

class ModelError : public Error {
 public:
  using Error::Error;
  virtual ~ModelError() noexcept = default;

  const std::string& explanation() const { return Error::explanation(); }

  ModelError explanation(const std::string& explanation) && {
    this->set_explanation(explanation);
    return std::move(*this);
  }

  template <typename... Args>
  ModelError explanation(const char* format, const Args&... args) && {
    this->set_explanation(fmt::format(format, args...));
    return std::move(*this);
  }
};

class ModelAbort : public ModelError {
 public:
  using ModelError::ModelError;
  virtual ~ModelAbort() noexcept = default;

  const std::string& explanation() const { return Error::explanation(); }

  ModelError explanation(const std::string& explanation) && {
    this->set_explanation(explanation);
    return std::move(*this);
  }

  template <typename... Args>
  ModelError explanation(const char* format, const Args&... args) && {
    this->set_explanation(fmt::format(format, args...));
    return std::move(*this);
  }
};

class ModelReset : public ModelError {
 public:
  using ModelError::ModelError;
  virtual ~ModelReset() noexcept = default;

  const std::string& explanation() const { return Error::explanation(); }

  ModelError explanation(const std::string& explanation) && {
    this->set_explanation(explanation);
    return std::move(*this);
  }

  template <typename... Args>
  ModelError explanation(const char* format, const Args&... args) && {
    this->set_explanation(fmt::format(format, args...));
    return std::move(*this);
  }
};

class ModelStop : public ModelError {
 public:
  using ModelError::ModelError;
  virtual ~ModelStop() noexcept = default;

  const std::string& explanation() const { return Error::explanation(); }

  ModelError explanation(const std::string& explanation) && {
    this->set_explanation(explanation);
    return std::move(*this);
  }

  template <typename... Args>
  ModelError explanation(const char* format, const Args&... args) && {
    this->set_explanation(fmt::format(format, args...));
    return std::move(*this);
  }
};

class Model : public Entity {
 public:
  using Entity::Entity;

  virtual ~Model() noexcept = default;

  virtual Duration resolution() const;

  virtual bool is_connected() const { return connected_; }

  virtual bool is_operational() const { return operational_; }

  virtual void connect() { connected_ = true; }

  virtual void disconnect() { connected_ = false; }

  virtual void enroll(Registrar&) {}

  virtual void start(const Sync&) { operational_ = true; }

  virtual Duration process(const Sync&) = 0;

  virtual void pause(const Sync&) {}

  virtual void resume(const Sync&) {}

  virtual void stop(const Sync&) { operational_ = false; }

  virtual void reset() { throw ModelError("reset not supported by this model"); }

  virtual void abort() { throw ModelError("abort not supported by this model"); }

 protected:
  bool connected_{false};
  bool operational_{false};
};

class ModelFactory : public Entity, public Confable {
 public:
  using Entity::Entity;
  virtual ~ModelFactory() = default;
};

}  // namespace cloe

#endif  // CLOE_MODEL_HPP_