DeserialStatusEnumAc.cpp

Go to the documentation of this file.

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

#include <cstring>
#include <limits>

#include "Fw/Types/DeserialStatusEnumAc.hpp"

namespace Fw {

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

  DeserialStatus& DeserialStatus ::
    operator=(const DeserialStatus& obj)
  {
    this->e = obj.e;
#ifdef BUILD_UT
    this->m_serializeValueIsSet = obj.m_serializeValueIsSet;
    this->m_serializeValue = obj.m_serializeValue;
#endif
    return *this;
  }

  DeserialStatus& DeserialStatus ::
    operator=(enum T e1)
  {
    FW_ASSERT(isValid(e1), static_cast<FwAssertArgType>(e1));
    this->e = e1;
#ifdef BUILD_UT
    this->m_serializeValueIsSet = false;
    this->m_serializeValue = 0;
#endif
    return *this;
  }

#ifdef BUILD_UT

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

#endif

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

  bool DeserialStatus ::
    isValid() const
  {
    return DeserialStatus::isValid(this->e);
  }

  Fw::SerializeStatus DeserialStatus ::
    serializeTo(
        Fw::SerialBufferBase& buffer,
        Fw::Endianness mode
    ) const
  {
    SerialType es = static_cast<SerialType>(this->e);
#ifdef BUILD_UT
    // Unit testing only: On request, override the enum value
    // with the numeric value, which is allowed to be invalid
    if (this->m_serializeValueIsSet) {
      es = this->m_serializeValue;
    }
#endif
    const Fw::SerializeStatus status = buffer.serializeFrom(es, mode);
    return status;
  }

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

#if FW_SERIALIZABLE_TO_STRING

  void DeserialStatus ::
    toString(Fw::StringBase& sb) const
  {
    Fw::String s;
    switch (e) {
      case OK:
        s = "OK";
        break;
      case BUFFER_EMPTY:
        s = "BUFFER_EMPTY";
        break;
      case FORMAT_ERROR:
        s = "FORMAT_ERROR";
        break;
      case SIZE_MISMATCH:
        s = "SIZE_MISMATCH";
        break;
      case TYPE_MISMATCH:
        s = "TYPE_MISMATCH";
        break;
      default:
        s = "[invalid]";
        break;
    }
    sb.format("%s (%" PRIu8 ")", s.toChar(), e);
  }

#endif

#ifdef BUILD_UT

  void DeserialStatus ::
    setSerializeValue(SerialType serializeValue)
  {
    this->m_serializeValue = serializeValue;
    this->m_serializeValueIsSet = true;
  }

#endif

  // ----------------------------------------------------------------------
  // Static functions
  // ----------------------------------------------------------------------

  bool DeserialStatus ::
    isValid(SerialType serialTypeValue)
  {
    return (serialTypeValue == OK)
      || ((serialTypeValue >= BUFFER_EMPTY) && (serialTypeValue <= TYPE_MISMATCH));
  }

}