lely::canopen::LssSwitchBitrateRequest Class Reference

An LSS 'activate bit timing parameters' request. More...

#include <lss_master.hpp>

Inheritance diagram for lely::canopen::LssSwitchBitrateRequest:

Collaboration diagram for lely::canopen::LssSwitchBitrateRequest:

Public Types
using	Signature = void(::std::error_code ec)
	The signature of the callback function invoked on completion of an LSS 'activate bit timing parameters' request.

Public Member Functions
template<class F >
	LssSwitchBitrateRequest (ev_exec_t *exec, F &&con)
	Constructs an empty LSS 'activate bit timing parameters' request with a completion task.
template<class F >
	LssSwitchBitrateRequest (F &&con)
	Equivalent to LssSwitchBitrateRequest(nullptr, con).
Public Member Functions inherited from lely::canopen::detail::LssRequestBase
ev::Executor	GetExecutor () const noexcept
	Returns the executor to which the completion task is (to be) submitted.

Additional Inherited Members
Data Fields inherited from lely::canopen::detail::LssSwitchBitrateRequestBase
int	delay {0}
	The delay (in milliseconds) before and after the switch, during which CAN frames MUST NOT be sent.
Data Fields inherited from lely::canopen::detail::LssRequestBase
::std::error_code	ec {}
	The error code (0 on success).
Data Fields inherited from ev_task
ev_exec_t *	exec
	A pointer to the executor to which the task is (to be) submitted.
ev_task_func_t *	func
	The function to be invoked when the task is run.

Detailed Description

An LSS 'activate bit timing parameters' request.

Definition at line 441 of file lss_master.hpp.

Member Typedef Documentation

Signature

using lely::canopen::LssSwitchBitrateRequest::Signature = void(::std::error_code ec)

The signature of the callback function invoked on completion of an LSS 'activate bit timing parameters' request.

Note that the callback function SHOULD NOT throw exceptions. Since it is invoked from C, any exception that is thrown cannot be caught and will result in a call to std::terminate().

Parameters

ec	the error code (0 on success).

Definition at line 451 of file lss_master.hpp.

Constructor & Destructor Documentation

LssSwitchBitrateRequest()

template<class F >

lely::canopen::LssSwitchBitrateRequest::LssSwitchBitrateRequest ( ev_exec_t *  exec, F &&  con  )

inlineexplicit

Constructs an empty LSS 'activate bit timing parameters' request with a completion task.

The delay before and after the switch, during which CAN frames MUST NOT be sent, has to be set before the request can be submitted.

Definition at line 459 of file lss_master.hpp.

---

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

• include/lely/coapp/lss_master.hpp