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

An LSS 'switch state selective' request. More...

#include <lss_master.hpp>

Inheritance diagram for lely::canopen::LssSwitchSelectiveRequest:
Collaboration diagram for lely::canopen::LssSwitchSelectiveRequest:

Public Types

using Signature = void(::std::error_code ec)
 The signature of the callback function invoked on completion of an LSS 'switch state selective' request. More...
 

Public Member Functions

template<class F >
 LssSwitchSelectiveRequest (ev_exec_t *exec, F &&con)
 Constructs an empty LSS 'switch state selective' request with a completion task. More...
 
template<class F >
 LssSwitchSelectiveRequest (F &&con)
 Equivalent to LssSwitchSelectiveRequest(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::LssSwitchSelectiveRequestBase
LssAddress address {0, 0, 0, 0}
 The address of the LSS slave device to be switched into the configuration state.
 
- 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 'switch state selective' request.

Definition at line 332 of file lss_master.hpp.

Member Typedef Documentation

◆ Signature

The signature of the callback function invoked on completion of an LSS 'switch state selective' 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 342 of file lss_master.hpp.

Constructor & Destructor Documentation

◆ LssSwitchSelectiveRequest()

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

Constructs an empty LSS 'switch state selective' request with a completion task.

The address of the LSS slave device to be switched into the configuration state has to be set before the request can be submitted.

Definition at line 350 of file lss_master.hpp.


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