SuccessEnumAc.hpp

Go to the documentation of this file.

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

#ifndef Fw_SuccessEnumAc_HPP
#define Fw_SuccessEnumAc_HPP

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

namespace Fw {

  class Success :
    public Fw::Serializable
  {

    public:

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

      typedef U8 SerialType;

      enum T {
        FAILURE = 0,
        SUCCESS = 1,
      };

      typedef T t;

    public:

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

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

    public:

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

      Success()
      {
        this->e = FAILURE;
      }

      Success(
          const T e1 
      )
      {
        this->e = e1;
      }

      Success(
          const Success& obj 
      )
      {
        this->e = obj.e;
      }

    public:

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

      Success& operator=(
          const Success& obj 
      );

      Success& operator=(
          T e1 
      );

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

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

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

#ifdef BUILD_UT

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

    public:

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

      T e;

  };

}

#endif