fpp/compiler/tools/fpp-to-cpp/test/array/S1SerializableAc.ref.hpp

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

#ifndef M_S1SerializableAc_HPP
#define M_S1SerializableAc_HPP

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

namespace M {

  class S1 :
    public Fw::Serializable
  {

    public:

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

      enum {
        //! The size of the serial representation
        SERIALIZED_SIZE =
          sizeof(F32) +
          sizeof(F64) +
          sizeof(I16) +
          sizeof(I32) +
          sizeof(I64) +
          sizeof(I8) +
          sizeof(U16) +
          sizeof(U32) +
          sizeof(U64) +
          sizeof(U8) +
          sizeof(U8) +
          Fw::StringBase::STATIC_SERIALIZED_SIZE(80)
      };

    public:

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

      //! Constructor (default value)
      S1();

      //! Member constructor
      S1(
          F32 mF32,
          F64 mF64,
          I16 mI16,
          I32 mI32,
          I64 mI64,
          I8 mI8,
          U16 mU16,
          U32 mU32,
          U64 mU64,
          U8 mU8,
          bool mBool,
          const Fw::StringBase& mString
      );

      //! Copy constructor
      S1(
          const S1& obj //!< The source object
      );

    public:

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

      //! Copy assignment operator
      S1& operator=(
          const S1& obj //!< The source object
      );

      //! Equality operator
      bool operator==(
          const S1& obj //!< The other object
      ) const;

      //! Inequality operator
      bool operator!=(
          const S1& obj //!< The other object
      ) const;

#ifdef BUILD_UT

      //! Ostream operator
      friend std::ostream& operator<<(
          std::ostream& os, //!< The ostream
          const S1& obj //!< The object
      );

#endif

    public:

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

      //! Serialization
      Fw::SerializeStatus serializeTo(
          Fw::LinearBufferBase& buffer, //!< The serial buffer
          Fw::Endianness mode = Fw::Endianness::BIG //!< Endianness of serialized buffer
      ) const;

      //! Deserialization
      Fw::SerializeStatus deserializeFrom(
          Fw::LinearBufferBase& buffer, //!< The serial buffer
          Fw::Endianness mode = Fw::Endianness::BIG //!< Endianness of serialized buffer
      );

      //! Get the dynamic serialized size of the struct
      FwSizeType serializedSize() const;

#if FW_SERIALIZABLE_TO_STRING

      //! Convert struct to string
      void toString(
          Fw::StringBase& sb //!< The StringBase object to hold the result
      ) const;

#endif

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

      //! Get member mF32
      F32 get_mF32() const
      {
        return this->m_mF32;
      }

      //! Get member mF64
      F64 get_mF64() const
      {
        return this->m_mF64;
      }

      //! Get member mI16
      I16 get_mI16() const
      {
        return this->m_mI16;
      }

      //! Get member mI32
      I32 get_mI32() const
      {
        return this->m_mI32;
      }

      //! Get member mI64
      I64 get_mI64() const
      {
        return this->m_mI64;
      }

      //! Get member mI8
      I8 get_mI8() const
      {
        return this->m_mI8;
      }

      //! Get member mU16
      U16 get_mU16() const
      {
        return this->m_mU16;
      }

      //! Get member mU32
      U32 get_mU32() const
      {
        return this->m_mU32;
      }

      //! Get member mU64
      U64 get_mU64() const
      {
        return this->m_mU64;
      }

      //! Get member mU8
      U8 get_mU8() const
      {
        return this->m_mU8;
      }

      //! Get member mBool
      bool get_mBool() const
      {
        return this->m_mBool;
      }

      //! Get member mString
      Fw::ExternalString& get_mString()
      {
        return this->m_mString;
      }

      //! Get member mString (const)
      const Fw::ExternalString& get_mString() const
      {
        return this->m_mString;
      }

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

      //! Set all members
      void set(
          F32 mF32,
          F64 mF64,
          I16 mI16,
          I32 mI32,
          I64 mI64,
          I8 mI8,
          U16 mU16,
          U32 mU32,
          U64 mU64,
          U8 mU8,
          bool mBool,
          const Fw::StringBase& mString
      );

      //! Set member mF32
      void set_mF32(F32 mF32);

      //! Set member mF64
      void set_mF64(F64 mF64);

      //! Set member mI16
      void set_mI16(I16 mI16);

      //! Set member mI32
      void set_mI32(I32 mI32);

      //! Set member mI64
      void set_mI64(I64 mI64);

      //! Set member mI8
      void set_mI8(I8 mI8);

      //! Set member mU16
      void set_mU16(U16 mU16);

      //! Set member mU32
      void set_mU32(U32 mU32);

      //! Set member mU64
      void set_mU64(U64 mU64);

      //! Set member mU8
      void set_mU8(U8 mU8);

      //! Set member mBool
      void set_mBool(bool mBool);

      //! Set member mString
      void set_mString(const Fw::StringBase& mString);

    protected:

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

      F32 m_mF32;
      F64 m_mF64;
      I16 m_mI16;
      I32 m_mI32;
      I64 m_mI64;
      I8 m_mI8;
      U16 m_mU16;
      U32 m_mU32;
      U64 m_mU64;
      U8 m_mU8;
      bool m_mBool;
      char m___fprime_ac_mString_buffer[Fw::StringBase::BUFFER_SIZE(80)];
      Fw::ExternalString m_mString;

  };

}

#endif