Skip to content

Deprecate parameter traits package and header file #297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
christophfroehlich wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Deprecate parameter traits package and header file #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d3b8acd
Add deprecation notice to package.xml
christophfroehlich Dec 6, 2025
17fa967
Add deprecation notice to header file
christophfroehlich Dec 6, 2025
5e70e28
Fix warning string
christophfroehlich Dec 6, 2025
9f7dca2
Silence it in our own header
christophfroehlich Dec 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...ter_library_py/generate_parameter_library_py/jinja_templates/cpp/parameter_library_header
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@
#include <fmt/format.h>
#include <fmt/ranges.h>

// silence deprecation warnings for parameter_traits, needed for backwards compatibility
#define SILENCE_DEPRECATION_WARNINGS
#include <parameter_traits/parameter_traits.hpp>
#undef SILENCE_DEPRECATION_WARNINGS

#include <rsl/static_string.hpp>
#include <rsl/static_vector.hpp>
Expand Down
13 changes: 13 additions & 0 deletions parameter_traits/include/parameter_traits/parameter_traits.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,19 @@
#include <rsl/algorithm.hpp>
#include <tl_expected/expected.hpp>

#ifndef SILENCE_DEPRECATION_WARNINGS
#ifdef _MSC_VER
#pragma message( \
"This header is obsolete, \
please include \"rsl/algorithm.hpp\" for rsl::contains and rsl::is_unique, \
and \"tl_expected/expected.hpp\" for tl::expected.")
#else
#warning This header is obsolete, \
please include "rsl/algorithm.hpp" for rsl::contains and rsl::is_unique, \
and "tl_expected/expected.hpp" for tl::expected.
#endif
#endif

namespace parameter_traits {

using Result
Expand Down
6 changes: 6 additions & 0 deletions parameter_traits/package.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,11 @@

<export>
<build_type>ament_cmake</build_type>
<export>
<deprecated>
This package will be removed in Lyrical Luth. Instead, use the
rsl or tl_expected packages directly for similar functionality.
</deprecated>
</export>
</export>
</package>
Loading