HeaderSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_Fpy_HeaderSerializableAc_HPP
#define Svc_Fpy_HeaderSerializableAc_HPP

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

namespace Svc {

  namespace Fpy {

    class Header :
      public Fw::Serializable
    {

      public:

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

        enum {
          SERIALIZED_SIZE =
            sizeof(U8) +
            sizeof(U8) +
            sizeof(U8) +
            sizeof(U8) +
            sizeof(U8) +
            sizeof(U16) +
            sizeof(U32)
        };

      public:

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

        Header();

        Header(
            U8 majorVersion,
            U8 minorVersion,
            U8 patchVersion,
            U8 schemaVersion,
            U8 argumentCount,
            U16 statementCount,
            U32 bodySize
        );

        Header(
            const Header& obj 
        );

      public:

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

        Header& operator=(
            const Header& obj 
        );

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

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

#ifdef BUILD_UT

        friend std::ostream& operator<<(
            std::ostream& os, 
            const Header& 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
        // ----------------------------------------------------------------------

        U8 get_majorVersion() const
        {
          return this->m_majorVersion;
        }

        U8 get_minorVersion() const
        {
          return this->m_minorVersion;
        }

        U8 get_patchVersion() const
        {
          return this->m_patchVersion;
        }

        U8 get_schemaVersion() const
        {
          return this->m_schemaVersion;
        }

        U8 get_argumentCount() const
        {
          return this->m_argumentCount;
        }

        U16 get_statementCount() const
        {
          return this->m_statementCount;
        }

        U32 get_bodySize() const
        {
          return this->m_bodySize;
        }

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

        void set(
            U8 majorVersion,
            U8 minorVersion,
            U8 patchVersion,
            U8 schemaVersion,
            U8 argumentCount,
            U16 statementCount,
            U32 bodySize
        );

        void set_majorVersion(U8 majorVersion);

        void set_minorVersion(U8 minorVersion);

        void set_patchVersion(U8 patchVersion);

        void set_schemaVersion(U8 schemaVersion);

        void set_argumentCount(U8 argumentCount);

        void set_statementCount(U16 statementCount);

        void set_bodySize(U32 bodySize);

      protected:

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

        U8 m_majorVersion;
        U8 m_minorVersion;
        U8 m_patchVersion;
        U8 m_schemaVersion;
        U8 m_argumentCount;
        U16 m_statementCount;
        U32 m_bodySize;

    };

  }

}

#endif