canserial-esd.h

Go to the documentation of this file.

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

#ifndef CANSERIAL_ESD_H_
#define CANSERIAL_ESD_H_

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


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

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

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

NAMESPACE_SDH_START

#define CAN_ESD_TXQUEUESIZE 32

#define CAN_ESD_RXQUEUESIZE 512

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


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

class cCANSerial_ESD_Internal;


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

class VCC_EXPORT cCANSerial_ESD : public cSerialBase
{

protected:

    int net;

    unsigned long baudrate;

    int id_read;

    int id_write;

    // ntcan_handle was removed from here, see class comment and GetHandle()

    unsigned int BaudrateToBaudrateCode( unsigned long baudrate )
        throw (cCANSerial_ESDException*);

    int status;

private:
    cCANSerial_ESD_Internal* pimpl;

    cCANSerial_ESD( cCANSerial_ESD const& other );

    cCANSerial_ESD& operator=( cCANSerial_ESD const& rhs );

public:
    cCANSerial_ESD( int _net, unsigned long _baudrate, double _timeout, int _id_read, int _id_write )
        throw (cCANSerial_ESDException*);

    cCANSerial_ESD( tDeviceHandle _ntcan_handle, double _timeout, int _id_read, int _id_write )
        throw (cCANSerial_ESDException*);

    ~cCANSerial_ESD();

    void Open( void )
        throw (cCANSerial_ESDException*);

    bool IsOpen( void )
        throw();

    void Close( void )
        throw (cCANSerial_ESDException*);


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

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

    void SetTimeout( double _timeout )
        throw (cSerialBaseException*);

    virtual tErrorCode GetErrorNumber();

    virtual char const* GetErrorMessage( tErrorCode dw );

    tDeviceHandle GetHandle();
};
//======================================================================

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:
*/
//======================================================================