2020-10-29 17:45:06 +01:00
|
|
|
#ifndef FSFW_RETURNVALUES_HASRETURNVALUESIF_H_
|
|
|
|
#define FSFW_RETURNVALUES_HASRETURNVALUESIF_H_
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2020-10-29 17:45:06 +01:00
|
|
|
#include <returnvalues/classIds.h>
|
2022-02-02 10:29:30 +01:00
|
|
|
|
2020-06-23 13:00:38 +02:00
|
|
|
#include <cstdint>
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-02-02 10:29:30 +01:00
|
|
|
#include "FwClassIds.h"
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-02-02 10:29:30 +01:00
|
|
|
#define MAKE_RETURN_CODE(number) ((INTERFACE_ID << 8) + (number))
|
|
|
|
typedef uint16_t ReturnValue_t;
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-07-26 10:22:05 +02:00
|
|
|
namespace retval {
|
|
|
|
static constexpr ReturnValue_t OK = 0;
|
|
|
|
static constexpr ReturnValue_t FAILED = 1;
|
|
|
|
|
|
|
|
static constexpr ReturnValue_t makeCode(uint8_t classId, uint8_t number) {
|
|
|
|
return (static_cast<ReturnValue_t>(classId) << 8) + number;
|
|
|
|
}
|
|
|
|
} // namespace retval
|
|
|
|
|
2016-06-15 23:48:41 +02:00
|
|
|
class HasReturnvaluesIF {
|
2022-02-02 10:29:30 +01:00
|
|
|
public:
|
2022-07-26 10:22:05 +02:00
|
|
|
static const ReturnValue_t RETURN_OK = retval::OK;
|
|
|
|
static const ReturnValue_t RETURN_FAILED = retval::FAILED;
|
|
|
|
|
|
|
|
virtual ~HasReturnvaluesIF() = default;
|
2020-06-23 14:12:55 +02:00
|
|
|
|
2022-02-02 10:29:30 +01:00
|
|
|
/**
|
|
|
|
* It is discouraged to use the input parameters 0,0 and 0,1 as this
|
|
|
|
* will generate the RETURN_OK and RETURN_FAILED returnvalues.
|
|
|
|
* @param interfaceId
|
|
|
|
* @param number
|
|
|
|
* @return
|
|
|
|
*/
|
2022-07-26 10:22:05 +02:00
|
|
|
[[deprecated("Use retval::makeCode instead")]] static constexpr ReturnValue_t makeReturnCode(
|
|
|
|
uint8_t classId, uint8_t number) {
|
|
|
|
return retval::makeCode(classId, number);
|
2022-02-02 10:29:30 +01:00
|
|
|
}
|
2016-06-15 23:48:41 +02:00
|
|
|
};
|
|
|
|
|
2020-10-29 17:45:06 +01:00
|
|
|
#endif /* FSFW_RETURNVALUES_HASRETURNVALUESIF_H_ */
|