canserial-peak.h

Go to the documentation of this file.

//======================================================================
//======================================================================

#ifndef CANSERIAL_PEAK_H_
#define CANSERIAL_PEAK_H_

//----------------------------------------------------------------------
// System Includes - include with <>
//----------------------------------------------------------------------


//----------------------------------------------------------------------
// Project Includes - include with ""
//----------------------------------------------------------------------

#include "sdhexception.h"
#include "serialbase.h"
#include "basisdef.h"
#include "sdhlibrary_settings.h"

#if defined( OSNAME_LINUX )
# include <libpcan.h>
// Linux libpcan uses HANDLE where Windows Pcan_usb.h uses no handle at all:
# define PCAN_HANDLE HANDLE

#elif defined( OSNAME_CYGWIN )
// on cygwin Pcan_usb.h includes windef.h which defines macros named max/min which the compiler confuses with max/min templates
// but defining NOMINMAX prevents those evil macros from being defined
# define NOMINMAX
# include <windows.h>
# include <Pcan_usb.h>
// Linux libpcan uses HANDLE where Windows Pcan_usb.h uses no handle at all:
typedef void* PCAN_HANDLE; // dummy definition

#elif SDH_USE_VCC
# include <windows.h>
# include <Pcan_usb.h>
// Linux libpcan uses HANDLE where Windows Pcan_usb.h uses no handle at all:
typedef void* PCAN_HANDLE; // dummy definition

#else
# error "FIXME: support for PEAK CAN devices in other systems than linux/cygwin is not provided yet!"
        // e.g. the include header from peak is named libpcan.h on linux and peak_usb.h on windows
#endif
#include "sdhlibrary_settings.h"


//----------------------------------------------------------------------
// Defines, enums, unions, structs,
//----------------------------------------------------------------------

NAMESPACE_SDH_START

//----------------------------------------------------------------------
// Global variables
//----------------------------------------------------------------------


//----------------------------------------------------------------------
// Function and class member declarations
//----------------------------------------------------------------------





class cCANSerial_PEAKException: public cSerialBaseException
{
public:
   cCANSerial_PEAKException( cMsg const & _msg )
       : cSerialBaseException( "cCANSerial_PEAKException", _msg )
   {}
};
//======================================================================


class cCANSerial_PEAK : public cSerialBase
{

protected:

    unsigned long baudrate;

    DWORD id_read;

    DWORD id_write;

    PCAN_HANDLE handle;

    WORD BaudrateToBaudrateCode( unsigned long baudrate )
    throw (cCANSerial_PEAKException*);

    char m_device[64];

private:

#if defined( OSNAME_LINUX )
    int timeout_us; // timeout in micro seconds
#else
    // The cygwin/windows version of the PEAK library/driver cannot handle timeouts...
#endif

#if defined( OSNAME_LINUX )
    TPCANRdMsg m_cmsg;
#   define M_CMSG_MSG() m_cmsg.Msg
#else
    TPCANMsg m_cmsg;
#   define M_CMSG_MSG() m_cmsg
#endif

    int m_cmsg_next;

public:
   cCANSerial_PEAK( unsigned long _baudrate, double _timeout, Int32 _id_read, Int32 _id_write, const char *device="/dev/pcanusb0" )
       throw (cCANSerial_PEAKException*);

   cCANSerial_PEAK( PCAN_HANDLE _handle, double _timeout, Int32 _id_read, Int32 _id_write )
       throw (cCANSerial_PEAKException*);

   PCAN_HANDLE GetHandle()
   {
       return handle;
   }

   void Open( void )
       throw (cCANSerial_PEAKException*);

   bool IsOpen( void )
       throw();

   void Close( void )
       throw (cCANSerial_PEAKException*);


   int write( char const *ptr, int len=0 )
       throw (cCANSerial_PEAKException*);

   ssize_t Read( void *data, ssize_t size, long timeout_us, bool return_on_less_data )
       throw (cCANSerial_PEAKException*);

   void SetTimeout( double _timeout )
       throw (cSerialBaseException*);
};
//======================================================================

NAMESPACE_SDH_END

#endif


//======================================================================
/*
 Here are some settings for the emacs/xemacs editor (and can be safely ignored):
 (e.g. to explicitely set C++ mode for *.h header files)

 Local Variables:
 mode:C++
 mode:ELSE
 End:
*/
//======================================================================

---

cob_sdh
Author(s): Florian Weisshardt
autogenerated on Fri Jan 11 10:03:52 2013