blmc_drivers
blmc_drivers::CanBusInterface Class Referenceabstract

CanBusInterface is an abstract class that defines an API for the communication via Can bus. More...

#include <can_bus.hpp>

Inheritance diagram for blmc_drivers::CanBusInterface:
Collaboration diagram for blmc_drivers::CanBusInterface:

Public Types

typedef real_time_tools::ThreadsafeTimeseries< CanBusFrameCanframeTimeseries
 CanframeTimeseries is a simple sohortcut.
 

Public Member Functions

virtual ~CanBusInterface ()
 Destroy the CanBusInterface object.
 
virtual std::shared_ptr< const CanframeTimeseriesget_output_frame () const =0
 getters More...
 
virtual std::shared_ptr< const CanframeTimeseriesget_input_frame ()=0
 Get the input frame. More...
 
virtual std::shared_ptr< const CanframeTimeseriesget_sent_input_frame ()=0
 Get the sent input frame. More...
 
virtual void set_input_frame (const CanBusFrame &input_frame)=0
 setters More...
 
virtual void send_if_input_changed ()=0
 Sender. More...
 

Detailed Description

CanBusInterface is an abstract class that defines an API for the communication via Can bus.

Member Function Documentation

◆ get_input_frame()

virtual std::shared_ptr<const CanframeTimeseries> blmc_drivers::CanBusInterface::get_input_frame ( )
pure virtual

Get the input frame.

Returns
std::shared_ptr<const CanframeTimeseries>

Implemented in blmc_drivers::CanBus.

◆ get_output_frame()

virtual std::shared_ptr<const CanframeTimeseries> blmc_drivers::CanBusInterface::get_output_frame ( ) const
pure virtual

getters

Get the output frame

Returns
std::shared_ptr<const CanframeTimeseries>

Implemented in blmc_drivers::CanBus.

◆ get_sent_input_frame()

virtual std::shared_ptr<const CanframeTimeseries> blmc_drivers::CanBusInterface::get_sent_input_frame ( )
pure virtual

Get the sent input frame.

Returns
std::shared_ptr<const CanframeTimeseries>

Implemented in blmc_drivers::CanBus.

◆ send_if_input_changed()

virtual void blmc_drivers::CanBusInterface::send_if_input_changed ( )
pure virtual

Sender.

send all the input frame to the can network

Implemented in blmc_drivers::CanBus.

◆ set_input_frame()

virtual void blmc_drivers::CanBusInterface::set_input_frame ( const CanBusFrame input_frame)
pure virtual

setters

Set the input frame saves the input frame to be sent in a queue.

Parameters
input_frame

Implemented in blmc_drivers::CanBus.


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