Conversation
Signed-off-by: Nate Koenig <nate@openrobotics.org>
Codecov Report
@@ Coverage Diff @@
## main #199 +/- ##
=======================================
Coverage 84.56% 84.56%
=======================================
Files 7 7
Lines 855 855
=======================================
Hits 723 723
Misses 132 132 Continue to review full report at Codecov.
|
| /// \brief Iteration step size. It's zero when paused. | ||
| Time step_size = 10; | ||
|
|
||
| /// \brief True is the simulator is stepping, as opposed to running. |
There was a problem hiding this comment.
so stepping means that it is executing a fixed number of iterations, as opposed to running for an unbounded number of iterations?
There was a problem hiding this comment.
Yeah - the idea is that this field can be used in combination with the paused field of this message to provide more context. If paused is false, then the process is running/executing, but it's not clear if it's running/executing for a bounded or unbounded number of iterations. Adding a stepping field would provide this missing information.
I think that this can be made a little clearer. Perhaps we can provide the context that I just gave above and also add the note I suggested in #199 (comment).
There was a problem hiding this comment.
Yeah, I can add that clarification note.
Signed-off-by: Nate Koenig <nate@openrobotics.org>
adlarkin
left a comment
adlarkin
left a comment
There was a problem hiding this comment.
Newest documentation changes LGTM, thanks!
|
@nkoenig , do you want to leave this open until there's a downstream PR making use of it? It will still take a while to bump the versions in Garden so this can be used. |
Yeah, I want to leave this open until I (or someone else) makes the downstream changes. |
chapulina
added
Breaking change
Codecov Report
@@ Coverage Diff @@
## main #199 +/- ##
=======================================
Coverage 84.62% 84.62%
=======================================
Files 10 10
Lines 995 995
=======================================
Hits 842 842
Misses 153 153 Continue to review full report at Codecov.
|
4 participants
Signed-off-by: Nate Koenig nate@openrobotics.org
🎉 New feature
Summary
Adds a stepping flag to world statistics so that we don't have to add custom headers, such as here
This PR also serves as a note to change ign-gui and ign-gazebo in Garden to avoid the statistics header:
Checklist
codecheckpassed (See contributing)Note to maintainers: Remember to use Squash-Merge