TwiceAsNice  2019-02-18
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Basda::Tempo::HitachiHighProtocol Class Reference

#include <HitachiHighProtocol.h>

Collaboration diagram for Basda::Tempo::HitachiHighProtocol:
Collaboration graph

Public Member Functions

 HitachiHighProtocol ()
 
 HitachiHighProtocol (std::string connection, bool create)
 
virtual ~HitachiHighProtocol ()
 
void createBroker (const std::string &connection)
 
void createBroker ()
 
void closeBroker ()
 
std::string getAnswer ()
 
void queryCpuStatus (bool &run, bool &halt, bool &error, bool &batteryerror, std::string &type)
 
void queryCpuName (std::string &cpuname)
 
void queryPIDconstants (double &c1, double &c2, double &c3, double &timer)
 
void queryHeliumPressureAuxilaries (double &max, double &min, double &hyst)
 
void queryHeliumPressure (double &pressure)
 
void queryDeltaU (int &delta)
 
void queryInputDouble (double &input)
 
void queryFanAndCryoRotation (double &freqcryo, double &freqfan, int &cryorpm, int &fanrpm)
 
void queryDefrost (double &defrost, double &defroststop)
 
void queryCurrentProcessValues (double &actualTemp, double &pt100Temp)
 
void queryHeliumValve (bool &plus, bool &minus)
 
void queryHeliumRange (double &range)
 
void queryCoilTemperature (double &coilTemp)
 
void queryAuxPt100Temperature (double &auxPt100Temp)
 
void querySetPointTemperature (double &setpoint)
 
void queryAdditionalTemperature (double &adTemp)
 
void queryAdditionalPressure (double &adPressure)
 
void setPIDvalueC1 (double newC1)
 
void setPIDvalueC2 (double newC2)
 
void setPIDvalueC3 (double newC3)
 
void setPIDvalueTsample (double newTsample)
 
void setDefrostTemperature (double newDefrost)
 
void setDefrostStopTemperature (double newDefrostStop)
 
void setSetPoint (double setpoint)
 
void setTransferFanPreset (int fanrpm)
 
 HitachiHighProtocol ()
 
 HitachiHighProtocol (std::string connection, bool create)
 
virtual ~HitachiHighProtocol ()
 
void createBroker (const std::string &connection)
 
void createBroker ()
 
void closeBroker ()
 
std::string getAnswer ()
 
void queryCpuStatus (bool &run, bool &halt, bool &error, bool &batteryerror, std::string &type)
 
void queryCpuName (std::string &cpuname)
 
void queryPIDconstants (double &c1, double &c2, double &c3, double &timer)
 
void queryHeliumPressureAuxilaries (double &max, double &min, double &hyst)
 
void queryHeliumPressure (double &pressure)
 
void queryDeltaU (int &delta)
 
void queryInputDouble (double &input)
 
void queryFanAndCryoRotation (double &freqcryo, double &freqfan, int &cryorpm, int &fanrpm)
 
void queryDefrost (double &defrost, double &defroststop)
 
void queryCurrentProcessValues (double &actualTemp, double &pt100Temp)
 
void queryHeliumValve (bool &plus, bool &minus)
 
void queryHeliumRange (double &range)
 
void queryCoilTemperature (double &coilTemp)
 
void queryAuxPt100Temperature (double &auxPt100Temp)
 
void querySetPointTemperature (double &setpoint)
 
void queryAdditionalTemperature (double &adTemp)
 
void queryAdditionalPressure (double &adPressure)
 
void setPIDvalueC1 (double newC1)
 
void setPIDvalueC2 (double newC2)
 
void setPIDvalueC3 (double newC3)
 
void setPIDvalueTsample (double newTsample)
 
void setDefrostTemperature (double newDefrost)
 
void setDefrostStopTemperature (double newDefrostStop)
 
void setSetPoint (double setpoint)
 
void setTransferFanPreset (int fanrpm)
 

Protected Member Functions

void sendMsg (const std::string &msg)
 this function sends a specific command to the device More...
 
void readMsg (std::string &rcv)
 this function reads the answer from the device More...
 
