ComDataContextPairSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_ComDataContextPairSerializableAc_HPP
#define Svc_ComDataContextPairSerializableAc_HPP

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

namespace Svc {

  class ComDataContextPair :
    public Fw::Serializable
  {

    public:

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

      enum {
        SERIALIZED_SIZE =
          Fw::Buffer::SERIALIZED_SIZE +
          ComCfg::FrameContext::SERIALIZED_SIZE
      };

    public:

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

      ComDataContextPair();

      ComDataContextPair(
          const Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

      ComDataContextPair(
          const ComDataContextPair& obj 
      );

    public:

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

      ComDataContextPair& operator=(
          const ComDataContextPair& obj 
      );

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

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

#ifdef BUILD_UT

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

      Fw::Buffer& get_data()
      {
        return this->m_data;
      }

      const Fw::Buffer& get_data() const
      {
        return this->m_data;
      }

      ComCfg::FrameContext& get_context()
      {
        return this->m_context;
      }

      const ComCfg::FrameContext& get_context() const
      {
        return this->m_context;
      }

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

      void set(
          const Fw::Buffer& data,
          const ComCfg::FrameContext& context
      );

      void set_data(const Fw::Buffer& data);

      void set_context(const ComCfg::FrameContext& context);

    protected:

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

      Fw::Buffer m_data;
      ComCfg::FrameContext m_context;

  };

}

#endif