Skip to content

Document order of interfaces #2394

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

Merged
merged 5 commits into from
Jul 30, 2025
Merged

Conversation

christophfroehlich
Copy link
Contributor

See ros-controls/ros2_controllers#116

Any other location to document this?

@christophfroehlich christophfroehlich added backport-humble This label should be used by maintainers only! Label triggers PR backport to ROS 2 humble. backport-jazzy This label should be used by maintainers only! Label triggers PR backport to ROS 2 jazzy. labels Jul 15, 2025
Copy link

codecov bot commented Jul 15, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.92%. Comparing base (750ac8a) to head (9aaa3f0).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2394   +/-   ##
=======================================
  Coverage   88.91%   88.92%           
=======================================
  Files         148      148           
  Lines       16973    16973           
  Branches     1448     1448           
=======================================
+ Hits        15092    15093    +1     
  Misses       1318     1318           
+ Partials      563      562    -1     
Flag Coverage Δ
unittests 88.92% <ø> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
...controller_interface/controller_interface_base.hpp 91.66% <ø> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment on lines 331 to 335
/** Loaned command interfaces. The order of the interfaces is the same as exported in the
* \ref ActuatorInterface::export_command_interfaces "export_command_interfaces"
* \ref SystemInterface::export_command_interfaces "export_command_interfaces"
* methods, or defined by the \ref command_interface_configuration() if auto-export is used.
*/
Copy link
Member

Choose a reason for hiding this comment

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

Isn't it defined by the order we define in the command_interface_configuration method?

virtual InterfaceConfiguration command_interface_configuration() const = 0;

Copy link
Member

Choose a reason for hiding this comment

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

I believe you are right, when we use ALL instead of INDIVIDUAL type

Copy link
Contributor Author

Choose a reason for hiding this comment

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

you mean if one uses the deprecated export_command_interfaces? Then there is no command_interface_configuration?

Copy link
Member

Choose a reason for hiding this comment

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

Isn't the export_command_interfaces and export_state_interfaces from HW component side?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I thought in the wrong direction. I simplified the docstring, how is the order if interface_configuration_type::ALL is configured? Is it determined by the order of loading the hardware components, and per component as defined in the xml tag?

bmagyar
bmagyar previously approved these changes Jul 18, 2025
Copy link
Member

@bmagyar bmagyar left a comment

Choose a reason for hiding this comment

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

me gusta, barring the ongoing discussion

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.

Spot on!

@christophfroehlich christophfroehlich merged commit 39c588e into master Jul 30, 2025
22 of 26 checks passed
@christophfroehlich christophfroehlich deleted the doc/ordered_interfaces branch July 30, 2025 16:55
mergify bot pushed a commit that referenced this pull request Jul 30, 2025
mergify bot pushed a commit that referenced this pull request Jul 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-humble This label should be used by maintainers only! Label triggers PR backport to ROS 2 humble. backport-jazzy This label should be used by maintainers only! Label triggers PR backport to ROS 2 jazzy.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants