SuccessEnumAc.cpp

Go to the documentation of this file.

// ======================================================================
// \title  SuccessEnumAc.cpp
// \author Generated by fpp-to-cpp
// \brief  cpp file for Success enum
// ======================================================================

#include <cstring>
#include <limits>

#include "Fw/Types/Assert.hpp"
#include "Fw/Types/SuccessEnumAc.hpp"

namespace Fw {

  // ----------------------------------------------------------------------
  // Operators
  // ----------------------------------------------------------------------

  Success& Success ::
    operator=(const Success& obj)
  {
    this->e = obj.e;
    return *this;
  }

  Success& Success ::
    operator=(T e1)
  {
    this->e = e1;
    return *this;
  }

#ifdef BUILD_UT

  std::ostream& operator<<(std::ostream& os, const Success& obj) {
    Fw::String s;
    obj.toString(s);
    os << s;
    return os;
  }

#endif

  // ----------------------------------------------------------------------
  // Member functions
  // ----------------------------------------------------------------------

  bool Success ::
    isValid() const
  {
    return ((e >= FAILURE) && (e <= SUCCESS));
  }

  Fw::SerializeStatus Success ::
    serializeTo(
        Fw::SerialBufferBase& buffer,
        Fw::Endianness mode
    ) const
  {
    const Fw::SerializeStatus status = buffer.serializeFrom(
        static_cast<SerialType>(this->e),
        mode
    );
    return status;
  }

  Fw::SerializeStatus Success ::
    deserializeFrom(
        Fw::SerialBufferBase& buffer,
        Fw::Endianness mode
    )
  {
    SerialType es;
    Fw::SerializeStatus status = buffer.deserializeTo(es, mode);
    if (status == Fw::FW_SERIALIZE_OK) {
      this->e = static_cast<T>(es);
      if (!this->isValid()) {
        status = Fw::FW_DESERIALIZE_FORMAT_ERROR;
      }
    }
    return status;
  }

#if FW_SERIALIZABLE_TO_STRING

  void Success ::
    toString(Fw::StringBase& sb) const
  {
    Fw::String s;
    switch (e) {
      case FAILURE:
        s = "FAILURE";
        break;
      case SUCCESS:
        s = "SUCCESS";
        break;
      default:
        s = "[invalid]";
        break;
    }
    sb.format("%s (%" PRIu8 ")", s.toChar(), e);
  }

#elif FW_ENABLE_TEXT_LOGGING

  void Success ::
    toString(Fw::StringBase& sb) const
  {
    sb.format("%" PRIu8 "", e);
  }

#endif

}