$search

CanPeakSys Class Reference

#include <CanPeakSys.h>

Inheritance diagram for CanPeakSys:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CanPeakSys (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)
 ~CanPeakSys ()

Private Attributes

bool m_bInitialized
bool m_bSimuEnabled
HANDLE m_handle
IniFile m_IniFile

Static Private Attributes

static const int c_iInterrupt = 7
static const int c_iPort = 0x378

Detailed Description

Definition at line 63 of file CanPeakSys.h.


Constructor & Destructor Documentation

CanPeakSys::CanPeakSys ( const char *  cIniFile  ) 

Definition at line 67 of file CanPeakSys.cpp.

CanPeakSys::~CanPeakSys (  ) 

Definition at line 77 of file CanPeakSys.cpp.


Member Function Documentation

void CanPeakSys::destroy (  )  [inline]

Definition at line 70 of file CanPeakSys.h.

void CanPeakSys::init (  )  [virtual]

Initializes the CAN bus.

Implements CanItf.

Definition at line 86 of file CanPeakSys.cpp.

bool CanPeakSys::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 74 of file CanPeakSys.h.

bool CanPeakSys::receiveMsg ( CanMsg pCMsg  )  [virtual]

Reads a CAN message.

Returns:
true if a message is available

Implements CanItf.

Definition at line 175 of file CanPeakSys.cpp.

bool CanPeakSys::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 212 of file CanPeakSys.cpp.

bool CanPeakSys::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 145 of file CanPeakSys.cpp.


Member Data Documentation

const int CanPeakSys::c_iInterrupt = 7 [static, private]

Definition at line 84 of file CanPeakSys.h.

const int CanPeakSys::c_iPort = 0x378 [static, private]

Definition at line 85 of file CanPeakSys.h.

Definition at line 80 of file CanPeakSys.h.

Definition at line 82 of file CanPeakSys.h.

HANDLE CanPeakSys::m_handle [private]

Definition at line 78 of file CanPeakSys.h.

Definition at line 81 of file CanPeakSys.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends


cob_generic_can
Author(s): Christian Connette
autogenerated on Fri Mar 1 14:47:50 2013