Skip to content

Commit cb81e60

Browse files
Deprecate parameter_traits package and header file (#297)
1 parent 46f6123 commit cb81e60

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed

generate_parameter_library_py/generate_parameter_library_py/jinja_templates/cpp/parameter_library_header

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@
2121
#include <fmt/format.h>
2222
#include <fmt/ranges.h>
2323

24+
// silence deprecation warnings for parameter_traits, needed for backwards compatibility
25+
#define SILENCE_DEPRECATION_WARNINGS
2426
#include <parameter_traits/parameter_traits.hpp>
27+
#undef SILENCE_DEPRECATION_WARNINGS
2528

2629
#include <rsl/static_string.hpp>
2730
#include <rsl/static_vector.hpp>

parameter_traits/include/parameter_traits/parameter_traits.hpp

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,19 @@
3636
#include <rsl/algorithm.hpp>
3737
#include <tl_expected/expected.hpp>
3838

39+
#ifndef SILENCE_DEPRECATION_WARNINGS
40+
#ifdef _MSC_VER
41+
#pragma message( \
42+
"This header is obsolete, \
43+
please include \"rsl/algorithm.hpp\" for rsl::contains and rsl::is_unique, \
44+
and \"tl_expected/expected.hpp\" for tl::expected.")
45+
#else
46+
#warning This header is obsolete, \
47+
please include "rsl/algorithm.hpp" for rsl::contains and rsl::is_unique, \
48+
and "tl_expected/expected.hpp" for tl::expected.
49+
#endif
50+
#endif
51+
3952
namespace parameter_traits {
4053

4154
using Result

parameter_traits/package.xml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,11 @@
2323

2424
<export>
2525
<build_type>ament_cmake</build_type>
26+
<export>
27+
<deprecated>
28+
This package will be removed in Lyrical Luth. Instead, use the
29+
rsl or tl_expected packages directly for similar functionality.
30+
</deprecated>
31+
</export>
2632
</export>
2733
</package>

0 commit comments

Comments
 (0)