QPidCommPort Class Reference

#include <qpidcommport.h>

Inheritance diagram for QPidCommPort:

Public Types
enum	{ NoPort, LocalSerialPort, NetworkSocket, EpicsPV }

Public Slots
QStringList	commPortTypes ()
QStringList	commPortBaudRates ()
QStringList	commPortDataBits ()
QStringList	commPortFlowControls ()
QStringList	commPortParitys ()
QStringList	commPortStopBits ()
BaudRateType	baudRate (int idx)
DataBitsType	dataBits (int idx)
FlowType	flowControl (int idx)
StopBitsType	stopBits (int idx)
ParityType	parity (int idx)
void	printMessage (QString msg, QDateTime ts=QDateTime::currentDateTime())

Signals
void	readyRead ()

Public Member Functions
	QPidCommPort (QcepSettingsSaverPtr saver, QPidControllerPtr ctl)
virtual	~QPidCommPort ()
virtual void	writeSettings (QSettings *set, QString section)
virtual void	readSettings (QSettings *set, QString section)
QByteArray	readAll ()
QByteArray	read (int sz)
QByteArray	readLine (int maxlen=0)
bool	isWritable ()
void	write (QByteArray msg)
int	waitForBytesWritten (int tmout=0)
int	waitForReadyRead (int tmout=0)
int	bytesAvailable ()
int	canReadLine ()
bool	successfullyConnected ()

Properties
int	commPortType
QString	serialPortName
int	serialPortBaud
int	serialPortBits
int	serialPortParity
int	serialPortStopBits
int	serialPortFlowControl
QString	socketHostAddress
int	socketPortNumber
int	socketTimeout
QString	epicsPVName
int	connected
int	successful

Private Member Functions
bool	openIfNeeded ()
bool	openLocalSerialPort ()
bool	openNetworkSocket ()

Private Attributes
QPidControllerWPtr	m_Controller
QPointer< QIODevice >	m_IODevice

Detailed Description

Definition at line 14 of file qpidcommport.h.

Member Enumeration Documentation

anonymous enum

Enumerator
NoPort
LocalSerialPort
NetworkSocket
EpicsPV

Definition at line 21 of file qpidcommport.h.

       {
    NoPort,
    LocalSerialPort,
    NetworkSocket,
    EpicsPV
  };

Constructor & Destructor Documentation

QPidCommPort::QPidCommPort ( QcepSettingsSaverPtr  saver, QPidControllerPtr  ctl  )

explicit

Definition at line 8 of file qpidcommport.cpp.

                                                                            :
  QObject(),
  m_CommPortType(saver, this, "commPortType", 0, "Comm Port Type"),
  m_SerialPortName(saver, this, "serialPortName", "", "Serial Port Name"),
  m_SerialPortBaud(saver, this, "serialPortBaud", 0, "Serial Port Baud Rate"),
  m_SerialPortBits(saver, this, "serialPortBits", 1, "Serial Port Data Bits"),
  m_SerialPortParity(saver, this, "serialPortParity", 0, "Serial Port Parity"),
  m_SerialPortStopBits(saver, this, "serialPortStopBits", 0, "Serial Port Stop Bits"),
  m_SerialPortFlowControl(saver, this, "serialPortFlowControl", 0, "Serial Port Flow Control"),
  m_SocketHostAddress(saver, this, "socketHostAddress", "", "Socket Host Address"),
  m_SocketPortNumber(saver, this, "socketPortNumber", 0, "Socket Port Number"),
  m_SocketTimeout(saver, this, "socketTimeout", 5000, "Socket timeout (msec)"),
  m_EpicsPVName(saver, this, "epicsPVName", "", "Epics PV Name"),
  m_Connected(QcepSettingsSaverWPtr(), this, "connected", 0, "Is comm port connected"),
  m_Successful(QcepSettingsSaverWPtr(), this, "successful", 0, "Successful communication taken place"),
  m_Controller(ctl)
{
  if (qcepDebug(DEBUG_CONSTRUCTORS)) {
    printf("QPidCommPort::QPidCommPort(%p)\n", this);
  }
}

QPidCommPort::~QPidCommPort ( )

virtual

