CompletedEnumAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  CompletedEnumAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for Completed enum
// ======================================================================

#ifndef Fw_CompletedEnumAc_HPP
#define Fw_CompletedEnumAc_HPP

#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/Assert.hpp"
#include "Fw/Types/Serializable.hpp"
#include "Fw/Types/String.hpp"

namespace Fw {

  class Completed :
    public Fw::Serializable
  {

    public:

      // ----------------------------------------------------------------------
      // Types
      // ----------------------------------------------------------------------

      using SerialType = U8;

      enum T {
        COMPLETED = 0,
        CANCELED = 1,
        FAILED = 2,
      };

      using t = enum T;

    public:

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

      enum {
        SERIALIZED_SIZE = sizeof(SerialType),
        NUM_CONSTANTS = 3,
      };

    public:

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

      Completed()
      {
        this->e = COMPLETED;
      }

      Completed(
          const enum T e1 
      )
      {
        FW_ASSERT(isValid(e1), static_cast<FwAssertArgType>(e1));
        this->e = e1;
      }

      Completed(
          const Completed& obj 
      )
      {
        this->e = obj.e;
#ifdef BUILD_UT
      this->m_serializeValueIsSet = obj.m_serializeValueIsSet;
      this->m_serializeValue = obj.m_serializeValue;
#endif
      }

    public:

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

      Completed& operator=(
          const Completed& obj 
      );

      Completed& operator=(
          enum T e1 
      );

      operator enum T() const
      {
        return this->e;
      }

      bool operator==(enum T e1) const
      {
        return this->e == e1;
      }

      bool operator!=(enum T e1) const
      {
        return !(*this == e1);
      }

#ifdef BUILD_UT

      friend std::ostream& operator<<(
          std::ostream& os, 
          const Completed& obj 
      );

#endif

    public:

      // ----------------------------------------------------------------------
      // Member functions
      // ----------------------------------------------------------------------

      bool isValid() const;

      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 
      );

#if FW_SERIALIZABLE_TO_STRING

      void toString(
          Fw::StringBase& sb 
      ) const;

#endif

#ifdef BUILD_UT

      void setSerializeValue(
          SerialType serializeValue 
      );

#endif

    public:

      // ----------------------------------------------------------------------
      // Static functions
      // ----------------------------------------------------------------------

      static bool isValid(
          SerialType serialTypeValue 
      );

    public:

      // ----------------------------------------------------------------------
      // Public member variables
      // ----------------------------------------------------------------------

      enum T e;

    private:

      // ----------------------------------------------------------------------
      // Private member variables
      // ----------------------------------------------------------------------

#ifdef BUILD_UT

      bool m_serializeValueIsSet = false;

      SerialType m_serializeValue = 0;

#endif

  };

}

#endif