MutexStatusEnumAc.hpp

Go to the documentation of this file.

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

#ifndef Os_MutexStatusEnumAc_HPP
#define Os_MutexStatusEnumAc_HPP

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

namespace Os {

  class MutexStatus :
    public Fw::Serializable
  {

    public:

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

      typedef U8 SerialType;

      enum T {
        OP_OK = 0,
        ERROR_BUSY = 1,
        ERROR_DEADLOCK = 2,
        NOT_SUPPORTED = 3,
        ERROR_OTHER = 4,
      };

      typedef enum T t;

    public:

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

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

    public:

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

      MutexStatus()
      {
        this->e = OP_OK;
      }

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

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

    public:

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

      MutexStatus& operator=(
          const MutexStatus& obj 
      );

      MutexStatus& 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 MutexStatus& 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
      // ----------------------------------------------------------------------

      enum T e;

  };

}

#endif