SocketCan Class Reference

#include <SocketCan.h>

Inheritance diagram for SocketCan:

List of all members.

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, int baudrate)
	SocketCan (const char *device)
bool	transmitMsg (CanMsg CMsg, bool bBlocking=true)
	~SocketCan ()
Private Member Functions
void	print_error (const can::State &state)
Private Attributes
bool	m_bInitialized
boost::shared_ptr < can::ThreadedSocketCANInterface >	m_handle
can::BufferedReader	m_reader
const char *	p_cDevice

---

Detailed Description

Definition at line 29 of file SocketCan.h.

---

Constructor & Destructor Documentation

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

Definition at line 28 of file SocketCan.cpp.

SocketCan::SocketCan

(

const char *

device

)

Definition at line 36 of file SocketCan.cpp.

SocketCan::~SocketCan

(

)

Definition at line 45 of file SocketCan.cpp.

---

Member Function Documentation

void SocketCan::init

(

)

[virtual]

Initializes the CAN bus.

Implements CanItf.

Definition at line 73 of file SocketCan.cpp.

bool SocketCan::init_ret

(

)

[virtual]

Initializes the CAN bus and returns success.

Implements CanItf.

Definition at line 54 of file SocketCan.cpp.

bool SocketCan::isObjectMode

(

)

[inline, virtual]

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.

void SocketCan::print_error

(

const can::State &

state

)

[private]

Definition at line 167 of file SocketCan.cpp.

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.

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.

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.

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

bool SocketCan::m_bInitialized [private]

Definition at line 51 of file SocketCan.h.

boost::shared_ptr<can::ThreadedSocketCANInterface> SocketCan::m_handle [private]

Definition at line 48 of file SocketCan.h.

can::BufferedReader SocketCan::m_reader [private]

Definition at line 49 of file SocketCan.h.

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