Main Page   Class Hierarchy   Compound List   File List   Compound Members  

Win_QextSerialPort Class Reference

Inheritance diagram for Win_QextSerialPort::

QextSerialBase List of all members.

Public Methods

 Win_QextSerialPort ()
 Win_QextSerialPort (Win_QextSerialPort const &s)
 Win_QextSerialPort (const char *name)
 Win_QextSerialPort (const PortSettings &settings)
 Win_QextSerialPort (const char *name, const PortSettings &settings)
Win_QextSerialPort & operator= (Win_QextSerialPort const &s)
virtual ~Win_QextSerialPort ()
virtual bool open (int mode=0)
virtual void close ()
virtual void flush ()
virtual Offset size () const
virtual int getch ()
virtual int putch (int)
virtual int ungetch (int)
virtual void setFlowControl (FlowType)
virtual void setParity (ParityType)
virtual void setDataBits (DataBitsType)
virtual void setStopBits (StopBitsType)
virtual void setBaudRate (BaudRateType)
virtual void setDtr (bool set=true)
virtual void setRts (bool set=true)
virtual unsigned long lineStatus (void)
virtual int bytesWaiting ()
virtual void translateError (unsigned long)
virtual void setTimeout (unsigned long=0, unsigned long=0)
virtual Q_LONG readBlock (char *data, unsigned long maxlen)
virtual Q_LONG writeBlock (const char *data, unsigned long len)

Protected Methods

void construct (void)

Protected Attributes

HANDLE Win_Handle
COMMCONFIG Win_CommConfig
COMMTIMEOUTS Win_CommTimeouts

Detailed Description

Version:
0.70 (pre-alpha)
Author:
Wayne Roth
A cross-platform serial port class. This class encapsulates the Windows portion of QextSerialPort. The user will be notified of errors and possible portability conflicts at run-time by default - this behavior can be turned off by defining _TTY_NOWARN_ (to turn off all warnings) or _TTY_NOWARN_PORT_ (to turn off portability warnings) in the project. Note that defining _TTY_NOWARN_ also defines _TTY_NOWARN_PORT_.

Note:
On Windows NT/2000/XP this class uses Win32 serial port functions by default. The user may select POSIX behavior under NT, 2000, or XP ONLY by defining _TTY_POSIX_ in the project. I can make no guarantees as to the quality of POSIX support under NT/2000 however.

Constructor & Destructor Documentation

Win_QextSerialPort::Win_QextSerialPort (    ) 
 

Default constructor. Note that the name of the device used by a Win_QextSerialPort constructed with this constructor will be determined by defined constants, or lack thereof - the default behavior is the same as _TTY_LINUX_. Possible naming conventions and their associated constants are: 


Constant         Used By         Naming Convention
----------       -------------   ------------------------
_TTY_WIN_        Windows         COM1, COM2
_TTY_IRIX_       SGI/IRIX        /dev/ttyf1, /dev/ttyf2
_TTY_HPUX_       HP-UX           /dev/tty1p0, /dev/tty2p0
_TTY_SUN_        SunOS/Solaris   /dev/ttya, /dev/ttyb
_TTY_DIGITAL_    Digital UNIX    /dev/tty01, /dev/tty02
_TTY_LINUX_      Linux           /dev/ttyS0, /dev/ttyS1
<none>           Linux           /dev/ttyS0, /dev/ttyS1

This constructor associates the object with the first port on the system, e.g. COM1 for Windows platforms. See the other constructor if you need a port other than the first.

Win_QextSerialPort::Win_QextSerialPort (  const char *    name ) 
 

Constructs a serial port attached to the port specified by devName. devName is the name of the device, which is windowsystem-specific, e.g."COM2" or "/dev/ttyS0".

Win_QextSerialPort::Win_QextSerialPort (  const PortSettings &    settings ) 
 

Constructs a port with default name and specified settings.

Win_QextSerialPort::Win_QextSerialPort (  const char *    name,
const PortSettings &    settings
) 
 

Constructs a port with specified name and settings.

Win_QextSerialPort::~Win_QextSerialPort (    )  [virtual]
 

Standard destructor.

Member Function Documentation

int Win_QextSerialPort::bytesWaiting (    )  [virtual]
 

Returns the number of bytes waiting in the port's receive queue. This function will return 0 if the port is not currently open, or -1 on error. Error information can be retrieved by calling Win_QextSerialPort::getLastError().

Reimplemented from QextSerialBase.

void Win_QextSerialPort::close (    )  [virtual]
 

Closes a serial port. This function has no effect if the serial port associated with the class is not currently open.

Reimplemented from QextSerialBase.

void Win_QextSerialPort::construct (  void    )  [protected, virtual]
 

Common constructor function, called by all versions of Win_QextSerialPort::Win_QextSerialPort(). Sets up default port settings (115200 8N1 Hardware flow control where supported, otherwise no flow control, and 500 ms timeout).

Reimplemented from QextSerialBase.

void Win_QextSerialPort::flush (    )  [virtual]
 

Flushes all pending I/O to the serial port. This function has no effect if the serial port associated with the class is not currently open.

Reimplemented from QextSerialBase.

int Win_QextSerialPort::getch (    )  [virtual]
 

Returns a single character from the serial port, or -1 on error. This function has no effect if the serial port associated with the class is not currently open.

Reimplemented from QextSerialBase.

unsigned long Win_QextSerialPort::lineStatus (  void    )  [virtual]
 

returns the line status as stored by the port function. This function will retrieve the states of the following lines: DCD, CTS, DSR, and RI. On POSIX systems, the following additional lines can be monitored: DTR, RTS, Secondary TXD, and Secondary RXD. The value returned is an unsigned long with specific bits indicating which lines are high. The following constants should be used to examine the states of individual lines: 

