QCryostreamDevice Class Reference

#include <qcryostreamdevice.h>

Inheritance diagram for QCryostreamDevice:

Public Slots
void	sendCommand (QString cmd)
void	readoutInitial ()
void	readoutPolling ()
void	readoutTimeout ()
void	changeSetPoint (double setPoint)
void	changeRampRate (double rate)
void	changeProportional (double prop)
void	changeIntegral (double integ)
void	changeDerivative (double deriv)
void	enable (bool on)
bool	canAutoTune ()
void	autoTune ()
void	readyRead ()
Public Slots inherited from QPidDevice
void	printMessage (QString msg, QDateTime ts=QDateTime::currentDateTime())
virtual void	readoutInitial ()=0
virtual void	readoutPolling ()=0
virtual void	readoutTimeout ()=0
virtual void	sendCommand (QString cmd)=0
virtual void	changeSetPoint (double setPoint)=0
virtual void	changeRampRate (double rate)=0
virtual void	changeProportional (double prop)=0
virtual void	changeIntegral (double integ)=0
virtual void	changeDerivative (double deriv)=0
virtual void	enable (bool on)=0
virtual void	loopEnable (bool on)
virtual bool	canAutoTune ()=0
virtual void	autoTune ()=0
virtual void	readyRead ()
virtual void	onGraphingTimeout ()
virtual void	onLoggingTimeout ()
virtual void	start ()
virtual void	stop ()
virtual void	restart ()
virtual void	changeRunState (int state)
virtual void	changePollingInterval (double interval)
virtual void	changeTimeoutInterval (double interval)
virtual void	changeGraphingInterval (double interval)
virtual void	changeLoggingInterval (double interval)
virtual void	write (QString cmd)
virtual QString	readLine (int sz=0)
virtual int	waitForReadyRead (int tmout=0)
virtual int	bytesAvailable ()
virtual int	canReadLine ()

Public Member Functions
	QCryostreamDevice (QPidControllerWPtr ctrl, QcepSettingsSaverWPtr saver, QString deviceName)
void	configurationDialog ()
virtual void	writeSettings (QSettings *set, QString section)
virtual void	readSettings (QSettings *set, QString section)
Public Member Functions inherited from QPidDevice
	QPidDevice (QPidControllerWPtr ctrl, QcepSettingsSaverWPtr saver, int deviceType, QString deviceName, int pollIntervalMsec, int timeoutMsec)
virtual	~QPidDevice ()
QPidControllerWPtr	controller () const
double	cK2K (double cK)
double	K2cK (double K)
double	K2degC (double K)
double	degC2K (double degC)
void	updateConnected (double newConnected)
void	updateTemperature (double newTemperature)
void	updateRampPoint (double newRampPoint)
void	updateOutputLevel (double newOutputLevel)
void	resetTimeout ()
void	pushCommand (QPidDeviceCommandPtr cmd)
void	issueCommand ()
void	completeCommand (QByteArray response)
void	flushCommandQueue ()
int	slowly (int msec)
QPidCommPortPtr	commPort ()

Public Attributes
QPidObjectNamer	m_ObjectNamer

Properties
int	cryostreamDeviceType
Properties inherited from QPidDevice
int	deviceType
QString	deviceTypeName
QString	deviceLongTypeName
QString	deviceName
int	runState
double	pollingInterval
double	timeoutInterval

Private Types
enum	{   UnknownDevice = 0, CryostreamDevice = 1, PhenixDevice = 100, CobraDevice = 150,   HelixDevice = 200 }

Private Slots
int	makeWord (int hi, int lo)

Private Member Functions
void	parseStatusPacket ()
void	sendCryoCommand (int cmd, QByteArray args=QByteArray())
QByteArray	cryoRate (double rate)
QByteArray	cryoTemperature (double temp)

Private Attributes
QByteArray	m_Buffer
QCryostreamDeviceDialogPtr	m_DeviceDialog

Additional Inherited Members
Public Types inherited from QPidDevice
enum	{   NoDevice = 0, WatlowDevice = 1, PTC10Device = 2, LakeshoreDevice = 3,   CryostreamDevice = 4, EurothermDevice = 5 }
Signals inherited from QPidDevice
void	inputChannelChanged (QString name, QString units)
void	outputChannelChanged (QString name, QString units)
void	loggedChannelNames (QStringList names)
void	loggedChannelValues (QcepDoubleList values)
void	graphedChannelNames (QStringList names)
void	graphedChannelValues (QcepDoubleList values)
Static Public Member Functions inherited from QPidDevice
static QString	deviceTypeName (int typ)
static QString	deviceLongTypeName (int typ)
static int	deviceTypeCount ()

Detailed Description

Definition at line 10 of file qcryostreamdevice.h.

Member Enumeration Documentation

anonymous enum

private

Enumerator
UnknownDevice
CryostreamDevice
PhenixDevice
CobraDevice
HelixDevice

