File nebula_status.hpp

File List > include > nebula_common > nebula_status.hpp

Go to the documentation of this file

// Copyright 2024 TIER IV, Inc.
//
// 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.

#ifndef NEBULA_STATUS_HPP
#define NEBULA_STATUS_HPP

#include <ostream>

namespace nebula
{
// from https://marycore.jp/prog/cpp/extends-enum/

struct Status
{
  enum Type {
    OK = 0,
    UDP_CONNECTION_ERROR,
    CAN_CONNECTION_ERROR,
    SENSOR_CONFIG_ERROR,
    INVALID_SENSOR_MODEL,
    INVALID_ECHO_MODE,
    NOT_IMPLEMENTED,
    NOT_INITIALIZED,
    INVALID_CALIBRATION_FILE,
    CANNOT_SAVE_FILE,
    HTTP_CONNECTION_ERROR,
    WAITING_FOR_SENSOR_RESPONSE,
    ERROR_1,
    Type_end_of_Status = ERROR_1
  } _type;
  Status() : _type(Type::OK) {}
  /* NOLINT(runtime/explicit) */ Status(Type v) : _type(v) {}
  explicit Status(int type) : _type(static_cast<Type>(type)) {}
  Type type() const { return _type; }
  friend bool operator==(const Status & L, const Status & R) { return L.type() == R.type(); }
  friend bool operator!=(const Status & L, const Status & R) { return L.type() != R.type(); }

  friend std::ostream & operator<<(std::ostream & os, nebula::Status const & arg)
  {
    switch (arg.type()) {
      case Status::OK:
        os << "OK";
        break;
      case Status::UDP_CONNECTION_ERROR:
        os << "Udp Connection Error";
        break;
      case Status::SENSOR_CONFIG_ERROR:
        os << "Could not set SensorConfiguration";
        break;
      case Status::INVALID_SENSOR_MODEL:
        os << "Invalid sensor model provided";
        break;
      case Status::INVALID_ECHO_MODE:
        os << "Invalid echo model provided";
        break;
      case Status::NOT_IMPLEMENTED:
        os << "Not Implemented";
        break;
      case Status::NOT_INITIALIZED:
        os << "Not Initialized";
        break;
      case Status::INVALID_CALIBRATION_FILE:
        os << "Invalid Calibration File";
        break;
      case Status::CANNOT_SAVE_FILE:
        os << "Cannot Save File";
        break;
      case Status::HTTP_CONNECTION_ERROR:
        os << "Http Connection Error";
        break;
      case Status::WAITING_FOR_SENSOR_RESPONSE:
        os << "Waiting for Sensor Response";
        break;
      case Status::ERROR_1:
      default:
        os << "Generic Error";
    }
    return os;
  }
};

}  // namespace nebula
#endif  // NEBULA_STATUS_HPP