SeqArgsSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_SeqArgsSerializableAc_HPP
#define Svc_SeqArgsSerializableAc_HPP

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

namespace Svc {

  class SeqArgs :
    public Fw::Serializable
  {

    public:

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

      using Type_of_buffer = U8[255];

    public:

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

      enum {
        SERIALIZED_SIZE =
          sizeof(FwSizeType) +
          sizeof(U8) * 255
      };

    public:

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

      SeqArgs();

      SeqArgs(
          FwSizeType size,
          const Type_of_buffer& buffer
      );

      SeqArgs(
          const SeqArgs& obj 
      );

      SeqArgs(
          FwSizeType size,
          U8 buffer
      );

    public:

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

      SeqArgs& operator=(
          const SeqArgs& obj 
      );

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

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

#ifdef BUILD_UT

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

      FwSizeType get_size() const
      {
        return this->m_size;
      }

      Type_of_buffer& get_buffer()
      {
        return this->m_buffer;
      }

      const Type_of_buffer& get_buffer() const
      {
        return this->m_buffer;
      }

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

      void set(
          FwSizeType size,
          const Type_of_buffer& buffer
      );

      void set_size(FwSizeType size);

      void set_buffer(const Type_of_buffer& buffer);

    protected:

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

      FwSizeType m_size;
      U8 m_buffer[255];

  };

}

#endif