Definition at line 47 of file qcryostreamdevice.h.

       {
    UnknownDevice     = 0,
    CryostreamDevice  = 1,
    PhenixDevice      = 100,
    CobraDevice       = 150,
    HelixDevice       = 200
  };

Constructor & Destructor Documentation

QCryostreamDevice::QCryostreamDevice ( QPidControllerWPtr  ctrl, QcepSettingsSaverWPtr  saver, QString  deviceName  )

explicit

Definition at line 178 of file qcryostreamdevice.cpp.

                                                                                                             :
  QPidDevice(ctrl, saver, QPidDevice::CryostreamDevice, deviceName, 1000, 2000),
  m_ObjectNamer(this, "cryostream"),
  m_CryostreamDeviceType(QcepSettingsSaverPtr(), this, "cryostreamDeviceType", UnknownDevice, "Detected Device Type")
{
}

Member Function Documentation

void QCryostreamDevice::autoTune ( )

slot

Definition at line 352 of file qcryostreamdevice.cpp.

{
}

bool QCryostreamDevice::canAutoTune ( )

slot

Definition at line 347 of file qcryostreamdevice.cpp.

{
  return false;
}

void QCryostreamDevice::changeDerivative ( double  deriv )

slot

Definition at line 334 of file qcryostreamdevice.cpp.

{
}

void QCryostreamDevice::changeIntegral ( double  integ )

slot

Definition at line 330 of file qcryostreamdevice.cpp.

{
}

void QCryostreamDevice::changeProportional ( double  prop )

slot

Definition at line 326 of file qcryostreamdevice.cpp.

{
}

void QCryostreamDevice::changeRampRate ( double  rate )

slot

Definition at line 322 of file qcryostreamdevice.cpp.

{
}

void QCryostreamDevice::changeSetPoint ( double  setPoint )

slot

Definition at line 313 of file qcryostreamdevice.cpp.

References QPidDevice::controller(), cryoRate(), cryoTemperature(), CSCOMMAND_RAMP, and sendCryoCommand().

{
  QPidControllerPtr ctl(controller());

  if (ctl) {
    sendCryoCommand(CSCOMMAND_RAMP, cryoRate(ctl->get_RampRate())+cryoTemperature(setPoint));
  }
}

void QCryostreamDevice::configurationDialog ( )

virtual

Implements QPidDevice.

Definition at line 297 of file qcryostreamdevice.cpp.

References m_DeviceDialog.

{
  if (m_DeviceDialog == NULL) {
    m_DeviceDialog = QCryostreamDeviceDialogPtr(new QCryostreamDeviceDialog(QCryostreamDevicePtr(this)));
  }

  if (m_DeviceDialog) {
    m_DeviceDialog->show();
    m_DeviceDialog->raise();
  }
}

QByteArray QCryostreamDevice::cryoRate ( double  rate )

private

Definition at line 377 of file qcryostreamdevice.cpp.

Referenced by changeSetPoint().

{
  QByteArray res;

  short rateint = (short)(rate*60);

  res.append((unsigned char) ((rateint>>8) & 0xff));
  res.append((unsigned char) (rateint & 0xff));

  return res;
}

QByteArray QCryostreamDevice::cryoTemperature ( double  temp )

private

Definition at line 389 of file qcryostreamdevice.cpp.

References QPidDevice::degC2K(), and QPidDevice::K2cK().

Referenced by changeSetPoint().

{
  QByteArray res;

  short cKTemp = (short)(K2cK(degC2K(temp)));

  res.append((unsigned char) ((cKTemp>>8) & 0xff));
  res.append((unsigned char) (cKTemp & 0xff));

  return res;
}

void QCryostreamDevice::enable ( bool  on )

slot

Definition at line 338 of file qcryostreamdevice.cpp.

References CSCOMMAND_RESTART, CSCOMMAND_STOP, and sendCryoCommand().

{
  if (on) {
    sendCryoCommand(CSCOMMAND_RESTART);
  } else {
    sendCryoCommand(CSCOMMAND_STOP);
  }
}

int QCryostreamDevice::makeWord ( int  hi, int  lo  )

privateslot

Definition at line 204 of file qcryostreamdevice.cpp.

Referenced by parseStatusPacket().

{
  return (hi&0xff << 8) | (lo&0xff);
}

void QCryostreamDevice::parseStatusPacket ( )

private

Definition at line 209 of file qcryostreamdevice.cpp.

References QPidDevice::cK2K(), CobraDevice, QPidDevice::controller(), CryostreamDevice, HelixDevice, QPidDevice::K2degC(), m_Buffer, makeWord(), PhenixDevice, QPidDevice::printMessage(), and UnknownDevice.

Referenced by readyRead().

