CANPeakSysUSB Class Reference

#include <CanPeakSysUSB.h>

Inheritance diagram for CANPeakSysUSB:

[legend]

List of all members.

Public Member Functions
	CANPeakSysUSB (const char *cIniFile)
void	destroy ()
void	init ()
bool	isObjectMode ()
bool	receiveMsg (CanMsg *pCMsg)
bool	receiveMsgRetry (CanMsg *pCMsg, int iNrOfRetry)
bool	transmitMsg (CanMsg CMsg, bool bBlocking=true)
	~CANPeakSysUSB ()
Private Attributes
bool	m_bInitialized
bool	m_bSimuEnabled
HANDLE	m_handle
IniFile	m_IniFile
Static Private Attributes
static const int	c_iInterrupt
static const int	c_iPort

---

Detailed Description

Definition at line 62 of file CanPeakSysUSB.h.

---

Constructor & Destructor Documentation

CANPeakSysUSB::CANPeakSysUSB

(

const char *

cIniFile

)

Definition at line 64 of file CanPeakSysUSB.cpp.

CANPeakSysUSB::~CANPeakSysUSB

(

)

Definition at line 75 of file CanPeakSysUSB.cpp.

---

Member Function Documentation

void CANPeakSysUSB::destroy

(

)

[inline]

Definition at line 69 of file CanPeakSysUSB.h.

void CANPeakSysUSB::init

(

)

[virtual]

Initializes the CAN bus.

Implements CanItf.

Definition at line 84 of file CanPeakSysUSB.cpp.

bool CANPeakSysUSB::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 73 of file CanPeakSysUSB.h.

bool CANPeakSysUSB::receiveMsg

(

CanMsg *

pCMsg

)

[virtual]

Reads a CAN message.

Returns:

true if a message is available

Implements CanItf.

Definition at line 174 of file CanPeakSysUSB.cpp.

bool CANPeakSysUSB::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 206 of file CanPeakSysUSB.cpp.

bool CANPeakSysUSB::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 144 of file CanPeakSysUSB.cpp.

---

Member Data Documentation

const int CANPeakSysUSB::c_iInterrupt [static, private]

Definition at line 83 of file CanPeakSysUSB.h.

const int CANPeakSysUSB::c_iPort [static, private]

Definition at line 84 of file CanPeakSysUSB.h.

bool CANPeakSysUSB::m_bInitialized [private]

Definition at line 79 of file CanPeakSysUSB.h.

bool CANPeakSysUSB::m_bSimuEnabled [private]

Definition at line 81 of file CanPeakSysUSB.h.

HANDLE CANPeakSysUSB::m_handle [private]

Definition at line 77 of file CanPeakSysUSB.h.

IniFile CANPeakSysUSB::m_IniFile [private]

Definition at line 80 of file CanPeakSysUSB.h.

---

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

• CanPeakSysUSB.h
• CanPeakSysUSB.cpp