Skip to content
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.

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

Rename get_state and set_state Functions to get/set_lifecylce_state (variant support) #1683

Merged

Conversation

mamueluth
Copy link
Member

@mamueluth mamueluth commented Aug 15, 2024

This PR is part of #1240 but not originally included in it.

The purpose of this pr is to rename the get_state and set_state functions related to lifecycle management to get_lifecylce_state and set_lifecylce_state. I think this is necessary because PR #1240 is going to introduce get_state and set_state functions for getting/setting the values in a handle from hardware site. With this PR there should be no confusion between getting/setting lifecycle related state and actual values of hardware.

Needs to be merged as well: ros-controls/ros2_controllers#1250

@mamueluth mamueluth changed the title Get set lifecylce state Rename get_state and set_state Functions to get/set_lifecylce_state Aug 15, 2024
@mamueluth mamueluth changed the title Rename get_state and set_state Functions to get/set_lifecylce_state Rename get_state and set_state Functions to get/set_lifecylce_state Aug 15, 2024
@mamueluth mamueluth changed the title Rename get_state and set_state Functions to get/set_lifecylce_state Rename get_state and set_state Functions to get/set_lifecylce_state (variant support) Aug 15, 2024
Copy link
Member

@saikishor saikishor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look good to me.

Should we add deprecation notice to the older methods before removing them?. I've added suggestions here for that. We can discuss on that

@saikishor
Copy link
Member

@mamueluth could you please also update the release_notes as well

destogl
destogl previously approved these changes Aug 15, 2024
Copy link
Member

@destogl destogl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

I vote to go without deprecation as it is mostly internal interface and this can not be deprecated for a long time.

Definitely we need an addition to migration notes.

Copy link

codecov bot commented Aug 15, 2024

Codecov Report

Attention: Patch coverage is 89.77778% with 46 lines in your changes missing coverage. Please review.

Project coverage is 86.79%. Comparing base (6164883) to head (7f9423e).
Report is 1 commits behind head on master.

Files Patch % Lines
hardware_interface/src/actuator.cpp 68.88% 8 Missing and 6 partials ⚠️
hardware_interface/src/sensor.cpp 66.66% 8 Missing and 6 partials ⚠️
hardware_interface/src/system.cpp 68.88% 8 Missing and 6 partials ⚠️
.../include/controller_interface/async_controller.hpp 0.00% 2 Missing ⚠️
...ce/include/hardware_interface/async_components.hpp 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1683      +/-   ##
==========================================
+ Coverage   86.73%   86.79%   +0.06%     
==========================================
  Files         116      116              
  Lines       10618    10682      +64     
  Branches      978      976       -2     
==========================================
+ Hits         9209     9271      +62     
- Misses       1058     1060       +2     
  Partials      351      351              
Flag Coverage Δ
unittests 86.79% <89.77%> (+0.06%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...controller_interface/controller_interface_base.hpp 87.50% <ø> (ø)
...r_interface/src/chainable_controller_interface.cpp 65.95% <100.00%> (ø)
...roller_interface/src/controller_interface_base.cpp 86.27% <100.00%> (ø)
controller_manager/src/controller_manager.cpp 77.43% <100.00%> (+0.02%) ⬆️
...chainable_controller/test_chainable_controller.cpp 88.09% <100.00%> (ø)
...r_manager/test/test_controller/test_controller.cpp 95.34% <100.00%> (ø)
...ontroller_manager/test/test_controller_manager.cpp 93.86% <100.00%> (+0.35%) ⬆️
...est_controller_manager_hardware_error_handling.cpp 100.00% <100.00%> (ø)
...ller_manager/test/test_controller_manager_srvs.cpp 99.26% <100.00%> (+<0.01%) ⬆️
...ager/test/test_controller_manager_urdf_passing.cpp 100.00% <100.00%> (ø)
... and 17 more

@mamueluth
Copy link
Member Author

@mamueluth could you please also update the release_notes as well

Hi @saikishor release notes are updated:)

@saikishor
Copy link
Member

Hi @saikishor release notes are updated:)

Sorry for asking for more changes. I think it's better that the respective one goes under the package controllet_interface and hardware_interface packages

Copy link
Contributor

mergify bot commented Aug 19, 2024

This pull request is in conflict. Could you fix it @mamueluth?

Copy link
Contributor

mergify bot commented Aug 21, 2024

This pull request is in conflict. Could you fix it @mamueluth?

Copy link
Contributor

mergify bot commented Aug 22, 2024

This pull request is in conflict. Could you fix it @mamueluth?

doc/release_notes.rst Outdated Show resolved Hide resolved
bmagyar
bmagyar previously approved these changes Aug 26, 2024
Co-authored-by: Sai Kishor Kothakota <[email protected]>
@bmagyar bmagyar merged commit 7a5779c into ros-controls:master Aug 26, 2024
19 of 21 checks passed
@destogl destogl deleted the get_set_lifecylce_state branch August 26, 2024 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants