timer::Timeout Class Reference

timeout class More...

#include <timeout.hpp>

Public Member Functions
	Timeout (rclcpp::Time start_time, int64_t timeout)
	timeout settings
void	reset (rclcpp::Time start_time)
	reset start time
bool	is_timeout (rclcpp::Time now)
	Determine if it has time out.
int64_t	get_elapsed_time ()
	Get elapsed time.
int64_t	get_timeout ()
	Get timeout.
void	set_timeout (int64_t timeout_ns)
	Set timeout.

Detailed Description

timeout class

Constructor & Destructor Documentation

Timeout()

timer::Timeout::Timeout ( rclcpp::Time  start_time, int64_t  timeout  )

explicit

timeout settings

Parameters

start_time	measurement start time
timeout	time until timeout [ns]

Settings such as start time and timeout.

Member Function Documentation

get_elapsed_time()

int64_t timer::Timeout::get_elapsed_time

(

)

Get elapsed time.

Returns

int64_t elapsed time [ns]

get_timeout()

int64_t timer::Timeout::get_timeout

(

)

Get timeout.

Returns

int64_t timeout [ns]

is_timeout()

bool timer::Timeout::is_timeout

(

rclcpp::Time

now

)

Determine if it has time out.

Parameters

now	current time

Returns

bool true if timeout, otherwise false

reset()

void timer::Timeout::reset

(

rclcpp::Time

start_time

)

reset start time

Parameters

start_time

measurement start time

Returns

non

Update the start time and reset the timeout measurement.

set_timeout()

void timer::Timeout::set_timeout

(

int64_t

timeout_ns

)

Set timeout.

Parameters

timeout_ns

int64_t timeout [ns]

---

The documentation for this class was generated from the following files:

• src/common/timer/include/timer/timeout.hpp
• src/common/timer/src/timeout.cpp