StatusEnumAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  StatusEnumAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for Status enum
// ======================================================================

#ifndef Svc_Ccsds_Cfdp_StatusEnumAc_HPP
#define Svc_Ccsds_Cfdp_StatusEnumAc_HPP

#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/Assert.hpp"
#include "Fw/Types/Serializable.hpp"
#include "Fw/Types/String.hpp"

namespace Svc {

  namespace Ccsds {

    namespace Cfdp {

      class Status :
        public Fw::Serializable
      {

        public:

          // ----------------------------------------------------------------------
          // Types
          // ----------------------------------------------------------------------

          using SerialType = I32;

          enum T {
            SUCCESS = 0,
            ERROR = 1,
            PDU_METADATA_ERROR = 2,
            SHORT_PDU_ERROR = 3,
            REC_PDU_FSIZE_MISMATCH_ERROR = 4,
            REC_PDU_BAD_EOF_ERROR = 5,
            SEND_PDU_NO_BUF_AVAIL_ERROR = 6,
          };

          using t = enum T;

        public:

          // ----------------------------------------------------------------------
          // Constants
          // ----------------------------------------------------------------------

          enum {
            SERIALIZED_SIZE = sizeof(SerialType),
            NUM_CONSTANTS = 7,
          };

        public:

          // ----------------------------------------------------------------------
          // Constructors
          // ----------------------------------------------------------------------

          Status()
          {
            this->e = SUCCESS;
          }

          Status(
              const enum T e1 
          )
          {
            FW_ASSERT(isValid(e1), static_cast<FwAssertArgType>(e1));
            this->e = e1;
          }

          Status(
              const SerialType e1 
          )
          {
            FW_ASSERT(isValid(e1), static_cast<FwAssertArgType>(e1));
            this->e = static_cast<enum T>(e1);
          }

          Status(
              const Status& obj 
          )
          {
            this->e = obj.e;
#ifdef BUILD_UT
          this->m_serializeValueIsSet = obj.m_serializeValueIsSet;
          this->m_serializeValue = obj.m_serializeValue;
#endif
          }

        public:

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

          Status& operator=(
              const Status& obj 
          );

          Status& operator=(
              SerialType e1 
          );

          Status& operator=(
              enum T e1 
          );

          operator enum T() const
          {
            return this->e;
          }

          bool operator==(enum T e1) const
          {
            return this->e == e1;
          }

          bool operator!=(enum T e1) const
          {
            return !(*this == e1);
          }

#ifdef BUILD_UT

          friend std::ostream& operator<<(
              std::ostream& os, 
              const Status& obj 
          );

#endif

        public:

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

          bool isValid() const;

          Fw::SerializeStatus serializeTo(
              Fw::SerialBufferBase& buffer, 
              Fw::Endianness mode = Fw::Endianness::BIG 
          ) const;

          Fw::SerializeStatus deserializeFrom(
              Fw::SerialBufferBase& buffer, 
              Fw::Endianness mode = Fw::Endianness::BIG 
          );

#if FW_SERIALIZABLE_TO_STRING

          void toString(
              Fw::StringBase& sb 
          ) const;

#endif

#ifdef BUILD_UT

          void setSerializeValue(
              SerialType serializeValue 
          );

#endif

        public:

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

          static bool isValid(
              SerialType serialTypeValue 
          );

        public:

          // ----------------------------------------------------------------------
          // Public member variables
          // ----------------------------------------------------------------------

          enum T e;

        private:

          // ----------------------------------------------------------------------
          // Private member variables
          // ----------------------------------------------------------------------

#ifdef BUILD_UT

          bool m_serializeValueIsSet = false;

          SerialType m_serializeValue = 0;

#endif

      };

    }

  }

}

#endif