Lely core libraries 2.3.5
Public Member Functions
lely::io::VirtualCanController Class Reference

A virtual CAN controller. More...

#include <vcan.hpp>

Inheritance diagram for lely::io::VirtualCanController:
Inheritance graph
[legend]
Collaboration diagram for lely::io::VirtualCanController:
Collaboration graph
[legend]

Public Member Functions

 VirtualCanController (io_clock_t *clock, CanBusFlag flags=CanBusFlag::MASK, int nominal=0, int data=0, CanState state=CanState::ACTIVE)
 
 ~VirtualCanController ()
 
void set_state (CanState state)
 
void write (const can_msg &msg, int timeout, ::std::error_code &ec) noexcept
 
void write (const can_msg &msg, int timeout=-1)
 
void write (const can_err &err, int timeout, ::std::error_code &ec) noexcept
 
void write (const can_err &err, int timeout=-1)
 
- Public Member Functions inherited from lely::io::CanControllerBase
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 virtual CAN controller.

Definition at line 37 of file vcan.hpp.

Constructor & Destructor Documentation

◆ VirtualCanController()

lely::io::VirtualCanController::VirtualCanController ( io_clock_t * clock,
CanBusFlag flags = CanBusFlag::MASK,
int nominal = 0,
int data = 0,
CanState state = CanState::ACTIVE )
inline
See also
io_vcan_ctrl_create()

Definition at line 40 of file vcan.hpp.

◆ ~VirtualCanController()

lely::io::VirtualCanController::~VirtualCanController ( )
inline
See also
io_vcan_ctrl_destroy()

Definition at line 66 of file vcan.hpp.

Member Function Documentation

◆ set_state()

void lely::io::VirtualCanController::set_state ( CanState state)
inline
See also
io_vcan_ctrl_set_state()

Definition at line 70 of file vcan.hpp.

◆ write() [1/4]

void lely::io::VirtualCanController::write ( const can_msg & msg,
int timeout,
::std::error_code & ec )
inlinenoexcept
See also
io_vcan_ctrl_write_msg()

Definition at line 76 of file vcan.hpp.

◆ write() [2/4]

void lely::io::VirtualCanController::write ( const can_msg & msg,
int timeout = -1 )
inline
See also
io_vcan_ctrl_write_msg()

Definition at line 88 of file vcan.hpp.

◆ write() [3/4]

void lely::io::VirtualCanController::write ( const can_err & err,
int timeout,
::std::error_code & ec )
inlinenoexcept
See also
io_vcan_ctrl_write_err()

Definition at line 96 of file vcan.hpp.

◆ write() [4/4]

void lely::io::VirtualCanController::write ( const can_err & err,
int timeout = -1 )
inline
See also
io_vcan_ctrl_write_msg()

Definition at line 108 of file vcan.hpp.

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