Mask        Line               
------      ----               
LS_CTS      CTS
LS_DSR      DSR
LS_DCD      DCD
LS_RI       RI

This function will return 0 if the port associated with the class is not currently open.

Reimplemented from QextSerialBase.

bool Win_QextSerialPort::open (  int    mode = 0 )  [virtual]
 

Opens a serial port. Note that this function does not specify which device to open. If you need to open a device by name, see Win_QextSerialPort::open(const char*). This function has no effect if the port associated with the class is already open. The port is also configured to the current settings, as stored in the Settings structure.

Reimplemented from QextSerialBase.

int Win_QextSerialPort::putch (  int    ch )  [virtual]
 

Writes a single character to the serial port. Return value is the byte written, or -1 on error. This function has no effect if the serial port associated with the class is not currently open.

Reimplemented from QextSerialBase.

void Win_QextSerialPort::setBaudRate (  BaudRateType    baudRate )  [virtual]
 

Sets the baud rate of the serial port. Note that not all rates are applicable on all platforms. The following table shows translations of the various baud rate constants on Windows(including NT/2000) and POSIX platforms. Speeds marked with an * are speeds that are usable on both Windows and POSIX. 


  RATE          Windows Speed   POSIX Speed
  -----------   -------------   -----------
   BAUD50                 110          50
   BAUD75                 110          75
  *BAUD110                110         110
   BAUD134                110         134.5
   BAUD150                110         150
   BAUD200                110         200
  *BAUD300                300         300
  *BAUD600                600         600
  *BAUD1200              1200        1200
   BAUD1800              1200        1800
  *BAUD2400              2400        2400
  *BAUD4800              4800        4800
  *BAUD9600              9600        9600
   BAUD14400            14400        9600
  *BAUD19200            19200       19200
  *BAUD38400            38400       38400
   BAUD56000            56000       38400
  *BAUD57600            57600       57600
   BAUD76800            57600       76800
  *BAUD115200          115200      115200
   BAUD128000          128000      115200
   BAUD256000          256000      115200

Reimplemented from QextSerialBase.

void Win_QextSerialPort::setDataBits (  DataBitsType    dataBits )  [virtual]
 

Sets the number of data bits used by the serial port. Possible values of dataBits are: 

    DATA_5      5 data bits
    DATA_6      6 data bits
    DATA_7      7 data bits
    DATA_8      8 data bits

Note:
This function is subject to the following restrictions:

5 data bits cannot be used with 2 stop bits.

1.5 stop bits can only be used with 5 data bits.

8 data bits cannot be used with space parity on POSIX systems.

Reimplemented from QextSerialBase.

void Win_QextSerialPort::setDtr (  bool    set = true )  [virtual]
 

Sets DTR line to the requested state (high by default). This function will have no effect if the port associated with the class is not currently open.

Reimplemented from QextSerialBase.

void Win_QextSerialPort::setFlowControl (  FlowType    flow )  [virtual]
 

Sets the flow control used by the port. Possible values of flow are: 

    FLOW_OFF            No flow control
    FLOW_HARDWARE       Hardware (RTS/CTS) flow control
    FLOW_XONXOFF        Software (XON/XOFF) flow control

Reimplemented from QextSerialBase.

void Win_QextSerialPort::setParity (  ParityType    parity )  [virtual]
 

Sets the parity associated with the serial port. The possible values of parity are: 

    PAR_SPACE       Space Parity
    PAR_MARK        Mark Parity
    PAR_NONE        No Parity
    PAR_EVEN        Even Parity
    PAR_ODD         Odd Parity

Reimplemented from QextSerialBase.

void Win_QextSerialPort::setRts (  bool    set = true )  [virtual]
 

Sets RTS line to the requested state (high by default). This function will have no effect if the port associated with the class is not currently open.

Reimplemented from QextSerialBase.

void Win_QextSerialPort::setStopBits (  StopBitsType    stopBits )  [virtual]
 

Sets the number of stop bits used by the serial port. Possible values of stopBits are: 

    STOP_1      1 stop bit
    STOP_1_5    1.5 stop bits
    STOP_2      2 stop bits

Note:
This function is subject to the following restrictions:

2 stop bits cannot be used with 5 data bits.

1.5 stop bits cannot be used with 6 or more data bits.

POSIX does not support 1.5 stop bits.

Reimplemented from QextSerialBase.

void Win_QextSerialPort::setTimeout (  unsigned long    sec = 0,
unsigned long    millisec = 0
)  [virtual]
 

Sets the read and write timeouts for the port to sec seconds and millisec milliseconds.

Reimplemented from QextSerialBase.

Offset Win_QextSerialPort::size (    )  const [virtual]
 

This function will return the number of bytes waiting in the receive queue of the serial port. It is included primarily to provide a complete QIODevice interface, and will not record errors in the lastErr member (because it is const). This function is also not thread-safe - in multithreading situations, use Win_QextSerialPort::bytesWaiting() instead.

Reimplemented from QextSerialBase.

void Win_QextSerialPort::translateError (  unsigned long    error )  [virtual]
 

Translates a system-specific error code to a QextSerialPort error code. Used internally.

Reimplemented from QextSerialBase.

int Win_QextSerialPort::ungetch (  int    )  [virtual]
 

This function is included to implement the full QIODevice interface, and currently has no purpose within this class. This function is meaningless on an unbuffered device and currently only prints a warning message to that effect.

Reimplemented from QextSerialBase.

The documentation for this class was generated from the following files:
Generated on Sat Jun 15 15:43:04 2002 for QextSerialPort by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001