Menu

device::nic::CAN::PeakDriver< PeakTrait > Class Template Reference

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

#include <PeakDriver.h>

Public Member Functions

void init ()
void write (typename PeakTrait::MOB &mob)
bool read (typename PeakTrait::MOB &mob)

Detailed Description

template<class PeakTrait>
class device::nic::CAN::PeakDriver< PeakTrait >

The generic driver interface to the PeakCAN hardware.

This generic driver for the PeakCAN hardware allows transmitting and receiving of CAN messages. It has to configured via a trait the defines the peculiarity of the underling platform (Linux or Windows)

Member Function Documentation

template<class PeakTrait >
void device::nic::CAN::PeakDriver< PeakTrait >::init (  )  [inline]

inialize the driver and it subobjects

template<class PeakTrait >
bool device::nic::CAN::PeakDriver< PeakTrait >::read ( typename PeakTrait::MOB &  mob  )  [inline]

try receiving a CAN message object

Parameters:
[out] mob that will befilled with a received message
Returns:
true if, a message was received
false otherwise
template<class PeakTrait >
void device::nic::CAN::PeakDriver< PeakTrait >::write ( typename PeakTrait::MOB &  mob  )  [inline]

transmits a CAN message object

Parameters:
[in] mob that has to be transmitted
The documentation for this class was generated from the following file: