SocketCan Class Reference

#include <SocketCan.h>

Inheritance diagram for SocketCan:

Public Member Functions
void	init ()
bool	init_ret ()
bool	isObjectMode ()
bool	receiveMsg (CanMsg *pCMsg)
bool	receiveMsgRetry (CanMsg *pCMsg, int iNrOfRetry)
bool	receiveMsgTimeout (CanMsg *pCMsg, int nMicroSecTimeout)
	SocketCan (const char *device)
	SocketCan (const char *device, int baudrate)
bool	transmitMsg (CanMsg CMsg, bool bBlocking=true)
	~SocketCan ()
Public Member Functions inherited from CanItf
CanItfType	getCanItfType ()
void	setCanItfType (CanItfType iType)
virtual	~CanItf ()

Private Member Functions
void	print_error (const can::State &state)

Private Attributes
bool	m_bInitialized
can::ThreadedSocketCANInterfaceSharedPtr	m_handle
can::BufferedReader	m_reader
const char *	p_cDevice

Additional Inherited Members
Public Types inherited from CanItf
enum	CanItfType {   CAN_PEAK = 0, CAN_PEAK_USB = 1, CAN_ESD = 2, CAN_DUMMY = 3,   CAN_BECKHOFF = 4, CAN_SOCKETCAN = 5 }

Detailed Description

Definition at line 29 of file SocketCan.h.

Constructor & Destructor Documentation

SocketCan() [1/2]

SocketCan::SocketCan	(	const char *	device,
		int	baudrate
	)

Definition at line 28 of file SocketCan.cpp.

SocketCan() [2/2]

SocketCan::SocketCan

(

const char *

device

)

Definition at line 36 of file SocketCan.cpp.

~SocketCan()

SocketCan::~SocketCan

(

)

Definition at line 45 of file SocketCan.cpp.

Member Function Documentation

init()

void SocketCan::init ( )

virtual

Initializes the CAN bus.

Implements CanItf.

Definition at line 73 of file SocketCan.cpp.

init_ret()

bool SocketCan::init_ret ( )

virtual

Initializes the CAN bus and returns success.

Implements CanItf.

Definition at line 54 of file SocketCan.cpp.

isObjectMode()

bool SocketCan::isObjectMode ( )

inlinevirtual

Check if the current CAN interface was opened on OBJECT mode.

Returns

true if opened in OBJECT mode, false if not.

Implements CanItf.

Definition at line 42 of file SocketCan.h.

print_error()

void SocketCan::print_error ( const can::State &  state )

private

Definition at line 167 of file SocketCan.cpp.

receiveMsg()

bool SocketCan::receiveMsg ( CanMsg *  pCMsg )

virtual

Reads a CAN message.

Returns

true if a message is available

Implements CanItf.

Definition at line 96 of file SocketCan.cpp.

receiveMsgRetry()

bool SocketCan::receiveMsgRetry ( CanMsg *  pCMsg, int  iNrOfRetry  )

virtual

Reads a CAN message. The function blocks between the attempts.

Parameters

pCMsg	CAN message
iNrOfRetry	number of retries

Returns

true if a message is available

Implements CanItf.

Definition at line 118 of file SocketCan.cpp.

receiveMsgTimeout()

bool SocketCan::receiveMsgTimeout ( CanMsg *  pCMsg, int  nMicroSecTimeout  )

virtual

Reads a CAN message with timeout.

Parameters

pCMsg	CAN message
nMicroSecTimeout	timeout in us

Returns

true if a message is available

Implements CanItf.

Definition at line 147 of file SocketCan.cpp.

transmitMsg()

bool SocketCan::transmitMsg ( CanMsg  CMsg, bool  bBlocking = true  )

virtual

Sends a CAN message.

Parameters

pCMsg	CAN message
bBlocking	specifies whether send should be blocking or non-blocking

Implements CanItf.

Definition at line 84 of file SocketCan.cpp.

Member Data Documentation

m_bInitialized

bool SocketCan::m_bInitialized

private

Definition at line 51 of file SocketCan.h.

m_handle

can::ThreadedSocketCANInterfaceSharedPtr SocketCan::m_handle

private

Definition at line 48 of file SocketCan.h.

m_reader

can::BufferedReader SocketCan::m_reader

private

Definition at line 49 of file SocketCan.h.

p_cDevice

const char* SocketCan::p_cDevice

private

Definition at line 52 of file SocketCan.h.

---

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

• SocketCan.h
• SocketCan.cpp