void processCommand (std::string command, std::string &answer)
 this function deals with the command processing More...
 
void sendMsg (const std::string &msg)
 this function sends a specific command to the device More...
 
void readMsg (std::string &rcv)
 this function reads the answer from the device More...
 
void processCommand (std::string command, std::string &answer)
 this function deals with the command processing More...
 

Private Member Functions

void setConnection (std::string connection)
 this function is used to set the m_IpInfo variable to a specific string More...
 
void setConnection (std::string connection)
 this function is used to set the m_IpInfo variable to a specific string More...
 

Private Attributes

Basda::Tempo::Stirling::HexConnectionBrokerm_broker
 reference to the connection broker dealing with tcp connection via n-port to the cooler More...
 
Basda::Tempo::Stirling::ProtocolUtil m_util
 the utilities for the H-protocol More...
 
std::string m_connection
 this string contains the connection informations (ip adress, port) More...
 
bool m_isConnected
 this boolean indicates if there is an active connection to a device More...
 
std::string m_answer
 this string contains the latest answer from the device More...
 

Constructor & Destructor Documentation

◆ HitachiHighProtocol() [1/4]

Basda::Tempo::HitachiHighProtocol::HitachiHighProtocol ( )

◆ HitachiHighProtocol() [2/4]

Basda::Tempo::HitachiHighProtocol::HitachiHighProtocol ( std::string  connection,
bool  create 
)

◆ ~HitachiHighProtocol() [1/2]

Basda::Tempo::HitachiHighProtocol::~HitachiHighProtocol ( )
virtual

◆ HitachiHighProtocol() [3/4]

Basda::Tempo::HitachiHighProtocol::HitachiHighProtocol ( )

◆ HitachiHighProtocol() [4/4]

Basda::Tempo::HitachiHighProtocol::HitachiHighProtocol ( std::string  connection,
bool  create 
)

◆ ~HitachiHighProtocol() [2/2]

virtual Basda::Tempo::HitachiHighProtocol::~HitachiHighProtocol ( )
virtual

Member Function Documentation

◆ closeBroker() [1/2]

void Basda::Tempo::HitachiHighProtocol::closeBroker ( )

◆ closeBroker() [2/2]

void Basda::Tempo::HitachiHighProtocol::closeBroker ( )

◆ createBroker() [1/4]

void Basda::Tempo::HitachiHighProtocol::createBroker ( const std::string &  connection)

◆ createBroker() [2/4]

void Basda::Tempo::HitachiHighProtocol::createBroker ( const std::string &  connection)

◆ createBroker() [3/4]

void Basda::Tempo::HitachiHighProtocol::createBroker ( )

◆ createBroker() [4/4]

void Basda::Tempo::HitachiHighProtocol::createBroker ( )

◆ getAnswer() [1/2]

std::string Basda::Tempo::HitachiHighProtocol::getAnswer ( )
inline

◆ getAnswer() [2/2]

std::string Basda::Tempo::HitachiHighProtocol::getAnswer ( )
inline

◆ processCommand() [1/2]

void Basda::Tempo::HitachiHighProtocol::processCommand ( std::string  command,
std::string &  answer 
)
protected

this function deals with the command processing

Parameters
commandthe command to send to the cooler
finalanswer from the cooler

The command is pre-processed (checksum creation, converted into right format) and send to the cooler. The ACK/NAK response is checked and if everything is okay, the ready-to-receive message is send to the cooler resulting in the final answer including requested data.

◆ processCommand() [2/2]

void Basda::Tempo::HitachiHighProtocol::processCommand ( std::string  command,
std::string &  answer 
)
protected

this function deals with the command processing

Parameters
commandthe command to send to the cooler
finalanswer from the cooler

The command is pre-processed (checksum creation, converted into right format) and send to the cooler. The ACK/NAK response is checked and if everything is okay, the ready-to-receive message is send to the cooler resulting in the final answer including requested data.

◆ queryAdditionalPressure() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryAdditionalPressure ( double &  adPressure)

