FrameErrorEnumAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_Ccsds_FrameErrorEnumAc_HPP
#define Svc_Ccsds_FrameErrorEnumAc_HPP

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

namespace Svc {

  namespace Ccsds {

    class FrameError :
      public Fw::Serializable
    {

      public:

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

        using SerialType = U8;

        enum T {
          SP_INVALID_PACKET = 0,
          SP_INVALID_LENGTH = 1,
          TC_INVALID_SCID = 2,
          TC_INVALID_LENGTH = 3,
          TC_INVALID_VCID = 4,
          TC_INVALID_CRC = 5,
          AOS_INVALID_SCID = 6,
          AOS_INVALID_LENGTH = 7,
          AOS_INVALID_VCID = 8,
          AOS_INVALID_CRC = 9,
          AOS_INVALID_VERSION = 10,
          AOS_INVALID_EPP = 11,
          AOS_VC_FRAME_COUNT_GAP = 12,
          SDLS_DECRYPTION_FAILURE = 13,
        };

        using t = enum T;

      public:

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

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

      public:

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

        FrameError()
        {
          this->e = SP_INVALID_PACKET;
        }

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

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

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

      public:

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

        FrameError& operator=(
            const FrameError& obj 
        );

        FrameError& operator=(
            SerialType e1 
        );

        FrameError& 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 FrameError& 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