Definition at line 30 of file qpidcommport.cpp.

{
  if (qcepDebug(DEBUG_CONSTRUCTORS)) {
    printf("QPidCommPort::~QPidCommPort(%p)\n", this);
  }
}

Member Function Documentation

BaudRateType QPidCommPort::baudRate ( int  idx )

slot

Definition at line 62 of file qpidcommport.cpp.

Referenced by openLocalSerialPort().

{
  switch(idx) {
  case 0:
    return BAUD1200;

  case 1:
    return BAUD2400;

  case 2:
    return BAUD4800;

  case 3:
    return BAUD9600;

  case 4:
    return BAUD19200;

  default:
    return BAUD9600;
  }
}

int QPidCommPort::bytesAvailable

(

)

Definition at line 340 of file qpidcommport.cpp.

References DEBUG_COMMPORT, DEBUG_LEVEL1, m_IODevice, openIfNeeded(), and printMessage().

{
  if (openIfNeeded()) {
    int res = m_IODevice->bytesAvailable();

    if (qcepDebug(DEBUG_COMMPORT) && qcepDebug(DEBUG_LEVEL1)) {
      printMessage(tr("QPidCommPort::bytesAvailable(): %1").arg(res));
    }

    return res;
  } else {
    return 0;
  }
}

int QPidCommPort::canReadLine

(

)

Definition at line 355 of file qpidcommport.cpp.

References DEBUG_COMMPORT, DEBUG_LEVEL1, m_IODevice, openIfNeeded(), and printMessage().

{
  if (openIfNeeded()) {
    int res = m_IODevice->canReadLine();

    if (qcepDebug(DEBUG_COMMPORT) && qcepDebug(DEBUG_LEVEL1)) {
      printMessage(tr("QPidCommPort::canReadLine(): %1").arg(res));
    }

    return res;
  } else {
    return 0;
  }
}

QStringList QPidCommPort::commPortBaudRates ( )

slot

Definition at line 49 of file qpidcommport.cpp.

{
  QStringList res;

  res << "1200 Baud"
      << "2400 Baud"
      << "4800 Baud"
      << "9600 Baud"
      << "19200 Baud";

  return res;
}

QStringList QPidCommPort::commPortDataBits ( )

slot

Definition at line 85 of file qpidcommport.cpp.

{
  QStringList res;

  res << "7 Bits"
      << "8 Bits";

  return res;
}

QStringList QPidCommPort::commPortFlowControls ( )

slot

Definition at line 109 of file qpidcommport.cpp.

{
  QStringList res;

  res << "None"
      << "Hardware"
      << "XON/XOFF";

  return res;
}

QStringList QPidCommPort::commPortParitys ( )

slot

Definition at line 137 of file qpidcommport.cpp.

{
  QStringList res;

  res << "None"
      << "Odd"
      << "Even"
      << "Space";

  return res;
}

QStringList QPidCommPort::commPortStopBits ( )

slot

Definition at line 169 of file qpidcommport.cpp.

{
  QStringList res;

  res << "1 Bits"
      << "2 Bits";

  return res;
}

QStringList QPidCommPort::commPortTypes ( )

slot

Definition at line 37 of file qpidcommport.cpp.

{
  QStringList res;

  res << "No Port"
      << "Local Serial Port"
      << "Network Socket"
      << "Epics PV";

  return res;
}

DataBitsType QPidCommPort::dataBits ( int  idx )

slot

Definition at line 95 of file qpidcommport.cpp.

Referenced by openLocalSerialPort().

{
  switch (idx) {
  case 0:
    return DATA_7;

  case 1:
    return DATA_8;

  default:
    return DATA_8;
  }
}

FlowType QPidCommPort::flowControl ( int  idx )

slot

Definition at line 120 of file qpidcommport.cpp.

Referenced by openLocalSerialPort().

{
  switch (idx) {
  case 0:
    return FLOW_OFF;

  case 1:
    return FLOW_HARDWARE;

  case 2:
    return FLOW_XONXOFF;

  default:
    return FLOW_OFF;
  }
}

bool QPidCommPort::isWritable

(

)

Definition at line 274 of file qpidcommport.cpp.

