fpp/compiler/tools/fpp-to-cpp/test/enum/C_EEnumAc.ref.hpp

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

#ifndef C_C_EEnumAc_HPP
#define C_C_EEnumAc_HPP

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

class C_E :
  public Fw::Serializable
{

  public:

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

    //! The serial representation type
    typedef I32 SerialType;

    //! The raw enum type
    enum T {
      X = 0,
      Y = 1,
    };

    //! For backwards compatibility
    typedef T t;

  public:

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

    enum {
      //! The size of the serial representation
      SERIALIZED_SIZE = sizeof(SerialType),
      //! The number of enumerated constants
      NUM_CONSTANTS = 2,
    };

  public:

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

    //! Constructor (default value of X)
    C_E()
    {
      this->e = X;
    }

    //! Constructor (user-provided value)
    C_E(
        const T e1 //!< The raw enum value
    )
    {
      this->e = e1;
    }

    //! Copy constructor
    C_E(
        const C_E& obj //!< The source object
    )
    {
      this->e = obj.e;
    }

  public:

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

    //! Copy assignment operator (object)
    C_E& operator=(
        const C_E& obj //!< The source object
    );

    //! Copy assignment operator (raw enum)
    C_E& operator=(
        T e1 //!< The enum value
    );

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

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

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

#ifdef BUILD_UT

    //! Ostream operator
    friend std::ostream& operator<<(
        std::ostream& os, //!< The ostream
        const C_E& obj //!< The object
    );

#endif

  public:

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

    //! Check raw enum value for validity
    bool isValid() const;

    //! Serialize raw enum value to SerialType
    Fw::SerializeStatus serializeTo(
        Fw::SerialBufferBase& buffer, //!< The serial buffer
        Fw::Endianness mode = Fw::Endianness::BIG //!< Endianness of serialized buffer
    ) const;

    //! Deserialize raw enum value from SerialType
    Fw::SerializeStatus deserializeFrom(
        Fw::SerialBufferBase& buffer, //!< The serial buffer
        Fw::Endianness mode = Fw::Endianness::BIG //!< Endianness of serialized buffer
    );

#if FW_SERIALIZABLE_TO_STRING

    //! Convert enum to string
    void toString(
        Fw::StringBase& sb //!< The StringBase object to hold the result
    ) const;

#endif

  public:

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

    //! The raw enum value
    T e;

};

#endif