QextSerialBase Class Reference

#include <qextserialbase.h>

Inheritance diagram for QextSerialBase:

List of all members.

Public Member Functions
	aboutToClose ()
	atEnd ()
virtual bool	atEnd () const
virtual BaudRateType	baudRate () const
virtual qint64	bytesAvailable ()=0
	bytesToWrite ()
	bytesWritten (qint64 bytes)
	canReadLine ()
virtual void	close ()=0
virtual void	construct ()
virtual DataBitsType	dataBits () const
	errorString ()
virtual FlowType	flowControl () const
virtual void	flush ()=0
	getChar (char *c)
	isOpen ()
	isReadable ()
	isSequential ()
virtual bool	isSequential () const
	isTextModeEnabled ()
	isWritable ()
virtual ulong	lastError () const
virtual ulong	lineStatus ()=0
virtual bool	open (OpenMode mode=0)=0
	openMode ()
virtual ParityType	parity () const
	peek (qint64 maxSize)
	peek (char *data, qint64 maxSize)
virtual QString	portName () const
	pos ()
	putChar (char c)
	QextSerialBase (const QString &name)
	QextSerialBase ()
	read (qint64 maxSize)
	read (char *data, qint64 maxSize)
	readAll ()
	readLine (qint64 maxSize=0)
virtual qint64	readLine (char *data, qint64 maxSize)
	readLineData (char *data, qint64 maxSize)
	readyRead ()
	reset ()
	seek (qint64 pos)
virtual void	setBaudRate (BaudRateType)=0
virtual void	setDataBits (DataBitsType)=0
virtual void	setDtr (bool set=true)=0
	setErrorString (const QString &str)
virtual void	setFlowControl (FlowType)=0
	setOpenMode (OpenMode openMode)
virtual void	setParity (ParityType)=0
virtual void	setPortName (const QString &name)
virtual void	setRts (bool set=true)=0
virtual void	setStopBits (StopBitsType)=0
	setTextModeEnabled (bool enabled)
virtual void	setTimeout (ulong, ulong)=0
	size ()
virtual qint64	size () const =0
virtual StopBitsType	stopBits () const
virtual void	translateError (ulong error)=0
virtual void	ungetChar (char c)=0
	waitForBytesWritten (int msecs)
	waitForReadyRead (int msecs)
	write (const QByteArray &byteArray)
	write (const char *data, qint64 maxSize)
virtual	~QextSerialBase ()
Protected Member Functions
virtual qint64	readData (char *data, qint64 maxSize)=0
virtual qint64	writeData (const char *data, qint64 maxSize)=0
Protected Attributes
ulong	lastErr
QString	port
PortSettings	Settings
Static Protected Attributes
static QMutex *	mutex = NULL
static ulong	refCount = 0

---

Detailed Description

Version:

1.0.0

Author:

Stefan Sander

A common base class for Win_QextSerialBase, Posix_QextSerialBase and QextSerialPort.

---

Constructor & Destructor Documentation

QextSerialBase::QextSerialBase

(

)

Default constructor.

 : QIODevice()
{

#ifdef _TTY_WIN_
    setPortName("COM1");

#elif defined(_TTY_IRIX_)
    setPortName("/dev/ttyf1");

#elif defined(_TTY_HPUX_)
    setPortName("/dev/tty1p0");

#elif defined(_TTY_SUN_)
    setPortName("/dev/ttya");

#elif defined(_TTY_DIGITAL_)
    setPortName("/dev/tty01");

#elif defined(_TTY_FREEBSD_)
    setPortName("/dev/ttyd1");

#else
    setPortName("/dev/ttyS0");
#endif

    construct();
}

QextSerialBase::QextSerialBase

(

const QString &

name

)

Construct a port and assign it to the device specified by the name parameter.

 : QIODevice()
{
    setPortName(name);
    construct();
}

QextSerialBase::~QextSerialBase

(

)

[virtual]

Standard destructor.

{

#ifdef QT_THREAD_SUPPORT
    refCount--;
    if (mutex && refCount==0) {
        delete mutex;
        mutex=NULL;
    }
#endif

}

---

Member Function Documentation

bool QextSerialBase::atEnd

(

)

const [virtual]

This function will return true if the input buffer is empty (or on error), and false otherwise. Call QextSerialBase::lastError() for error information.

{
    if (size()) {
        return true;
    }
    return false;
}

BaudRateType QextSerialBase::baudRate

(

void

)

const [virtual]

Returns the baud rate of the serial port. For a list of possible return values see the definition of the enum BaudRateType.

{
    return Settings.BaudRate;
}

virtual qint64 QextSerialBase::bytesAvailable

(

)

[pure virtual]

Reimplemented from QIODevice.

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

virtual void QextSerialBase::close

(

)

[pure virtual]

Reimplemented from QIODevice.

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

void QextSerialBase::construct

(

)

[virtual]

Common constructor function for setting up default port settings. (115200 Baud, 8N1, Hardware flow control where supported, otherwise no flow control, and 500 ms timeout).

{
    Settings.BaudRate=BAUD115200;
    Settings.DataBits=DATA_8;
    Settings.Parity=PAR_NONE;
    Settings.StopBits=STOP_1;
    Settings.FlowControl=FLOW_HARDWARE;
    Settings.Timeout_Sec=0;
    Settings.Timeout_Millisec=500;

#ifdef QT_THREAD_SUPPORT
    if (!mutex) {
        mutex=new QMutex( QMutex::Recursive );
    }
    refCount++;
#endif

    setOpenMode(QIODevice::NotOpen);
}

DataBitsType QextSerialBase::dataBits

(

)

const [virtual]

Returns the number of data bits used by the port. For a list of possible values returned by this function, see the definition of the enum DataBitsType.

{
    return Settings.DataBits;
}

FlowType QextSerialBase::flowControl

(

)

const [virtual]

Returns the type of flow control used by the port. For a list of possible values returned by this function, see the definition of the enum FlowType.

{
    return Settings.FlowControl;
}

virtual void QextSerialBase::flush

(

)

[pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

bool QextSerialBase::isSequential

(

)

const [virtual]

Returns true if device is sequential, otherwise returns false. Serial port is sequential device so this function always returns true. Check QIODevice::isSequential() documentation for more information.

{
    return true;
}

ulong QextSerialBase::lastError

(

)

const [virtual]

Returns the code for the last error encountered by the port, or E_NO_ERROR if the last port operation was successful. Possible error codes are:

Error                           Explanation
---------------------------     -------------------------------------------------------------
E_NO_ERROR                      No Error has occured
E_INVALID_FD                    Invalid file descriptor (port was not opened correctly)
E_NO_MEMORY                     Unable to allocate memory tables (POSIX)
E_CAUGHT_NON_BLOCKED_SIGNAL     Caught a non-blocked signal (POSIX)
E_PORT_TIMEOUT                  Operation timed out (POSIX)
E_INVALID_DEVICE                The file opened by the port is not a character device (POSIX)
E_BREAK_CONDITION               The port detected a break condition
E_FRAMING_ERROR                 The port detected a framing error
                                (usually caused by incorrect baud rate settings)
E_IO_ERROR                      There was an I/O error while communicating with the port
E_BUFFER_OVERRUN                Character buffer overrun
E_RECEIVE_OVERFLOW              Receive buffer overflow
E_RECEIVE_PARITY_ERROR          The port detected a parity error in the received data
E_TRANSMIT_OVERFLOW             Transmit buffer overflow
E_READ_FAILED                   General read operation failure
E_WRITE_FAILED                  General write operation failure

{
    return lastErr;
}

virtual ulong QextSerialBase::lineStatus

(

)

[pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

virtual bool QextSerialBase::open

(

OpenMode

mode = 0

)

[pure virtual]

Reimplemented from QIODevice.

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

ParityType QextSerialBase::parity

(

)

const [virtual]

Returns the type of parity used by the port. For a list of possible values returned by this function, see the definition of the enum ParityType.

{
    return Settings.Parity;
}

QString QextSerialBase::portName

(

)

const [virtual]

Returns the name set by setPortName().

{
    return port;
}

virtual qint64 QextSerialBase::readData	(	char *	data,
		qint64	maxSize
	)			[protected, pure virtual]

Reimplemented from QIODevice.

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

qint64 QextSerialBase::readLine	(	char *	data,
		qint64	maxSize
	)			[virtual]

This function will read a line of buffered input from the port, stopping when either maxSize bytes have been read, the port has no more data available, or a newline is encountered. The value returned is the length of the string that was read.

Reimplemented from QIODevice.

{
    qint64 numBytes = bytesAvailable();
    char* pData = data;

    if (maxSize < 2)    //maxSize must be larger than 1
        return -1;

    /*read a byte at a time for MIN(bytesAvail, maxSize - 1) iterations, or until a newline*/
    while (pData<(data+numBytes) && --maxSize) {
        readData(pData, 1);
        if (*pData++ == '\n') {
            break;
        }
    }
    *pData='\0';

    /*return size of data read*/
    return (pData-data);
}

virtual void QextSerialBase::setBaudRate

(

BaudRateType

)

[pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

virtual void QextSerialBase::setDataBits

(

DataBitsType

)

[pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

virtual void QextSerialBase::setDtr

(

bool

set = true

)

[pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

virtual void QextSerialBase::setFlowControl

(

FlowType

)

[pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

virtual void QextSerialBase::setParity

(

ParityType

)

[pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

void QextSerialBase::setPortName

(

const QString &

name

)

[virtual]

Sets the name of the device associated with the object, e.g. "COM1", or "/dev/ttyS0".

{
    port = name;
}

virtual void QextSerialBase::setRts

(

bool

set = true

)

[pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

virtual void QextSerialBase::setStopBits

(

StopBitsType

)

[pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

virtual void QextSerialBase::setTimeout	(	ulong	,
		ulong
	)			[pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

virtual qint64 QextSerialBase::size

(

)

const [pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

StopBitsType QextSerialBase::stopBits

(

)

const [virtual]

Returns the number of stop bits used by the port. For a list of possible return values, see the definition of the enum StopBitsType.

{
    return Settings.StopBits;
}

virtual void QextSerialBase::translateError

(

ulong

error

)

[pure virtual]

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

virtual void QextSerialBase::ungetChar

(

char

c

)

[pure virtual]

Reimplemented from QIODevice.

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

virtual qint64 QextSerialBase::writeData	(	const char *	data,
		qint64	maxSize
	)			[protected, pure virtual]

Reimplemented from QIODevice.

Implemented in Posix_QextSerialPort, and Win_QextSerialPort.

---

Member Data Documentation

ulong QextSerialBase::lastErr [protected]

QMutex * QextSerialBase::mutex = NULL [static, protected]

QString QextSerialBase::port [protected]

unsigned long QextSerialBase::refCount = 0 [static, protected]

PortSettings QextSerialBase::Settings [protected]

---

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

• qextserialbase.h
• qextserialbase.cpp

---