References DEBUG_COMMPORT, DEBUG_LEVEL1, m_IODevice, openIfNeeded(), and printMessage().

{
  if (openIfNeeded()) {
    bool res = m_IODevice->isWritable();

    if (qcepDebug(DEBUG_COMMPORT) && qcepDebug(DEBUG_LEVEL1)) {
      printMessage(tr("QPidCommPort::isWritable(): %1").arg(res));
    }
    return res;
  } else {
    return false;
  }
}

bool QPidCommPort::openIfNeeded ( )

private

Definition at line 439 of file qpidcommport.cpp.

References DEBUG_SERIAL, DEBUG_SOCKET, LocalSerialPort, NetworkSocket, openLocalSerialPort(), openNetworkSocket(), and printMessage().

Referenced by bytesAvailable(), canReadLine(), isWritable(), read(), readAll(), readLine(), waitForBytesWritten(), waitForReadyRead(), and write().

{
  if (get_Connected()) {
    return true;
  } else {
    bool res = false;

    switch (get_CommPortType()) {
    case LocalSerialPort:
      res = openLocalSerialPort();

      if (qcepDebug(DEBUG_SERIAL)) {
        printMessage(tr("Serial Port Opened = %1").arg(res));
      }
      break;

    case NetworkSocket:
      res = openNetworkSocket();

      if (qcepDebug(DEBUG_SOCKET)) {
        printMessage(tr("Socket opened: connected = %1").arg(res));
      }
      break;
    }

    set_Connected(res);

    return res;
  }
}

bool QPidCommPort::openLocalSerialPort ( )

private

Definition at line 370 of file qpidcommport.cpp.

References baudRate(), dataBits(), DEBUG_LEVEL1, DEBUG_SERIAL, flowControl(), m_IODevice, parity(), printMessage(), and stopBits().

Referenced by openIfNeeded().

{
  bool res;

  QList<QextPortInfo> ports = QextSerialEnumerator::getPorts();

  QString portName = get_SerialPortName();
  QString deviceName;

  for (int i=0; i<ports.count(); i++) {
    QextPortInfo port = ports.value(i);

    QString aPortName = port.portName;

    if (portName == aPortName) {
      deviceName = port.physName;
    }
  }

  QextSerialPort *dev = new QextSerialPort(deviceName, QextSerialPort::Polling);

  dev->setBaudRate(baudRate(get_SerialPortBaud()));
  dev->setDataBits(dataBits(get_SerialPortBits()));
  dev->setStopBits(stopBits(get_SerialPortStopBits()));
  dev->setFlowControl(flowControl(get_SerialPortFlowControl()));
  dev->setParity(parity(get_SerialPortParity()));

  res = dev->open(QIODevice::ReadWrite);

  if (qcepDebug(DEBUG_SERIAL)) {
    printMessage(tr("New serial port on device %1, port name %2").arg(deviceName).arg(portName));

    if (qcepDebug(DEBUG_LEVEL1)) {
      printMessage(tr("Baud:%1 Bits:%2 Parity:%3 Stop:%4 HShake:%5")
                   .arg(dev->baudRate())
                   .arg(dev->dataBits())
                   .arg(dev->parity())
                   .arg(dev->stopBits())
                   .arg(dev->flowControl()));
    }
  }

//  dev->setQueryMode(QextSerialPort::EventDriven);

  if (!res) {
    printMessage(tr("Serial Port open failed %1").arg(dev->errorString()));
  }

  m_IODevice = dev;

  return res;
}

bool QPidCommPort::openNetworkSocket ( )

private

Definition at line 423 of file qpidcommport.cpp.

References m_IODevice, and printMessage().

Referenced by openIfNeeded().

{
  bool res;

  QTcpSocket *sock = new QTcpSocket();
  sock->connectToHost(get_SocketHostAddress(), get_SocketPortNumber());
  res = sock->waitForConnected(get_SocketTimeout());
  m_IODevice = sock;

  if (!res) {
    printMessage(tr("Socket connection failed %1").arg(sock->errorString()));
  }

  return res;
}

ParityType QPidCommPort::parity ( int  idx )

slot

Definition at line 149 of file qpidcommport.cpp.

