Skip to content

Commit

Permalink
Document until parameter
Browse files Browse the repository at this point in the history
Signed-off-by: Shane Loretz <sloretz@openrobotics.org>
  • Loading branch information
sloretz committed Dec 15, 2021
1 parent a8ddedf commit de582e1
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions rclpy/src/rclpy/event.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ class Event
public:
/// Wait until a time specified by a system or steady clock.
/// \param clock the clock to use for time synchronization with until
/// \param until this method will block until this time is reached.
template<typename ClockType>
void wait_until(std::shared_ptr<Clock> clock, rcl_time_point_t until);

Expand All @@ -48,6 +49,7 @@ class Event
/// the target ROS time is reached.
/// when a given ROS time is reached.
/// \param clock the clock to use for time synchronization.
/// \param until this method will block until this time is reached.
void wait_until_ros(std::shared_ptr<Clock> clock, rcl_time_point_t until);

/// Indicate if the Event is set.
Expand Down

0 comments on commit de582e1

Please sign in to comment.