Skip to content

Commit 8d4475b

Browse files
Refactor ReturnCode Enumeration to RETCODE_ Format to Prevent Incompatibilities (#123)
Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>
1 parent ee4e7d0 commit 8d4475b

3 files changed

Lines changed: 25 additions & 24 deletions

File tree

cpp_utils/include/cpp_utils/ReturnCode.hpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,17 @@ class ReturnCode
4040

4141
enum ReturnCodeValue
4242
{
43-
OK = 0,
44-
ERROR = 1,
45-
UNKNOWN = 2,
46-
NO_DATA = 3,
47-
NOT_ENABLED = 4,
48-
PRECONDITION_NOT_MET = 5,
43+
RETCODE_OK = 0,
44+
RETCODE_ERROR = 1,
45+
RETCODE_UNKNOWN = 2,
46+
RETCODE_NO_DATA = 3,
47+
RETCODE_NOT_ENABLED = 4,
48+
RETCODE_PRECONDITION_NOT_MET = 5,
4949
};
5050

5151
CPP_UTILS_DllAPI
5252
ReturnCode()
53-
: value_(OK)
53+
: value_(RETCODE_OK)
5454
{
5555
}
5656

cpp_utils/src/cpp/ReturnCode.cpp

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ ReturnCode::ReturnCode(
3333
switch (value)
3434
{
3535
case fastdds::dds::RETCODE_OK:
36-
value_ = ReturnCode::OK;
36+
value_ = ReturnCode::RETCODE_OK;
3737
break;
3838
case fastdds::dds::RETCODE_ERROR:
3939
case fastdds::dds::RETCODE_UNSUPPORTED:
@@ -44,19 +44,19 @@ ReturnCode::ReturnCode(
4444
case fastdds::dds::RETCODE_ALREADY_DELETED:
4545
case fastdds::dds::RETCODE_TIMEOUT:
4646
case fastdds::dds::RETCODE_ILLEGAL_OPERATION:
47-
value_ = ReturnCode::ERROR;
47+
value_ = ReturnCode::RETCODE_ERROR;
4848
break;
4949
case fastdds::dds::RETCODE_NO_DATA:
50-
value_ = ReturnCode::NO_DATA;
50+
value_ = ReturnCode::RETCODE_NO_DATA;
5151
break;
5252
case fastdds::dds::RETCODE_NOT_ENABLED:
53-
value_ = ReturnCode::NOT_ENABLED;
53+
value_ = ReturnCode::RETCODE_NOT_ENABLED;
5454
break;
5555
case fastdds::dds::RETCODE_PRECONDITION_NOT_MET:
56-
value_ = ReturnCode::PRECONDITION_NOT_MET;
56+
value_ = ReturnCode::RETCODE_PRECONDITION_NOT_MET;
5757
break;
5858
default:
59-
value_ = ReturnCode::UNKNOWN;
59+
value_ = ReturnCode::RETCODE_UNKNOWN;
6060
break;
6161
}
6262
}
@@ -86,16 +86,17 @@ bool ReturnCode::operator <(
8686

8787
bool ReturnCode::operator !() const noexcept
8888
{
89-
return value_ != ReturnCode::OK;
89+
return value_ != ReturnCode::RETCODE_OK;
9090
}
9191

9292
const std::map<ReturnCode, std::string> ReturnCode::to_string_conversion_ =
9393
{
94-
{ReturnCode::OK, "Ok"},
95-
{ReturnCode::ERROR, "Error"},
96-
{ReturnCode::UNKNOWN, "Unknown"},
97-
{ReturnCode::NO_DATA, "NoData"},
98-
{ReturnCode::PRECONDITION_NOT_MET, "PreconditionNotMet"},
94+
{ReturnCode::RETCODE_OK, "Ok"},
95+
{ReturnCode::RETCODE_ERROR, "Error"},
96+
{ReturnCode::RETCODE_UNKNOWN, "Unknown"},
97+
{ReturnCode::RETCODE_NO_DATA, "NoData"},
98+
{ReturnCode::RETCODE_NOT_ENABLED, "NotEnabled"},
99+
{ReturnCode::RETCODE_PRECONDITION_NOT_MET, "PreconditionNotMet"},
99100
};
100101

101102
std::ostream& operator <<(

cpp_utils/test/unittest/return_code/ReturnCodeTest.cpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ TEST(ReturnCodeTest, serializator)
2828
{
2929
std::map<ReturnCode, std::string> to_string_conversion =
3030
{
31-
{ReturnCode::OK, "{Ok}"},
32-
{ReturnCode::ERROR, "{Error}"},
33-
{ReturnCode::UNKNOWN, "{Unknown}"},
34-
{ReturnCode::NO_DATA, "{NoData}"},
35-
{ReturnCode::PRECONDITION_NOT_MET, "{PreconditionNotMet}"},
31+
{ReturnCode::RETCODE_OK, "{Ok}"},
32+
{ReturnCode::RETCODE_ERROR, "{Error}"},
33+
{ReturnCode::RETCODE_UNKNOWN, "{Unknown}"},
34+
{ReturnCode::RETCODE_NO_DATA, "{NoData}"},
35+
{ReturnCode::RETCODE_PRECONDITION_NOT_MET, "{PreconditionNotMet}"},
3636
};
3737

3838
for (auto it : to_string_conversion)

0 commit comments

Comments
 (0)