Referenced by openLocalSerialPort().

{
  switch(idx) {
  case 0:
    return PAR_NONE;

  case 1:
    return PAR_ODD;

  case 2:
    return PAR_EVEN;

  case 3:
    return PAR_SPACE;

  default:
    return PAR_NONE;
  }
}

void QPidCommPort::printMessage ( QString  msg, QDateTime  ts = QDateTime::currentDateTime()  )

slot

Definition at line 193 of file qpidcommport.cpp.

References m_Controller.

Referenced by bytesAvailable(), canReadLine(), isWritable(), openIfNeeded(), openLocalSerialPort(), openNetworkSocket(), read(), readAll(), readLine(), waitForBytesWritten(), waitForReadyRead(), and write().

{
  QPidControllerPtr ctl(m_Controller);

  if (ctl) {
    ctl->printMessage(msg, ts);
  }
}

QByteArray QPidCommPort::read

(

int

sz

)

Definition at line 232 of file qpidcommport.cpp.

References DEBUG_COMMPORT, DEBUG_LEVEL1, m_IODevice, openIfNeeded(), and printMessage().

{
  if (openIfNeeded()) {
    QByteArray res = m_IODevice->read(sz);

    set_Successful(res.count());

    if (qcepDebug(DEBUG_COMMPORT)) {
      if (qcepDebug(DEBUG_LEVEL1)) {
        printMessage(tr("QPidCommPort::read(%1): %2 (%3)").arg(sz).arg((QString) res).arg((QString) res.toHex()));
      } else {
        printMessage(tr("QPidCommPort::read(%1): %2").arg(sz).arg((QString) res));
      }
    }

    return res;
  } else {
    return QByteArray();
  }
}

QByteArray QPidCommPort::readAll

(

)

Definition at line 212 of file qpidcommport.cpp.

References DEBUG_COMMPORT, DEBUG_LEVEL1, m_IODevice, openIfNeeded(), and printMessage().

{
  if (openIfNeeded()) {
    QByteArray res = m_IODevice->readAll();

    set_Successful(res.count());

    if (qcepDebug(DEBUG_COMMPORT)) {
      if (qcepDebug(DEBUG_LEVEL1)) {
        printMessage(tr("QPidCommPort::readAll: %1 (%2)").arg((QString) res).arg((QString) res.toHex()));
      } else {
        printMessage(tr("QPidCommPort::readAll: %1").arg((QString) res));
      }
    }
    return res;
  } else {
    return QByteArray();
  }
}

QByteArray QPidCommPort::readLine

(

int

maxlen = 0

)

Definition at line 253 of file qpidcommport.cpp.

References DEBUG_COMMPORT, DEBUG_LEVEL1, m_IODevice, openIfNeeded(), and printMessage().

{
  if (openIfNeeded()) {
    QByteArray res = m_IODevice->readLine(maxlen);

    set_Successful(res.count());

    if (qcepDebug(DEBUG_COMMPORT)) {
      if (qcepDebug(DEBUG_LEVEL1)) {
        printMessage(tr("QPidCommPort::readLine(%1): %2 (%3)").arg(maxlen).arg((QString) res).arg((QString) res.toHex()));
      } else {
        printMessage(tr("QPidCommPort::readLine(%1): %2").arg(maxlen).arg((QString) res));
      }
    }

    return res;
  } else {
    return QByteArray();
  }
}

void QPidCommPort::readSettings ( QSettings *  set, QString  section  )

virtual

Definition at line 207 of file qpidcommport.cpp.

{
  QcepProperty::readSettings(this, &staticMetaObject, section, set);
}

void QPidCommPort::readyRead ( )

signal

StopBitsType QPidCommPort::stopBits ( int  idx )

slot

Definition at line 179 of file qpidcommport.cpp.

Referenced by openLocalSerialPort().

{
  switch(idx) {
  case 0:
    return STOP_1;

  case 1:
    return STOP_2;

  default:
    return STOP_1;
  }
}

bool QPidCommPort::successfullyConnected

(

)

Definition at line 288 of file qpidcommport.cpp.

{
  return get_Successful();
}

int QPidCommPort::waitForBytesWritten

