PacketConfigEntrySerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_PacketConfigEntrySerializableAc_HPP
#define Svc_PacketConfigEntrySerializableAc_HPP

#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/ExternalString.hpp"
#include "Fw/Types/Serializable.hpp"
#include "Fw/Types/String.hpp"
#include "Svc/TlmPacketizer/PacketOverrideConfigSerializableAc.hpp"
#include "Svc/TlmPacketizer/config/TlmPacketizerConfig/TelemetrySectionEnumAc.hpp"

namespace Svc {

  class PacketConfigEntry :
    public Fw::Serializable
  {

    public:

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

      enum {
        SERIALIZED_SIZE =
          sizeof(U32) +
          Svc::TelemetrySection::SERIALIZED_SIZE +
          Svc::PacketOverrideConfig::SERIALIZED_SIZE
      };

    public:

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

      PacketConfigEntry();

      PacketConfigEntry(
          U32 packetId,
          Svc::TelemetrySection::T section,
          const Svc::PacketOverrideConfig& override
      );

      PacketConfigEntry(
          const PacketConfigEntry& obj 
      );

    public:

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

      PacketConfigEntry& operator=(
          const PacketConfigEntry& obj 
      );

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

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

#ifdef BUILD_UT

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

      U32 get_packetId() const
      {
        return this->m_packetId;
      }

      Svc::TelemetrySection::T get_section() const
      {
        return this->m_section.e;
      }

      Svc::PacketOverrideConfig& get_override()
      {
        return this->m_override;
      }

      const Svc::PacketOverrideConfig& get_override() const
      {
        return this->m_override;
      }

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

      void set(
          U32 packetId,
          Svc::TelemetrySection::T section,
          const Svc::PacketOverrideConfig& override
      );

      void set_packetId(U32 packetId);

      void set_section(Svc::TelemetrySection::T section);

      void set_override(const Svc::PacketOverrideConfig& override);

    protected:

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

      U32 m_packetId;
      Svc::TelemetrySection m_section;
      Svc::PacketOverrideConfig m_override;

  };

}

#endif