fsfw/src/fsfw/returnvalues/HasReturnvaluesIF.h

32 lines
848 B
C
Raw Normal View History

2020-10-29 17:45:06 +01:00
#ifndef FSFW_RETURNVALUES_HASRETURNVALUESIF_H_
#define FSFW_RETURNVALUES_HASRETURNVALUESIF_H_
2020-10-29 17:45:06 +01:00
#include <returnvalues/classIds.h>
2022-02-02 10:29:30 +01:00
#include <cstdint>
2022-02-02 10:29:30 +01:00
#include "FwClassIds.h"
2022-02-02 10:29:30 +01:00
#define MAKE_RETURN_CODE(number) ((INTERFACE_ID << 8) + (number))
typedef uint16_t ReturnValue_t;
class HasReturnvaluesIF {
2022-02-02 10:29:30 +01:00
public:
static const ReturnValue_t RETURN_OK = 0;
static const ReturnValue_t RETURN_FAILED = 1;
virtual ~HasReturnvaluesIF() {}
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
*/
static constexpr ReturnValue_t makeReturnCode(uint8_t classId, uint8_t number) {
return (static_cast<ReturnValue_t>(classId) << 8) + number;
}
};
2020-10-29 17:45:06 +01:00
#endif /* FSFW_RETURNVALUES_HASRETURNVALUESIF_H_ */