ApidEnumAc.cpp

Go to the documentation of this file.

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

#include <cstring>
#include <limits>

#include "default/config/ApidEnumAc.hpp"

namespace ComCfg {

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

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

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

  Apid& Apid ::
    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 Apid& obj) {
    Fw::String s;
    obj.toString(s);
    os << s;
    return os;
  }

#endif

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

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

  Fw::SerializeStatus Apid ::
    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 Apid ::
    deserializeFrom(
        Fw::SerialBufferBase& buffer,
        Fw::Endianness mode
    )
  {
    SerialType es;
    Fw::SerializeStatus status = buffer.deserializeTo(es, mode);
    if ((status == Fw::FW_SERIALIZE_OK) && !Apid::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 Apid ::
    toString(Fw::StringBase& sb) const
  {
    Fw::String s;
    switch (e) {
      case FW_PACKET_COMMAND:
        s = "FW_PACKET_COMMAND";
        break;
      case FW_PACKET_TELEM:
        s = "FW_PACKET_TELEM";
        break;
      case FW_PACKET_LOG:
        s = "FW_PACKET_LOG";
        break;
      case FW_PACKET_FILE:
        s = "FW_PACKET_FILE";
        break;
      case FW_PACKET_PACKETIZED_TLM:
        s = "FW_PACKET_PACKETIZED_TLM";
        break;
      case FW_PACKET_DP:
        s = "FW_PACKET_DP";
        break;
      case FW_PACKET_IDLE:
        s = "FW_PACKET_IDLE";
        break;
      case FW_PACKET_PARAM:
        s = "FW_PACKET_PARAM";
        break;
      case FW_PACKET_HAND:
        s = "FW_PACKET_HAND";
        break;
      case FW_PACKET_UNKNOWN:
        s = "FW_PACKET_UNKNOWN";
        break;
      case SPP_IDLE_PACKET:
        s = "SPP_IDLE_PACKET";
        break;
      case INVALID_UNINITIALIZED:
        s = "INVALID_UNINITIALIZED";
        break;
      default:
        s = "[invalid]";
        break;
    }
    sb.format("%s (%" PRIu16 ")", s.toChar(), e);
  }

#endif

#ifdef BUILD_UT

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

#endif

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

  bool Apid ::
    isValid(SerialType serialTypeValue)
  {
    return (serialTypeValue <= FW_PACKET_PARAM)
      || ((serialTypeValue >= FW_PACKET_HAND) && (serialTypeValue <= FW_PACKET_UNKNOWN))
      || ((serialTypeValue >= SPP_IDLE_PACKET) && (serialTypeValue <= INVALID_UNINITIALIZED));
  }

}