Skip to content

Commit

Permalink
Update the comments for SetParametersResult to reflect reality. (#159)
Browse files Browse the repository at this point in the history
One of the ways that parameter setting can fail is if a
user callback (registered with add_on_set_parameters_callback())
rejects it.  These callbacks are chained in a Last-In-First-Called
manner.

Another piece of information to be aware of is that the
call to "set_parameters_atomically" has a single SetParametersResult
return value.

Combining the above two pieces of information, then when
"set_parameters_atomically" is called and one of the callbacks
rejects it, it can easily set the reason string and return that
to the user since no further callbacks are going to be called.
However, if a callback accepts it but expects to set a reason
code, one of the later callbacks can easily overwrite that
return code.

Because of this, change the documentation to reflect the reality
that a 'reason' can only be specified for the failure case.
On success, 'reason' is undefined.

Signed-off-by: Chris Lalancette <[email protected]>
  • Loading branch information
clalancette committed Sep 5, 2023
1 parent f03ee90 commit 17066cd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions rcl_interfaces/msg/SetParametersResult.msg
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
# successfully. A false value indicates the change was rejected.
bool successful

# Reason why the setting was either successful or a failure. This should only be
# used for logging and user interfaces.
# Reason why the setting was a failure. On success, the contents of this field
# are undefined. This should only be used for logging and user interfaces.
string reason

0 comments on commit 17066cd

Please sign in to comment.