CompressionMetadataSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_CompressionMetadataSerializableAc_HPP
#define Svc_CompressionMetadataSerializableAc_HPP

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

namespace Svc {

  class CompressionMetadata :
    public Fw::Serializable
  {

    public:

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

      enum {
        SERIALIZED_SIZE =
          Svc::CompressionAlgorithm::SERIALIZED_SIZE
      };

    public:

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

      CompressionMetadata();

      CompressionMetadata(Svc::CompressionAlgorithm::T algorithm);

      CompressionMetadata(
          const CompressionMetadata& obj 
      );

    public:

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

      CompressionMetadata& operator=(
          const CompressionMetadata& obj 
      );

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

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

#ifdef BUILD_UT

      friend std::ostream& operator<<(
          std::ostream& os, 
          const CompressionMetadata& 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::CompressionAlgorithm::T get_algorithm() const
      {
        return this->m_algorithm.e;
      }

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

      void set(Svc::CompressionAlgorithm::T algorithm);

      void set_algorithm(Svc::CompressionAlgorithm::T algorithm);

    protected:

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

      Svc::CompressionAlgorithm m_algorithm;

  };

}

#endif