RateConfigSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_RateConfigSerializableAc_HPP
#define Svc_RateConfigSerializableAc_HPP

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

namespace Svc {

  class RateConfig :
    public Fw::Serializable
  {

    public:

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

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

    public:

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

      RateConfig();

      RateConfig(
          Svc::RateLogic::T rateLogic,
          U32 min,
          U32 max
      );

      RateConfig(
          const RateConfig& obj 
      );

    public:

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

      RateConfig& operator=(
          const RateConfig& obj 
      );

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

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

#ifdef BUILD_UT

      friend std::ostream& operator<<(
          std::ostream& os, 
          const RateConfig& 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::RateLogic::T get_rateLogic() const
      {
        return this->m_rateLogic.e;
      }

      U32 get_min() const
      {
        return this->m_min;
      }

      U32 get_max() const
      {
        return this->m_max;
      }

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

      void set(
          Svc::RateLogic::T rateLogic,
          U32 min,
          U32 max
      );

      void set_rateLogic(Svc::RateLogic::T rateLogic);

      void set_min(U32 min);

      void set_max(U32 max);

    protected:

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

      Svc::RateLogic m_rateLogic;
      U32 m_min;
      U32 m_max;

  };

}

#endif