Public Member Functions | List of all members
can::DriverInterface Class Referenceabstract

#include <interface.h>

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

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 ()
 
- Public Member Functions inherited from can::CommInterface
virtual FrameListenerConstSharedPtr createMsgListener (const FrameDelegate &delegate)=0
 
virtual FrameListenerConstSharedPtr createMsgListener (const Frame::Header &, const FrameDelegate &delegate)=0
 
virtual bool send (const Frame &msg)=0
 
virtual ~CommInterface ()
 
- Public Member Functions inherited from can::StateInterface
virtual StateListenerConstSharedPtr createStateListener (const StateDelegate &delegate)=0
 
virtual ~StateInterface ()
 

Additional Inherited Members

- Public Types inherited from can::CommInterface
typedef fastdelegate::FastDelegate1< const Frame & > FrameDelegate
 
typedef Listener< const FrameDelegate, const Frame & > FrameListener
 
typedef FrameListener::ListenerConstSharedPtr FrameListenerConstSharedPtr
 
- Public Types inherited from can::StateInterface
typedef fastdelegate::FastDelegate1< const State & > StateDelegate
 
typedef Listener< const StateDelegate, const State & > StateListener
 
typedef StateListener::ListenerConstSharedPtr StateListenerConstSharedPtr
 

Detailed Description

Definition at line 163 of file interface.h.

Constructor & Destructor Documentation

virtual can::DriverInterface::~DriverInterface ( )
inlinevirtual

Definition at line 199 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]devicedriver-specific device name/path
[in]loopbackloop-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 Fri May 14 2021 02:59:39