MOOS 0.2375
Classes | Public Types | Public Member Functions | Protected Attributes
CNTSerial Class Reference

Middle Layer class for Windows Serial port (c) Ramon de Klein. More...

#include <NTSerial.h>

Inheritance diagram for CNTSerial:
Inheritance graph
[legend]
Collaboration diagram for CNTSerial:
Collaboration graph
[legend]

List of all members.

Classes

class  CDCB

Public Types

enum  EEvent {
  EEventNone = -1, EEventBreak = EV_BREAK, EEventCTS = EV_CTS, EEventDSR = EV_DSR,
  EEventError = EV_ERR, EEventRing = EV_RING, EEventRLSD = EV_RLSD, EEventRecv = EV_RXCHAR,
  EEventRcvEv = EV_RXFLAG, EEventSend = EV_TXEMPTY
}
enum  EBaudrate {
  EBaudUnknown = -1, EBaud110 = CBR_110, EBaud300 = CBR_300, EBaud600 = CBR_600,
  EBaud1200 = CBR_1200, EBaud2400 = CBR_2400, EBaud4800 = CBR_4800, EBaud9600 = CBR_9600,
  EBaud14400 = CBR_14400, EBaud19200 = CBR_19200, EBaud38400 = CBR_38400, EBaud56000 = CBR_56000,
  EBaud57600 = CBR_57600, EBaud115200 = CBR_115200, EBaud128000 = CBR_128000, EBaud256000 = CBR_256000,
  EBaud500000 = 500000, EBaudCSM9600 = 2150, EBaudCSM19200 = 4301, EBaudCSM38400 = 8602,
  EBaudCSM500000 = 115000
}
enum  EDataBits {
  EDataUnknown = -1, EData5 = 5, EData6 = 6, EData7 = 7,
  EData8 = 8
}
enum  EParity {
  EParUnknown = -1, EParNone = NOPARITY, EParOdd = ODDPARITY, EParEven = EVENPARITY,
  EParMark = MARKPARITY, EParSpace = SPACEPARITY
}
enum  EStopBits { EStopUnknown = -1, EStop1 = ONESTOPBIT, EStop1_5 = ONE5STOPBITS, EStop2 = TWOSTOPBITS }
enum  EHandshake { EHandshakeUnknown = -1, EHandshakeOff = 0, EHandshakeHardware = 1, EHandshakeSoftware = 2 }
enum  EReadTimeout { EReadTimeoutUnknown = -1, EReadTimeoutNonblocking = 0, EReadTimeoutBlocking = 1 }
enum  EError {
  EErrorUnknown = 0, EErrorBreak = CE_BREAK, EErrorFrame = CE_FRAME, EErrorIOE = CE_IOE,
  EErrorMode = CE_MODE, EErrorOverrun = CE_OVERRUN, EErrorRxOver = CE_RXOVER, EErrorParity = CE_RXPARITY,
  EErrorTxFull = CE_TXFULL
}
enum  EPort { EPortUnknownError = -1, EPortAvailable = 0, EPortNotAvailable = 1, EPortInUse = 2 }

Public Member Functions

 CNTSerial ()
virtual ~CNTSerial ()
EPort CheckPort (LPCTSTR lpszDevice)
virtual LONG Open (LPCTSTR lpszDevice, DWORD dwInQueue=2048, DWORD dwOutQueue=2048)
virtual LONG ClosePort (void)
virtual LONG Setup (EBaudrate eBaudrate=EBaud9600, EDataBits eDataBits=EData8, EParity eParity=EParNone, EStopBits eStopBits=EStop1)
virtual LONG SetEventChar (BYTE bEventChar, bool fAdjustMask=true)
virtual LONG SetMask (DWORD dwMask=EEventBreak|EEventError|EEventRecv)
virtual LONG WaitEvent (LPOVERLAPPED lpOverlapped=0, DWORD dwTimeout=INFINITE)
virtual LONG SetupHandshaking (EHandshake eHandshake)
virtual LONG SetupReadTimeouts (EReadTimeout eReadTimeout)
virtual EBaudrate GetBaudrate (void)
virtual EDataBits GetDataBits (void)
virtual EParity GetParity (void)
virtual EStopBits GetStopBits (void)
virtual EHandshake GetHandshaking (void)
virtual DWORD GetEventMask (void)
virtual BYTE GetEventChar (void)
virtual LONG Write (const void *pData, size_t iLen, DWORD *pdwWritten=0, LPOVERLAPPED lpOverlapped=0, DWORD dwTimeout=INFINITE)
virtual LONG Write (LPCSTR pString, DWORD *pdwWritten=0, LPOVERLAPPED lpOverlapped=0, DWORD dwTimeout=INFINITE)
virtual LONG NTRead (void *pData, size_t iLen, DWORD *pdwRead=0, LPOVERLAPPED lpOverlapped=0, DWORD dwTimeout=INFINITE)
EEvent GetEventType (void)
EError GetError (void)
HANDLE GetCommHandle (void)
bool IsOpen (void) const
LONG GetLastError (void) const
bool GetCTS (void)
bool GetDSR (void)
bool GetRing (void)
bool GetRLSD (void)
virtual int Flush (void)