◆ queryAdditionalPressure() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryAdditionalPressure ( double &  adPressure)

◆ queryAdditionalTemperature() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryAdditionalTemperature ( double &  adTemp)

◆ queryAdditionalTemperature() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryAdditionalTemperature ( double &  adTemp)

◆ queryAuxPt100Temperature() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryAuxPt100Temperature ( double &  auxPt100Temp)

◆ queryAuxPt100Temperature() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryAuxPt100Temperature ( double &  auxPt100Temp)

◆ queryCoilTemperature() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryCoilTemperature ( double &  coilTemp)

◆ queryCoilTemperature() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryCoilTemperature ( double &  coilTemp)

◆ queryCpuName() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryCpuName ( std::string &  cpuname)

◆ queryCpuName() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryCpuName ( std::string &  cpuname)

◆ queryCpuStatus() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryCpuStatus ( bool run,
bool halt,
bool error,
bool batteryerror,
std::string &  type 
)

◆ queryCpuStatus() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryCpuStatus ( bool run,
bool halt,
bool error,
bool batteryerror,
std::string &  type 
)

◆ queryCurrentProcessValues() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryCurrentProcessValues ( double &  actualTemp,
double &  pt100Temp 
)

◆ queryCurrentProcessValues() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryCurrentProcessValues ( double &  actualTemp,
double &  pt100Temp 
)

◆ queryDefrost() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryDefrost ( double &  defrost,
double &  defroststop 
)

◆ queryDefrost() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryDefrost ( double &  defrost,
double &  defroststop 
)

◆ queryDeltaU() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryDeltaU ( int &  delta)

◆ queryDeltaU() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryDeltaU ( int &  delta)

◆ queryFanAndCryoRotation() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryFanAndCryoRotation ( double &  freqcryo,
double &  freqfan,
int &  cryorpm,
int &  fanrpm 
)

◆ queryFanAndCryoRotation() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryFanAndCryoRotation ( double &  freqcryo,
double &  freqfan,
int &  cryorpm,
int &  fanrpm 
)

◆ queryHeliumPressure() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryHeliumPressure ( double &  pressure)

◆ queryHeliumPressure() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryHeliumPressure ( double &  pressure)

◆ queryHeliumPressureAuxilaries() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryHeliumPressureAuxilaries ( double &  max,
double &  min,
double &  hyst 
)

◆ queryHeliumPressureAuxilaries() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryHeliumPressureAuxilaries ( double &  max,
double &  min,
double &  hyst 
)

◆ queryHeliumRange() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryHeliumRange ( double &  range)

◆ queryHeliumRange() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryHeliumRange ( double &  range)

◆ queryHeliumValve() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryHeliumValve ( bool plus,
bool minus 
)

◆ queryHeliumValve() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryHeliumValve ( bool plus,
bool minus 
)

◆ queryInputDouble() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryInputDouble ( double &  input)

◆ queryInputDouble() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryInputDouble ( double &  input)

◆ queryPIDconstants() [1/2]

void Basda::Tempo::HitachiHighProtocol::queryPIDconstants ( double &  c1,
double &  c2,
double &  c3,
double &  timer 
)

◆ queryPIDconstants() [2/2]

void Basda::Tempo::HitachiHighProtocol::queryPIDconstants ( double &  c1,
double &  c2,
double &  c3,
double &  timer 
)

◆ querySetPointTemperature() [1/2]

void Basda::Tempo::HitachiHighProtocol::querySetPointTemperature ( double &  setpoint)

◆ querySetPointTemperature() [2/2]

void Basda::Tempo::HitachiHighProtocol::querySetPointTemperature ( double &  setpoint)

◆ readMsg() [1/2]

void Basda::Tempo::HitachiHighProtocol::readMsg ( std::string &  rcv)
protected

this function reads the answer from the device

Parameters
rcvanswer from the device

◆ readMsg() [2/2]

void Basda::Tempo::HitachiHighProtocol::readMsg ( std::string &  rcv)
protected

this function reads the answer from the device

Parameters
rcvanswer from the device

