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/Serializable.hpp"
#include "Fw/Types/String.hpp"

namespace Svc {

  namespace Ccsds {

    class FrameError :
      public Fw::Serializable
    {

      public:

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

        typedef U8 SerialType;

        enum T {
          SP_INVALID_LENGTH = 0,
          TC_INVALID_SCID = 1,
          TC_INVALID_LENGTH = 2,
          TC_INVALID_VCID = 3,
          TC_INVALID_CRC = 4,
        };

        typedef T t;

      public:

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

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

      public:

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

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

        FrameError(
            const T e1 
        )
        {
          this->e = e1;
        }

        FrameError(
            const FrameError& obj 
        )
        {
          this->e = obj.e;
        }

      public:

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

        FrameError& operator=(
            const FrameError& obj 
        );

        FrameError& operator=(
            T e1 
        );

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

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

        bool operator!=(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

      public:

        // ----------------------------------------------------------------------
        // Member variables
        // ----------------------------------------------------------------------

        T e;

    };

  }

}

#endif