VLCB
Loading...
Searching...
No Matches
VLCB::CanTransport Class Referenceabstract

Interface base class for CAN transport implementations. More...

#include <CanTransport.h>

Inheritance diagram for VLCB::CanTransport:
VLCB::Transport VLCB::SerialGC

Public Member Functions

virtual bool available ()=0
 Check if an incoming CAN frame is available on the CAN bus.
virtual CANFrame getNextCanFrame ()=0
 Get the next CAN frame from the CAN bus.
virtual bool sendCanFrame (CANFrame *msg)=0
 Send a CAN frame to the CAN bus.
virtual byte getHardwareType ()
Public Member Functions inherited from VLCB::Transport
virtual void reset ()=0
virtual unsigned int receiveCounter ()=0
virtual unsigned int transmitCounter ()=0
virtual unsigned int receiveBufferSize ()=0
virtual unsigned int transmitBufferSize ()=0
virtual unsigned int receiveErrorCounter ()=0
virtual unsigned int transmitErrorCounter ()=0
virtual unsigned int receiveBufferUsage ()=0
virtual unsigned int transmitBufferUsage ()=0
virtual unsigned int receiveBufferPeak ()=0
virtual unsigned int transmitBufferPeak ()=0
virtual unsigned int errorStatus ()=0

Detailed Description

Interface base class for CAN transport implementations.

A concrete class derived from CanTransport must be used with CanService.

Note
There are more concrete classes outside this VLCB-Arduino library.

Member Function Documentation

◆ available()

virtual bool VLCB::CanTransport::available ( )
pure virtual

Check if an incoming CAN frame is available on the CAN bus.

Implemented in VLCB::SerialGC.

◆ getNextCanFrame()

virtual CANFrame VLCB::CanTransport::getNextCanFrame ( )
pure virtual

Get the next CAN frame from the CAN bus.

Implemented in VLCB::SerialGC.

◆ sendCanFrame()

virtual bool VLCB::CanTransport::sendCanFrame ( CANFrame * msg)
pure virtual

Send a CAN frame to the CAN bus.

Implemented in VLCB::SerialGC.

◆ getHardwareType()

virtual byte VLCB::CanTransport::getHardwareType ( )
inlinevirtual

Get the hardware type of the concrete transport class.

Reimplemented in VLCB::SerialGC.


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