Zane Shelley | 876bc2a | 2019-07-23 12:55:37 -0500 | [diff] [blame] | 1 | #pragma once |
| 2 | |
| 3 | #include <stdint.h> |
| 4 | |
| 5 | namespace libhei |
| 6 | { |
| 7 | |
| 8 | class ReturnCode |
| 9 | { |
| 10 | public: |
| 11 | |
| 12 | /** |
| 13 | * @brief Constructor. |
| 14 | * @param i_rc The error code value. |
| 15 | */ |
| 16 | explicit constexpr ReturnCode( uint32_t i_rc = 0 ) : |
| 17 | iv_rc( i_rc ) |
| 18 | {} |
| 19 | |
| 20 | /** @brief Default copy constructor. */ |
| 21 | ReturnCode( const ReturnCode & ) = default; |
| 22 | |
| 23 | /** @brief Default assignment operator. */ |
| 24 | ReturnCode& operator=( const ReturnCode & ) = default; |
| 25 | |
| 26 | /** @brief Default destructor. */ |
| 27 | ~ReturnCode() = default; |
| 28 | |
| 29 | /** @brief Integral type conversion function. */ |
| 30 | operator uint32_t() const { return iv_rc; } |
| 31 | |
| 32 | /** @brief Integral type conversion function. */ |
| 33 | operator uint64_t() const { return iv_rc; } |
| 34 | |
| 35 | /** @brief Equals operator. */ |
| 36 | bool operator==( const ReturnCode & rhs ) const |
| 37 | { |
| 38 | return rhs.iv_rc == iv_rc; |
| 39 | } |
| 40 | |
| 41 | /** @brief Not equals operator. */ |
| 42 | bool operator!=( const ReturnCode & rhs ) const |
| 43 | { |
| 44 | return rhs.iv_rc != iv_rc; |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * @brief Returns the error code value. |
| 49 | * |
| 50 | * We'd prefer to use the integral type conversion functions above, but |
| 51 | * some compilers will throw warnings when passing this object into |
| 52 | * functions with variadic arguments, like printf(). |
| 53 | */ |
| 54 | uint32_t get() const { return iv_rc; } |
| 55 | |
| 56 | private: |
| 57 | |
| 58 | const uint32_t iv_rc; ///< return code value |
| 59 | }; |
| 60 | |
| 61 | /** Function returned successfully. */ |
| 62 | static constexpr ReturnCode RC_SUCCESS = ReturnCode(); |
| 63 | |
| 64 | }; // end namespace libhei |
| 65 | |