entity.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_ENTITY_HPP_
#define CLOE_ENTITY_HPP_

#include <string>  // for string

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

namespace cloe {

class InvalidNameError : public Error {
 public:
  explicit InvalidNameError(const std::string& name)
      : Error("name is invalid: " + name), name_(name) {}
  virtual ~InvalidNameError() noexcept = default;

  const std::string& name() const { return name_; }

 private:
  std::string name_;
};

class Entity {
 public:
  explicit Entity(const std::string& name) {
    set_name(name);
    set_description("");
  }

  Entity(const std::string& name, const std::string& desc) {
    set_name(name);
    set_description(desc);
  }

  virtual ~Entity() noexcept = default;

  std::string name() const { return name_; }

  void set_name(const std::string& name);

  std::string description() const { return desc_; }

  void set_description(const std::string& desc) { desc_ = desc; }

 protected:
  virtual Logger logger() const { return logger::get(name()); }

  // Note: moving the definition from the inline into this declaration here
  // will result in cloe/trigger.hpp not compiling because:
  //
  //   no matching function for call to 'to_json(Json, const Entity&)'
  //
  // I have no idea why it works in many other instances, but not here. If you,
  // my dear reader, know why, please open a pull request!
  friend void to_json(Json& j, const Entity& e);

 protected:
  std::string name_;
  std::string desc_;
};

inline void to_json(Json& j, const Entity& e) {
  j["name"] = e.name();
  if (!e.desc_.empty()) {
    j["description"] = e.description();
  }
}

}  // namespace cloe

#endif  // CLOE_ENTITY_HPP_