FrameHeaderSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_FprimeProtocol_FrameHeaderSerializableAc_HPP
#define Svc_FprimeProtocol_FrameHeaderSerializableAc_HPP

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

namespace Svc {

  namespace FprimeProtocol {

    class FrameHeader :
      public Fw::Serializable
    {

      public:

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

        enum {
          SERIALIZED_SIZE =
            sizeof(Svc::FprimeProtocol::TokenType) +
            sizeof(Svc::FprimeProtocol::TokenType)
        };

      public:

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

        FrameHeader();

        FrameHeader(
            Svc::FprimeProtocol::TokenType startWord,
            Svc::FprimeProtocol::TokenType lengthField
        );

        FrameHeader(
            const FrameHeader& obj 
        );

      public:

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

        FrameHeader& operator=(
            const FrameHeader& obj 
        );

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

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

#ifdef BUILD_UT

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

#endif

      public:

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

        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 
        );

        FwSizeType serializedSize() const;

#if FW_SERIALIZABLE_TO_STRING

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

#endif

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

        Svc::FprimeProtocol::TokenType get_startWord() const
        {
          return this->m_startWord;
        }

        Svc::FprimeProtocol::TokenType get_lengthField() const
        {
          return this->m_lengthField;
        }

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

        void set(
            Svc::FprimeProtocol::TokenType startWord,
            Svc::FprimeProtocol::TokenType lengthField
        );

        void set_startWord(Svc::FprimeProtocol::TokenType startWord);

        void set_lengthField(Svc::FprimeProtocol::TokenType lengthField);

      protected:

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

        Svc::FprimeProtocol::TokenType m_startWord;
        Svc::FprimeProtocol::TokenType m_lengthField;

    };

  }

}

#endif