urcl::RobotReceiveTimeout Class Reference

RobotReceiveTimeout class containing a timeout configuration. More...

#include <robot_receive_timeout.h>

Public Member Functions
std::chrono::milliseconds	getAsMilliseconds () const
	RobotReceiveTimeout ()=delete
int	verifyRobotReceiveTimeout (const comm::ControlMode control_mode, const std::chrono::milliseconds step_time) const
	Helper function to verify that the robot receive timeout is configured appropriately given the current control mode. More...
	~RobotReceiveTimeout ()=default

Static Public Member Functions
static RobotReceiveTimeout	millisec (const unsigned int milliseconds=20)
	Create a RobotReceiveTimeout object with a specific timeout given in milliseconds. More...
static RobotReceiveTimeout	off ()
	Creates a RobotReceiveTimeout object with no timeout, this will make the read function on the robot blocking. More...
static RobotReceiveTimeout	sec (const float seconds=0.02)
	Create a RobotReceiveTimeout object with a specific timeout given in seconds. More...

Static Public Attributes
static constexpr std::chrono::milliseconds	MAX_RT_RECEIVE_TIMEOUT_MS = std::chrono::milliseconds(200)

Private Member Functions
	RobotReceiveTimeout (std::chrono::milliseconds timeout)

Private Attributes
std::chrono::milliseconds	timeout_

Detailed Description

RobotReceiveTimeout class containing a timeout configuration.

This robot receive timeout is used to configure the read timeout for the reverse socket running in the external control script. The read timeout is the number of milliseconds until the read action times out. A timeout of 0 or negative number indicates that the function should not return until a read is completed, this will make the read function on the robot blocking. This can be set using the function off().

Definition at line 47 of file robot_receive_timeout.h.

Constructor & Destructor Documentation

RobotReceiveTimeout() [1/2]

urcl::RobotReceiveTimeout::RobotReceiveTimeout ( )

delete

~RobotReceiveTimeout()

urcl::RobotReceiveTimeout::~RobotReceiveTimeout ( )

default

RobotReceiveTimeout() [2/2]

urcl::RobotReceiveTimeout::RobotReceiveTimeout ( std::chrono::milliseconds  timeout )

private

Definition at line 40 of file robot_receive_timeout.cpp.

Member Function Documentation

getAsMilliseconds()

std::chrono::milliseconds urcl::RobotReceiveTimeout::getAsMilliseconds ( ) const

inline

Definition at line 90 of file robot_receive_timeout.h.

millisec()

RobotReceiveTimeout urcl::RobotReceiveTimeout::millisec ( const unsigned int  milliseconds = 20 )

static

Create a RobotReceiveTimeout object with a specific timeout given in milliseconds.

Parameters

milliseconds

robot receive timeout

Returns

RobotReceiveTimeout object

Definition at line 44 of file robot_receive_timeout.cpp.

off()

RobotReceiveTimeout urcl::RobotReceiveTimeout::off ( )

static

Creates a RobotReceiveTimeout object with no timeout, this will make the read function on the robot blocking.

Returns

RobotReceiveTimeout object

Definition at line 58 of file robot_receive_timeout.cpp.

sec()

RobotReceiveTimeout urcl::RobotReceiveTimeout::sec ( const float  seconds = 0.02 )

static

Create a RobotReceiveTimeout object with a specific timeout given in seconds.

Parameters

seconds

robot receive timeout

Returns

RobotReceiveTimeout object

Definition at line 51 of file robot_receive_timeout.cpp.

verifyRobotReceiveTimeout()

int urcl::RobotReceiveTimeout::verifyRobotReceiveTimeout	(	const comm::ControlMode	control_mode,
		const std::chrono::milliseconds	step_time
	)		const

Helper function to verify that the robot receive timeout is configured appropriately given the current control mode.

Parameters

control_mode	current control mode
step_time	The robots step time

Returns

receive timeout in milliseconds

Definition at line 64 of file robot_receive_timeout.cpp.

Member Data Documentation

MAX_RT_RECEIVE_TIMEOUT_MS

constexpr std::chrono::milliseconds urcl::RobotReceiveTimeout::MAX_RT_RECEIVE_TIMEOUT_MS = std::chrono::milliseconds(200)

staticconstexpr

Definition at line 50 of file robot_receive_timeout.h.

timeout_

std::chrono::milliseconds urcl::RobotReceiveTimeout::timeout_

private

Definition at line 96 of file robot_receive_timeout.h.

---

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

• robot_receive_timeout.h
• robot_receive_timeout.cpp