◆ sendMsg() [1/2]

void Basda::Tempo::HitachiHighProtocol::sendMsg ( const std::string &  msg)
protected

this function sends a specific command to the device

Parameters
msgmessage to send
Returns
number of chars sent

◆ sendMsg() [2/2]

void Basda::Tempo::HitachiHighProtocol::sendMsg ( const std::string &  msg)
protected

this function sends a specific command to the device

Parameters
msgmessage to send
Returns
number of chars sent

◆ setConnection() [1/2]

void Basda::Tempo::HitachiHighProtocol::setConnection ( std::string  connection)
private

this function is used to set the m_IpInfo variable to a specific string

◆ setConnection() [2/2]

void Basda::Tempo::HitachiHighProtocol::setConnection ( std::string  connection)
private

this function is used to set the m_IpInfo variable to a specific string

◆ setDefrostStopTemperature() [1/2]

void Basda::Tempo::HitachiHighProtocol::setDefrostStopTemperature ( double  newDefrostStop)

◆ setDefrostStopTemperature() [2/2]

void Basda::Tempo::HitachiHighProtocol::setDefrostStopTemperature ( double  newDefrostStop)

◆ setDefrostTemperature() [1/2]

void Basda::Tempo::HitachiHighProtocol::setDefrostTemperature ( double  newDefrost)

◆ setDefrostTemperature() [2/2]

void Basda::Tempo::HitachiHighProtocol::setDefrostTemperature ( double  newDefrost)

◆ setPIDvalueC1() [1/2]

void Basda::Tempo::HitachiHighProtocol::setPIDvalueC1 ( double  newC1)

◆ setPIDvalueC1() [2/2]

void Basda::Tempo::HitachiHighProtocol::setPIDvalueC1 ( double  newC1)

◆ setPIDvalueC2() [1/2]

void Basda::Tempo::HitachiHighProtocol::setPIDvalueC2 ( double  newC2)

◆ setPIDvalueC2() [2/2]

void Basda::Tempo::HitachiHighProtocol::setPIDvalueC2 ( double  newC2)

◆ setPIDvalueC3() [1/2]

void Basda::Tempo::HitachiHighProtocol::setPIDvalueC3 ( double  newC3)

◆ setPIDvalueC3() [2/2]

void Basda::Tempo::HitachiHighProtocol::setPIDvalueC3 ( double  newC3)

◆ setPIDvalueTsample() [1/2]

void Basda::Tempo::HitachiHighProtocol::setPIDvalueTsample ( double  newTsample)

◆ setPIDvalueTsample() [2/2]

void Basda::Tempo::HitachiHighProtocol::setPIDvalueTsample ( double  newTsample)

◆ setSetPoint() [1/2]

void Basda::Tempo::HitachiHighProtocol::setSetPoint ( double  setpoint)

◆ setSetPoint() [2/2]

void Basda::Tempo::HitachiHighProtocol::setSetPoint ( double  setpoint)

◆ setTransferFanPreset() [1/2]

void Basda::Tempo::HitachiHighProtocol::setTransferFanPreset ( int  fanrpm)

◆ setTransferFanPreset() [2/2]

void Basda::Tempo::HitachiHighProtocol::setTransferFanPreset ( int  fanrpm)

Member Data Documentation

◆ m_answer

std::string Basda::Tempo::HitachiHighProtocol::m_answer
private

this string contains the latest answer from the device

◆ m_broker

Basda::Tempo::Stirling::HexConnectionBroker * Basda::Tempo::HitachiHighProtocol::m_broker
private

reference to the connection broker dealing with tcp connection via n-port to the cooler

◆ m_connection

std::string Basda::Tempo::HitachiHighProtocol::m_connection
private

this string contains the connection informations (ip adress, port)

◆ m_isConnected

bool Basda::Tempo::HitachiHighProtocol::m_isConnected
private

this boolean indicates if there is an active connection to a device

◆ m_util

Basda::Tempo::Stirling::ProtocolUtil Basda::Tempo::HitachiHighProtocol::m_util
private

the utilities for the H-protocol


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