CANAdapter Class Reference

Abstracts CAN hardware object representation. Has protected constructor. Instance of the object has to be done via CANAdapter::createCANAdapter method. More...

#include <canadapter.h>

Inheritance diagram for CANAdapter:

Public Member Functions
virtual bool	start (const char *name)=0
virtual void	stop ()=0
virtual bool	sendFrame (const can_frame &frame)=0
virtual bool	registerCyclicMessageForReceive (int canId, double minCycleTime, double maxCycleTime)=0
virtual bool	unregisterMessageForReceive (int canId)=0

Static Public Member Functions
static CANAdapter *	createCANAdapter (CANObserver &observer)

Protected Member Functions
	CANAdapter (CANObserver &observer)

Protected Attributes
CANObserver &	mObserver

Detailed Description

Abstracts CAN hardware object representation. Has protected constructor. Instance of the object has to be done via CANAdapter::createCANAdapter method.

CANAdapter* pAdapter = CANAdapter::createCANAdapter(this); 

Constructor & Destructor Documentation

CANAdapter::CANAdapter ( CANObserver &  observer )

protected

Parameters

observer

Observer that will receives CAN bus frames

Member Function Documentation

CANAdapter::createCANAdapter ( CANObserver &  observer )

static

Creates and initializes CANAdapter instance

Parameters

observer

Observer that will receives CAN bus frames

Returns

Pointer to CANAdapter instance

CANAdapter::registerCyclicMessageForReceive ( int  canId, double  minCycleTime, double  maxCycleTime  )

pure virtual

Registers CAN ID of a cyclic message for receiving

Parameters

canId	CAN ID of the message.
minCycleTime	Minimal interval between messages in seconds. Set to 0 if not used.
maxCycleTime	Maximum interval between messages for timeout detection in seconds. Set to 0 if no timeout detection is necessary.

Returns

True if registration succeeds.

Implemented in CANSocketAdapter.

CANAdapter::sendFrame ( const can_frame &  frame )

pure virtual

Sends CAN frame over the bus

Parameters

frame

CAN frame to be sent

Returns

True if frame was sent

Implemented in CANSocketAdapter.

CANAdapter::start ( const char *  name )

pure virtual

Starts listening to CAN bus on the specified interface

Parameters

name	Name of the CAN bus interface

Returns

True if no error occurs.

Implemented in CANSocketAdapter.

CANAdapter::stop ( )

pure virtual

Stops listening to CAN bus

Implemented in CANSocketAdapter.

CANAdapter::unregisterMessageForReceive ( int  canId )

pure virtual

Un-registers CAN ID of a message used of receiving. Valid for cyclic and sporadic messages.

Parameters

canId

CAN ID of the message.

Returns

True if de-registration succeeds.

Implemented in CANSocketAdapter.

Member Data Documentation

CANAdapter::mObserver

protected

CANObserver instance reference

---

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

• /home/abuild/rpmbuild/BUILD/automotive-message-broker-0.15/plugins/common/canadapter.h