Lely core libraries 2.3.4
lely::canopen::LssSetBitrateRequest Class Reference

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

#include <lss_master.hpp>

Inheritance diagram for lely::canopen::LssSetBitrateRequest:
Collaboration diagram for lely::canopen::LssSetBitrateRequest:

Public Types

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

Public Member Functions

template<class F >
 LssSetBitrateRequest (ev_exec_t *exec, F &&con)
 Constructs an empty LSS 'configure bit timing parameters' request with a completion task. More...
 
template<class F >
 LssSetBitrateRequest (F &&con)
 Equivalent to LssSetBitrateRequest(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::LssSetBitrateRequestBase
int bitrate {0}
 The requested pending bit rate (in bit/s) of the LSS slave device.
 
- 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_texec
 A pointer to the executor to which the task is (to be) submitted.
 
ev_task_func_tfunc
 The function to be invoked when the task is run.
 

Detailed Description

An LSS 'configure bit timing parameters' request.

Definition at line 405 of file lss_master.hpp.

Member Typedef Documentation

◆ Signature

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

The signature of the callback function invoked on completion of an LSS 'configure 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
ecthe error code (0 on success).

Definition at line 415 of file lss_master.hpp.

Constructor & Destructor Documentation

◆ LssSetBitrateRequest()

template<class F >
lely::canopen::LssSetBitrateRequest::LssSetBitrateRequest ( ev_exec_t exec,
F &&  con 
)
inlineexplicit

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

The requested pending bit rate of the LSS slave device has to be set before the request can be submitted.

Definition at line 423 of file lss_master.hpp.


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