Protected Attributes

LONG m_lLastError
HANDLE m_hFile
EEvent m_eEvent
HANDLE m_hevtOverlapped

Detailed Description

Middle Layer class for Windows Serial port (c) Ramon de Klein.

Definition at line 98 of file NTSerial.h.

Member Enumeration Documentation

enum CNTSerial::EBaudrate
Enumerator:
EBaudUnknown 
EBaud110 
EBaud300 
EBaud600 
EBaud1200 
EBaud2400 
EBaud4800 
EBaud9600 
EBaud14400 
EBaud19200 
EBaud38400 
EBaud56000 
EBaud57600 
EBaud115200 
EBaud128000 
EBaud256000 
EBaud500000 
EBaudCSM9600 
EBaudCSM19200 
EBaudCSM38400 
EBaudCSM500000 

Definition at line 119 of file NTSerial.h.

enum CNTSerial::EDataBits
Enumerator:
EDataUnknown 
EData5 
EData6 
EData7 
EData8 

Definition at line 151 of file NTSerial.h.

enum CNTSerial::EError
Enumerator:
EErrorUnknown 
EErrorBreak 
EErrorFrame 
EErrorIOE 
EErrorMode 
EErrorOverrun 
EErrorRxOver 
EErrorParity 
EErrorTxFull 

Definition at line 203 of file NTSerial.h.

enum CNTSerial::EEvent
Enumerator:
EEventNone 
EEventBreak 
EEventCTS 
EEventDSR 
EEventError 
EEventRing 
EEventRLSD 
EEventRecv 
EEventRcvEv 
EEventSend 

Definition at line 103 of file NTSerial.h.

enum CNTSerial::EHandshake
Enumerator:
EHandshakeUnknown 
EHandshakeOff 
EHandshakeHardware 
EHandshakeSoftware 

Definition at line 184 of file NTSerial.h.

enum CNTSerial::EParity
Enumerator:
EParUnknown 
EParNone 
EParOdd 
EParEven 
EParMark 
EParSpace 

Definition at line 162 of file NTSerial.h.

enum CNTSerial::EPort
Enumerator:
EPortUnknownError 
EPortAvailable 
EPortNotAvailable 
EPortInUse 

Definition at line 218 of file NTSerial.h.

enum CNTSerial::EReadTimeout
Enumerator:
EReadTimeoutUnknown 
EReadTimeoutNonblocking 
EReadTimeoutBlocking 

Definition at line 194 of file NTSerial.h.

enum CNTSerial::EStopBits
Enumerator:
EStopUnknown 
EStop1 
EStop1_5 
EStop2 

Definition at line 174 of file NTSerial.h.

Constructor & Destructor Documentation

CNTSerial::CNTSerial ( )

Definition at line 88 of file NTSerial.cpp.

CNTSerial::~CNTSerial ( ) [virtual]

Definition at line 97 of file NTSerial.cpp.

Member Function Documentation

CNTSerial::EPort CNTSerial::CheckPort ( LPCTSTR  lpszDevice)

Definition at line 111 of file NTSerial.cpp.

LONG CNTSerial::ClosePort ( void  ) [virtual]

Definition at line 231 of file NTSerial.cpp.

int CNTSerial::Flush ( void  ) [virtual]

Reimplemented from CMOOSSerialPort.

Definition at line 1094 of file NTSerial.cpp.

CNTSerial::EBaudrate CNTSerial::GetBaudrate ( void  ) [virtual]

Definition at line 627 of file NTSerial.cpp.

HANDLE CNTSerial::GetCommHandle ( void  ) [inline]

Definition at line 341 of file NTSerial.h.

bool CNTSerial::GetCTS ( void  )

Definition at line 1162 of file NTSerial.cpp.

