FrameTrailerSerializableAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  FrameTrailerSerializableAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for FrameTrailer struct
// ======================================================================

#ifndef Svc_FprimeProtocol_FrameTrailerSerializableAc_HPP
#define Svc_FprimeProtocol_FrameTrailerSerializableAc_HPP

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

namespace Svc {

  namespace FprimeProtocol {

    class FrameTrailer :
      public Fw::Serializable
    {

      public:

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

        enum {
          SERIALIZED_SIZE =
            sizeof(U32)
        };

      public:

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

        FrameTrailer();

        FrameTrailer(U32 crcField);

        FrameTrailer(
            const FrameTrailer& obj 
        );

      public:

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

        FrameTrailer& operator=(
            const FrameTrailer& obj 
        );

        bool operator==(
            const FrameTrailer& obj 
        ) const;

        bool operator!=(
            const FrameTrailer& obj 
        ) const;

#ifdef BUILD_UT

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

#endif

      public:

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

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

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

        FwSizeType serializedSize() const;

#if FW_SERIALIZABLE_TO_STRING

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

#endif

        // ----------------------------------------------------------------------
        // Getter functions
        // ----------------------------------------------------------------------

        U32 get_crcField() const
        {
          return this->m_crcField;
        }

        // ----------------------------------------------------------------------
        // Setter functions
        // ----------------------------------------------------------------------

        void set(U32 crcField);

        void set_crcField(U32 crcField);

      protected:

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

        U32 m_crcField;

    };

  }

}

#endif