(

int

tmout = 0

)

Definition at line 308 of file qpidcommport.cpp.

References DEBUG_COMMPORT, DEBUG_LEVEL1, m_IODevice, openIfNeeded(), and printMessage().

{
  if (openIfNeeded()) {
    int res = m_IODevice->waitForBytesWritten(tmout);

    if (qcepDebug(DEBUG_COMMPORT) && qcepDebug(DEBUG_LEVEL1)) {
      printMessage(tr("QPidCommPort::waitForBytesWritten(%1): %2").arg(tmout).arg(res));
    }

    return res;
  } else {
    return false;
  }
}

int QPidCommPort::waitForReadyRead

(

int

tmout = 0

)

Definition at line 323 of file qpidcommport.cpp.

References DEBUG_COMMPORT, DEBUG_LEVEL1, m_IODevice, openIfNeeded(), and printMessage().

{
  if (openIfNeeded()) {
    int res = m_IODevice->waitForReadyRead(tmout);

    set_Successful(res);

    if (qcepDebug(DEBUG_COMMPORT) && qcepDebug(DEBUG_LEVEL1)) {
      printMessage(tr("QPidCommPort::waitForReadyRead(%1): %2").arg(tmout).arg(res));
    }

    return res;
  } else {
    return false;
  }
}

void QPidCommPort::write

(

QByteArray

msg

)

Definition at line 293 of file qpidcommport.cpp.

References DEBUG_COMMPORT, DEBUG_LEVEL1, m_IODevice, openIfNeeded(), and printMessage().

{
  if (openIfNeeded()) {
    m_IODevice->write(msg);

    if (qcepDebug(DEBUG_COMMPORT)) {
      if (qcepDebug(DEBUG_LEVEL1)) {
        printMessage(tr("QPidCommPort::write(%1 (%3))").arg((QString) msg).arg((QString) msg.toHex()));
      } else {
        printMessage(tr("QPidCommPort::write(%1)").arg((QString) msg));
      }
    }
  }
}

void QPidCommPort::writeSettings ( QSettings *  set, QString  section  )

virtual

Definition at line 202 of file qpidcommport.cpp.

{
  QcepProperty::writeSettings(this, &staticMetaObject, section, set);
}

Member Data Documentation

QPidControllerWPtr QPidCommPort::m_Controller

private

Definition at line 108 of file qpidcommport.h.

Referenced by printMessage().

QPointer<QIODevice> QPidCommPort::m_IODevice

private

Definition at line 109 of file qpidcommport.h.

Referenced by bytesAvailable(), canReadLine(), isWritable(), openLocalSerialPort(), openNetworkSocket(), read(), readAll(), readLine(), waitForBytesWritten(), waitForReadyRead(), and write().

Property Documentation

int QPidCommPort::commPortType

readwrite

Definition at line 68 of file qpidcommport.h.

int QPidCommPort::connected

readwrite

Definition at line 101 of file qpidcommport.h.

QString QPidCommPort::epicsPVName

readwrite

Definition at line 98 of file qpidcommport.h.

int QPidCommPort::serialPortBaud

readwrite

Definition at line 74 of file qpidcommport.h.

int QPidCommPort::serialPortBits

readwrite

Definition at line 77 of file qpidcommport.h.

int QPidCommPort::serialPortFlowControl

readwrite

Definition at line 86 of file qpidcommport.h.

QString QPidCommPort::serialPortName

readwrite

Definition at line 71 of file qpidcommport.h.

int QPidCommPort::serialPortParity

readwrite

Definition at line 80 of file qpidcommport.h.

int QPidCommPort::serialPortStopBits

readwrite

Definition at line 83 of file qpidcommport.h.

QString QPidCommPort::socketHostAddress

readwrite

Definition at line 89 of file qpidcommport.h.

int QPidCommPort::socketPortNumber

readwrite

Definition at line 92 of file qpidcommport.h.

int QPidCommPort::socketTimeout

readwrite

Definition at line 95 of file qpidcommport.h.

int QPidCommPort::successful

readwrite

Definition at line 104 of file qpidcommport.h.

---

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

• qpidcommport.h
• qpidcommport.cpp