CustomVersionDbSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_CustomVersionDbSerializableAc_HPP
#define Svc_CustomVersionDbSerializableAc_HPP

#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/ExternalString.hpp"
#include "Fw/Types/Serializable.hpp"
#include "Fw/Types/String.hpp"
#include "Svc/Ports/VersionPorts/VersionStatusEnumAc.hpp"
#include "default/config/FwSizeStoreTypeAliasAc.hpp"
#include "default/config/VersionEnumEnumAc.hpp"

namespace Svc {

  class CustomVersionDb :
    public Fw::Serializable
  {

    public:

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

      enum {
        SERIALIZED_SIZE =
          Svc::VersionCfg::VersionEnum::SERIALIZED_SIZE +
          Fw::StringBase::STATIC_SERIALIZED_SIZE(80) +
          Svc::VersionStatus::SERIALIZED_SIZE
      };

    public:

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

      CustomVersionDb();

      CustomVersionDb(
          Svc::VersionCfg::VersionEnum::T version_enum,
          const Fw::StringBase& version_value,
          Svc::VersionStatus::T version_status
      );

      CustomVersionDb(
          const CustomVersionDb& obj 
      );

    public:

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

      CustomVersionDb& operator=(
          const CustomVersionDb& obj 
      );

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

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

#ifdef BUILD_UT

      friend std::ostream& operator<<(
          std::ostream& os, 
          const CustomVersionDb& 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::VersionCfg::VersionEnum::T get_version_enum() const
      {
        return this->m_version_enum.e;
      }

      Fw::ExternalString& get_version_value()
      {
        return this->m_version_value;
      }

      const Fw::ExternalString& get_version_value() const
      {
        return this->m_version_value;
      }

      Svc::VersionStatus::T get_version_status() const
      {
        return this->m_version_status.e;
      }

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

      void set(
          Svc::VersionCfg::VersionEnum::T version_enum,
          const Fw::StringBase& version_value,
          Svc::VersionStatus::T version_status
      );

      void set_version_enum(Svc::VersionCfg::VersionEnum::T version_enum);

      void set_version_value(const Fw::StringBase& version_value);

      void set_version_status(Svc::VersionStatus::T version_status);

    protected:

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

      Svc::VersionCfg::VersionEnum m_version_enum;
      char m___fprime_ac_version_value_buffer[Fw::StringBase::BUFFER_SIZE(80)];
      Fw::ExternalString m_version_value;
      Svc::VersionStatus m_version_status;

  };

}

#endif