2022-08-16 12:48:22 +02:00
|
|
|
#ifndef FSFW_RETURNVALUES_RETURNVALUE_H_
|
|
|
|
#define FSFW_RETURNVALUES_RETURNVALUE_H_
|
2016-06-15 23:48:41 +02: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))
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-08-15 20:28:16 +02:00
|
|
|
typedef uint16_t ReturnValue_t;
|
2022-07-26 10:22:05 +02:00
|
|
|
|
2022-08-15 20:28:16 +02:00
|
|
|
namespace returnvalue {
|
2022-08-22 15:02:16 +02:00
|
|
|
static const ReturnValue_t OK = 0;
|
|
|
|
static const ReturnValue_t FAILED = 1;
|
2022-08-15 20:28:16 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* It is discouraged to use the input parameters 0,0 and 0,1 as this
|
2022-08-16 12:12:21 +02:00
|
|
|
* will generate the returnvalue::OK and returnvalue::FAILED returnvalues.
|
2022-08-15 20:28:16 +02:00
|
|
|
* @param interfaceId
|
|
|
|
* @param number
|
|
|
|
* @return
|
|
|
|
*/
|
2022-08-22 15:02:16 +02:00
|
|
|
static constexpr ReturnValue_t makeCode(uint8_t classId, uint8_t number) {
|
2022-07-26 10:22:05 +02:00
|
|
|
return (static_cast<ReturnValue_t>(classId) << 8) + number;
|
|
|
|
}
|
2022-08-15 20:28:16 +02:00
|
|
|
|
2022-08-22 15:02:16 +02:00
|
|
|
} // namespace returnvalue
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-08-16 12:48:22 +02:00
|
|
|
#endif /* FSFW_RETURNVALUES_RETURNVALUE_H_ */
|