CNTSerial::EDataBits CNTSerial::GetDataBits ( void  ) [virtual]

Definition at line 659 of file NTSerial.cpp.

bool CNTSerial::GetDSR ( void  )

Definition at line 1183 of file NTSerial.cpp.

CNTSerial::EError CNTSerial::GetError ( void  )

Definition at line 1130 of file NTSerial.cpp.

BYTE CNTSerial::GetEventChar ( void  ) [virtual]

Definition at line 794 of file NTSerial.cpp.

DWORD CNTSerial::GetEventMask ( void  ) [virtual]

Definition at line 762 of file NTSerial.cpp.

CNTSerial::EEvent CNTSerial::GetEventType ( void  )

Definition at line 1118 of file NTSerial.cpp.

CNTSerial::EHandshake CNTSerial::GetHandshaking ( void  ) [virtual]

Definition at line 826 of file NTSerial.cpp.

LONG CNTSerial::GetLastError ( void  ) const [inline]

Definition at line 347 of file NTSerial.h.

CNTSerial::EParity CNTSerial::GetParity ( void  ) [virtual]

Definition at line 691 of file NTSerial.cpp.

bool CNTSerial::GetRing ( void  )

Definition at line 1204 of file NTSerial.cpp.

bool CNTSerial::GetRLSD ( void  )

Definition at line 1225 of file NTSerial.cpp.

CNTSerial::EStopBits CNTSerial::GetStopBits ( void  ) [virtual]

Definition at line 730 of file NTSerial.cpp.

bool CNTSerial::IsOpen ( void  ) const [inline]

Definition at line 344 of file NTSerial.h.

LONG CNTSerial::NTRead ( void *  pData,
size_t  iLen,
DWORD *  pdwRead = 0,
LPOVERLAPPED  lpOverlapped = 0,
DWORD  dwTimeout = INFINITE 
) [virtual]

Definition at line 980 of file NTSerial.cpp.

LONG CNTSerial::Open ( LPCTSTR  lpszDevice,
DWORD  dwInQueue = 2048,
DWORD  dwOutQueue = 2048 
) [virtual]

Definition at line 149 of file NTSerial.cpp.

LONG CNTSerial::SetEventChar ( BYTE  bEventChar,
bool  fAdjustMask = true 
) [virtual]

Definition at line 309 of file NTSerial.cpp.

LONG CNTSerial::SetMask ( DWORD  dwMask = EEventBreak|EEventError|EEventRecv) [virtual]

Definition at line 364 of file NTSerial.cpp.

LONG CNTSerial::Setup ( EBaudrate  eBaudrate = EBaud9600,
EDataBits  eDataBits = EData8,
EParity  eParity = EParNone,
EStopBits  eStopBits = EStop1 
) [virtual]

Definition at line 257 of file NTSerial.cpp.

LONG CNTSerial::SetupHandshaking ( EHandshake  eHandshake) [virtual]

Definition at line 484 of file NTSerial.cpp.

LONG CNTSerial::SetupReadTimeouts ( EReadTimeout  eReadTimeout) [virtual]

Definition at line 564 of file NTSerial.cpp.

LONG CNTSerial::WaitEvent ( LPOVERLAPPED  lpOverlapped = 0,
DWORD  dwTimeout = INFINITE 
) [virtual]

Definition at line 396 of file NTSerial.cpp.

LONG CNTSerial::Write ( LPCSTR  pString,
DWORD *  pdwWritten = 0,
LPOVERLAPPED  lpOverlapped = 0,
DWORD  dwTimeout = INFINITE 
) [virtual]

Definition at line 974 of file NTSerial.cpp.

LONG CNTSerial::Write ( const void *  pData,
size_t  iLen,
DWORD *  pdwWritten = 0,
LPOVERLAPPED  lpOverlapped = 0,
DWORD  dwTimeout = INFINITE 
) [virtual]

Definition at line 866 of file NTSerial.cpp.

Member Data Documentation

EEvent CNTSerial::m_eEvent [protected]

Definition at line 371 of file NTSerial.h.

HANDLE CNTSerial::m_hevtOverlapped [protected]

Definition at line 372 of file NTSerial.h.

HANDLE CNTSerial::m_hFile [protected]

Definition at line 370 of file NTSerial.h.

LONG CNTSerial::m_lLastError [protected]

Definition at line 369 of file NTSerial.h.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Feb 15 2012 18:20:50 for MOOS by  doxygen 1.7.4