Lely core libraries  2.2.5
lely::canopen::LssFastscanRequest Class Reference

An 'LSS Fastscan' request. More...

#include <lss_master.hpp>

Inheritance diagram for lely::canopen::LssFastscanRequest:
Collaboration diagram for lely::canopen::LssFastscanRequest:

Public Types

using Signature = void(::std::error_code ec, LssAddress address)
 The signature of the callback function invoked on completion of an 'LSS Fastscan' request. More...
 

Public Member Functions

template<class F >
 LssFastscanRequest (ev_exec_t *exec, F &&con)
 Constructs an empty 'LSS Fastscan' request with a completion task. More...
 
template<class F >
 LssFastscanRequest (F &&con)
 Equivalent to LssSlowscanRequest(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::LssFastscanRequestBase
LssAddress mask {0, 0, 0, 0}
 A mask specifying which bits in the LSS address of the slave device are already known and can be skipped during scanning. More...
 
- Data Fields inherited from lely::canopen::detail::LssScanRequestBase
LssAddress address {0, 0, 0, 0}
 On success, the LSS address of the detected slave device. More...
 
- 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 Fastscan' request.

Definition at line 775 of file lss_master.hpp.

Member Typedef Documentation

◆ Signature

The signature of the callback function invoked on completion of an 'LSS Fastscan' 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).
idthe node-ID reported by the slave device.

Definition at line 786 of file lss_master.hpp.

Constructor & Destructor Documentation

◆ LssFastscanRequest()

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

Constructs an empty 'LSS Fastscan' request with a completion task.

The bits of the LSS address of the slave device which are already known and a mask specifying which which can be skipped have to be set before the request can be submitted.

Definition at line 795 of file lss_master.hpp.


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