Lely core libraries 2.3.2
Public Member Functions
lely::io::CanControllerBase Class Reference

A reference to an abstract CAN controller. More...

#include <can.hpp>

Inheritance diagram for lely::io::CanControllerBase:
Inheritance graph
[legend]

Public Member Functions

void stop (::std::error_code &ec) noexcept
 
void stop ()
 
bool stopped (::std::error_code &ec) const noexcept
 
bool stopped () const
 
void restart (::std::error_code &ec) noexcept
 
void restart ()
 
void get_bitrate (int *pnominal, int *pdata, ::std::error_code &ec) const noexcept
 
void get_bitrate (int *pnominal, int *pdata=nullptr) const
 
void set_bitrate (int nominal, int data, ::std::error_code &ec) noexcept
 
void set_bitrate (int nominal, int data=0)
 
CanState get_state (::std::error_code &ec) const noexcept
 
CanState get_state () const
 

Detailed Description

A reference to an abstract CAN controller.

This class is a wrapper around #io_can_ctrl_t*.

Definition at line 286 of file can.hpp.

Member Function Documentation

◆ stop() [1/2]

void lely::io::CanControllerBase::stop ( ::std::error_code &  ec)
inlinenoexcept
See also
io_can_ctrl_stop()

Definition at line 294 of file can.hpp.

◆ stop() [2/2]

void lely::io::CanControllerBase::stop ( )
inline
See also
io_can_ctrl_stop()

Definition at line 306 of file can.hpp.

◆ stopped() [1/2]

bool lely::io::CanControllerBase::stopped ( ::std::error_code &  ec) const
inlinenoexcept
See also
io_can_ctrl_stopped()

Definition at line 314 of file can.hpp.

◆ stopped() [2/2]

bool lely::io::CanControllerBase::stopped ( ) const
inline
See also
io_can_ctrl_stopped()

Definition at line 330 of file can.hpp.

◆ restart() [1/2]

void lely::io::CanControllerBase::restart ( ::std::error_code &  ec)
inlinenoexcept
See also
io_can_ctrl_restart()

Definition at line 339 of file can.hpp.

◆ restart() [2/2]

void lely::io::CanControllerBase::restart ( )
inline
See also
io_can_ctrl_restart()

Definition at line 351 of file can.hpp.

◆ get_bitrate() [1/2]

void lely::io::CanControllerBase::get_bitrate ( int *  pnominal,
int *  pdata,
::std::error_code &  ec 
) const
inlinenoexcept
See also
io_can_ctrl_get_bitrate()

Definition at line 359 of file can.hpp.

◆ get_bitrate() [2/2]

void lely::io::CanControllerBase::get_bitrate ( int *  pnominal,
int *  pdata = nullptr 
) const
inline
See also
io_can_ctrl_get_bitrate()

Definition at line 371 of file can.hpp.

◆ set_bitrate() [1/2]

void lely::io::CanControllerBase::set_bitrate ( int  nominal,
int  data,
::std::error_code &  ec 
)
inlinenoexcept
See also
io_can_ctrl_get_bitrate()

Definition at line 379 of file can.hpp.

◆ set_bitrate() [2/2]

void lely::io::CanControllerBase::set_bitrate ( int  nominal,
int  data = 0 
)
inline
See also
io_can_ctrl_get_bitrate()

Definition at line 391 of file can.hpp.

◆ get_state() [1/2]

CanState lely::io::CanControllerBase::get_state ( ::std::error_code &  ec) const
inlinenoexcept
See also
io_can_ctrl_get_state()

Definition at line 399 of file can.hpp.

◆ get_state() [2/2]

CanState lely::io::CanControllerBase::get_state ( ) const
inline
See also
io_can_ctrl_get_state()

Definition at line 415 of file can.hpp.

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