{
  while (m_Buffer.count() >= 2) {
    printMessage(tr("parseStatusPacket(len=%1)").arg(m_Buffer.count()));

    unsigned char len = m_Buffer[0];
    unsigned char typ = m_Buffer[1];

    if ((len == 32 && typ == 1) ||       // Standard status packet
        (len == 42 && typ == 2) ||       // Extended status packet
        (len == 44 && typ == 150) ||     // Cobra status packet
        (len == 32 && typ == 100) ||     // Phenix status packet
        (len == 46 && typ == 200)) {     // Helix status packet

      if (m_Buffer.count() >= 32) {
        int setPoint    = makeWord(m_Buffer[2], m_Buffer[3]);
        int temperature = makeWord(m_Buffer[4], m_Buffer[5]);
        int temperror   = makeWord(m_Buffer[6], m_Buffer[7]);
        int output      = m_Buffer[21];
        int runMode     = m_Buffer[8];
        int phaseID     = m_Buffer[9];
        int alarmCode   = m_Buffer[25];

        if ((runMode >= 0 && runMode <= 6) &&             // run mode 0..6
            (phaseID >= 0 && phaseID <= (typ<10?10:9)) && // Cryostream phaseID 0..10, others 0..9
            (alarmCode >= 0 && alarmCode <= 26) &&        // alarm code 0..26
            (temperature - setPoint == temperror)) {      // temperature error OK?
          if (m_Buffer.count() >= len) {
            switch(typ) {
            case 1:
            case 2:
              set_CryostreamDeviceType(CryostreamDevice);
              break;

            case 100:
              set_CryostreamDeviceType(PhenixDevice);
              break;

            case 150:
              set_CryostreamDeviceType(CobraDevice);
              break;

            case 200:
              set_CryostreamDeviceType(HelixDevice);
              break;

            default:
              set_CryostreamDeviceType(UnknownDevice);
            }

            QPidControllerPtr ctl(controller());

            if (ctl) {
              ctl->set_Temperature(K2degC(cK2K(temperature)));
              ctl->set_SetPoint(K2degC(cK2K(setPoint)));
              ctl->set_OutputLevel(output);
              ctl->set_Enabled(runMode==3);
            }

            m_Buffer.remove(0, len);
          } else {
            break;
          }
        } else {
          // Not a valid status packet - drop 1 byte and try again
          m_Buffer.remove(0,1);
        }
      }
    } else {
      m_Buffer.remove(0,1);
    }
  }
}

void QCryostreamDevice::readoutInitial ( )

slot

Definition at line 185 of file qcryostreamdevice.cpp.

{
}

void QCryostreamDevice::readoutPolling ( )

slot

Definition at line 189 of file qcryostreamdevice.cpp.

{
}

void QCryostreamDevice::readoutTimeout ( )

slot

Definition at line 193 of file qcryostreamdevice.cpp.

{
}

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

virtual

Reimplemented from QPidDevice.

Definition at line 290 of file qcryostreamdevice.cpp.

References QPidDevice::readSettings().

{
  QPidDevice::readSettings(set, section+"/cryostream");

  QcepProperty::readSettings(this, &staticMetaObject, section+"/cryostream", set);
}

void QCryostreamDevice::readyRead ( )

slot

Definition at line 197 of file qcryostreamdevice.cpp.

References QPidDevice::commPort(), m_Buffer, and parseStatusPacket().

{
  m_Buffer.append(commPort()->readAll());

  parseStatusPacket();
}

void QCryostreamDevice::sendCommand ( QString  cmd )

slot

Definition at line 309 of file qcryostreamdevice.cpp.

{
}

void QCryostreamDevice::sendCryoCommand ( int  cmd, QByteArray  args = QByteArray()  )

private

Definition at line 356 of file qcryostreamdevice.cpp.

References QPidDevice::commPort(), and QPidDevice::printMessage().

Referenced by changeSetPoint(), and enable().

{
  printMessage(tr("sendCryoCommand(%1,QByteArray(len=%2))").arg(cmd).arg(args.count()));

  if (get_DeviceType() == 0) {
    printMessage("Warning: Sending command to unknown device");
  }

  QByteArray msg;

  msg.append(2+args.count());
  msg.append(cmd);
  msg.append(args);

  if (commPort()->isWritable()) {
    commPort()->write(msg);
  } else {
    printMessage("Serial port is not writable");
  }
}

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

virtual

Reimplemented from QPidDevice.

Definition at line 283 of file qcryostreamdevice.cpp.

References QPidDevice::writeSettings().

{
  QPidDevice::writeSettings(set, section+"/cryostream");

  QcepProperty::writeSettings(this, &staticMetaObject, section+"/cryostream", set);
}

Member Data Documentation

QByteArray QCryostreamDevice::m_Buffer

private

Definition at line 66 of file qcryostreamdevice.h.

Referenced by parseStatusPacket(), and readyRead().

QCryostreamDeviceDialogPtr QCryostreamDevice::m_DeviceDialog

private

Definition at line 67 of file qcryostreamdevice.h.

Referenced by configurationDialog().

QPidObjectNamer QCryostreamDevice::m_ObjectNamer

Definition at line 56 of file qcryostreamdevice.h.

Property Documentation

int QCryostreamDevice::cryostreamDeviceType

readwrite

Definition at line 61 of file qcryostreamdevice.h.

---

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

• qcryostreamdevice.h
• qcryostreamdevice.cpp