Menu

device::nic::CAN::XenomaiRTCANDriver< IDDesc > Class Template Reference

The generic driver interface to the XenomaiRTCAN hardware. More...

#include <XenomaiRTCANDriver.h>

Data Structures

class  MOB

Public Member Functions

 XenomaiRTCANDriver ()
 ~XenomaiRTCANDriver ()
void report_error_and_exit (int error_value, const char *reporter)
bool read (MOB &mob)
void write (MOB &mob)
 transmits a CAN message object
void init ()
 initalize the driver by trying to open and bind a socket

Detailed Description

template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
class device::nic::CAN::XenomaiRTCANDriver< IDDesc >

The generic driver interface to the XenomaiRTCAN hardware.

Constructor & Destructor Documentation

template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
device::nic::CAN::XenomaiRTCANDriver< IDDesc >::XenomaiRTCANDriver (  )  [inline, explicit]
template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
device::nic::CAN::XenomaiRTCANDriver< IDDesc >::~XenomaiRTCANDriver (  )  [inline]

Member Function Documentation

template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
void device::nic::CAN::XenomaiRTCANDriver< IDDesc >::init (  )  [inline]

initalize the driver by trying to open and bind a socket

References AF_CAN, and PF_CAN.

template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
bool device::nic::CAN::XenomaiRTCANDriver< IDDesc >::read ( MOB &  mob  )  [inline]

try receiving a CAN message object

Parameters:
[out] mob is filled with a received message
Returns:
true if, a message was received
false otherwise

References device::nic::CAN::XenomaiRTCANDriver< IDDesc >::report_error_and_exit().

template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
void device::nic::CAN::XenomaiRTCANDriver< IDDesc >::report_error_and_exit ( int  error_value,
const char *  reporter 
) [inline]

Referenced by device::nic::CAN::XenomaiRTCANDriver< IDDesc >::read(), and device::nic::CAN::XenomaiRTCANDriver< IDDesc >::write().

template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
void device::nic::CAN::XenomaiRTCANDriver< IDDesc >::write ( MOB &  mob  )  [inline]

transmits a CAN message object

Parameters:
[in] mob that has to be transmitted

References device::nic::CAN::XenomaiRTCANDriver< IDDesc >::report_error_and_exit().

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