Public Member Functions
can::DriverInterface Class Reference

#include <interface.h>

Inheritance diagram for can::DriverInterface:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool doesLoopBack () const =0
virtual State getState ()=0
virtual bool init (const std::string &device, bool loopback)=0
virtual bool recover ()=0
virtual void run ()=0
virtual void shutdown ()=0
virtual bool translateError (unsigned int internal_error, std::string &str)=0
virtual ~DriverInterface ()

Detailed Description

Definition at line 151 of file interface.h.


Constructor & Destructor Documentation

virtual can::DriverInterface::~DriverInterface ( ) [inline, virtual]

Definition at line 187 of file interface.h.


Member Function Documentation

virtual bool can::DriverInterface::doesLoopBack ( ) const [pure virtual]
virtual State can::DriverInterface::getState ( ) [pure virtual]
virtual bool can::DriverInterface::init ( const std::string &  device,
bool  loopback 
) [pure virtual]

initialize interface

Parameters:
[in]device,:driver-specific device name/path
[in]loopback,:loop-back own messages
Returns:
true if device was initialized succesfully, false otherwise

Implemented in can::DummyInterface, and can::SocketCANInterface.

virtual bool can::DriverInterface::recover ( ) [pure virtual]

Recover interface after errors and emergency stops

Returns:
true if device was recovered succesfully, false otherwise

Implemented in can::SocketCANInterface, and can::DummyInterface.

virtual void can::DriverInterface::run ( ) [pure virtual]
virtual void can::DriverInterface::shutdown ( ) [pure virtual]

shutdown interface

Returns:
true if shutdown was succesful, false otherwise

Implemented in can::AsioDriver< Socket >, can::AsioDriver< boost::asio::posix::stream_descriptor >, and can::DummyInterface.

virtual bool can::DriverInterface::translateError ( unsigned int  internal_error,
std::string &  str 
) [pure virtual]

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


socketcan_interface
Author(s): Mathias L├╝dtke
autogenerated on Sun Sep 3 2017 03:10:38