Beesnest/Adapters/BnSerialPort/BnSerialPort.h

Go to the documentation of this file.

#ifndef __BN_SERIAL_PORT
#define __BN_SERIAL_PORT

#include "../../Interfaces/BufferHolder.h"
#include "../../Interfaces/DcAdapter.h"

#include <string>
#include <iostream>
using namespace std;

#include <windows.h>
#include <winbase.h>

#define DEFAULT_SETTINGS    "baud=96 parity=E data=8 stop=1"
#define DEFAULT_PORT        "COM1"

/**
 * This class is a Serial Port adapter for Beensest. It will work only on Windows<br>
 * <b>Write</b>: always write the buffer <b>address</b> to the port.<br>
 * <b>Read</b>: if <b>address</b> is empty, it reads the data from the port.
 * if address is <b>_LastError</b> it returns an error message of the last
 * operation (or "OK").
 * <p>
 * Configuration: <br>
 * <b>COM</b> = "COMx", x is the port number you want to work with.<br>
 * <b>Settings</b> = "[baud=b] [parity=p] [data=d] [stop=s]
 * [to={on|off}] [xon={on|off}] [odsr={on|off}] [octs={on|off}]
 * [dtr={on|off|hs}] [rts={on|off|hs|tg}] [idsr={on|off}]"<br>
 * baud = b : Specifies the transmission rate in bits per second.<br>
 * 11 = 110 baud, 15 = 150 baud, 30 = 300 baud, 60 = 600 baud, 12 = 1200 baud,
 * 24 = 2400 baud, 48 = 4800 baud, 96 = 9600 baud, 19 = 19,200 baud <br>
 * parity = p : Specifies how to check for transmission errors. <br>
 * n = none, e = even, o = odd, m = mark, s = space <br>
 * data = d : Specifies the number of data bits in a byte (5 - 8).<br>
 * stop = s : Specifies the number of stop bits that define the end of a byte
 *  (1, 1.5, or 2).<br><br>
 * <b>Read-Interval-Timeout</b> - Maximum time allowed to elapse between the
 *  arrival of two bytes on the communications line, in milliseconds.A value of
 *  zero indicates that interval time-outs are not used.<br>
 * <b>Read-Total-Timeout-Multiplier</b> - Multiplier used to calculate the total
 *  time-out period for read operations, in milliseconds. For each read
 *  operation, this value is multiplied by the requested number of bytes to be
 *  read.<br>
 * <b>Read-Total-Timeout-Constant</b> - Constant used to calculate the total
 *  time-out period, in milliseconds. This value is added to the product on
 *  Read-Total-Timeout-Multiplier. A value of zero for both the
 *  Read-Total-Timeout-Multiplier and Read-Total-Timeout-Constant indicates that
 *  total time-outs are not used for read operations.<br>
 * <b>Write-Total-Timeout-Multiplier</b> - Like Read-Total-Timeout-Multiplier.<br>
 * <b>Write-Total-Timeout-Constant</b> - Like Read-Total-Timeout-Constant.
 */
class BnSerialPort : public IdcAdapter
{
private:
    /** Pointer to a function of Beesnest to get parameters from the
        configuration files. */
    bool (*pfGetParam)(const char*, char*, int);

    /** Stores the name of this adapter object. */
    string sName;

    /** Flag to indicate an initialization error. */
    bool isInitErr;
    /** Stores the last error code (0 - OK). */
    int nLastErrCode;
    /** Stores the string this class returns to the user. */
    string sRetMsg;

    /** The name of the port "COMx". */
    string sPortName;
    /** The settings string for the port.*/
    string sPortSettings;
    /** Handle to the port. */
    HANDLE hPort;
    /** Timeouts Struct. */
    COMMTIMEOUTS oTimes;

    /** Returns True if the port is open. */
    bool IsPortOpen () { return hPort != NULL; }

    /** Closes the port. */
    void ClosePort ();

    /** Add the last error code to the error message string. */
    void AddLastErrorCode ();

public:
    /** Constructor. */
    BnSerialPort (const char* name, bool (*pGetParam)(const char*, char*, int));

    /** Destructor. */
    ~BnSerialPort ();

    /** Read data from the port. */
    virtual BufferHolder Read (BufferHolder address) throw (BufferHolder);

    /** Write data to the port. */
    virtual bool Write (BufferHolder address, BufferHolder value) throw (BufferHolder);

    /** This adapter is NOT for multi-use. */
    virtual bool IsMultiUse ()
    { return false; }
};

#endif /* __BN_SERIAL_PORT */