QSlowControlClient Class Reference

Inheritance diagram for QSlowControlClient:

QBaseClient List of all members.

Detailed Description

class used to hide client-side network communication with slow server

Author:
sergio.didomizio@ge.infn.it


Public Member Functions

 QSlowControlClient ()
 empty constructor
 QSlowControlClient (const std::string &address, const std::string &port)
 constructor
bool SetWriteMode (bool canWrite)
 set write mode
bool SetBaseMode ()
 set server mode to "base"
bool SetRunMode ()
 set server mode to "run"
bool SetTuningMode (unsigned int basket)
 set server mode to "tuning"
bool GetMode (QSlowTypes::QSlowMode_t &mode)
 get current slow server mode
bool GetBasket (int &basket)
 Get current settings basket.
bool LoadDevice (QSlowTypes::QSlowDevice_t dev, QSlowTypes::QSlowEleInterface_t iface)
 Load the specified device controller using the specified communication interface.
bool GetInterface (QSlowTypes::QSlowDevice_t dev, QSlowTypes::QSlowEleInterface_t &iface)
 Get used interface for the specified device controller.
bool GetFEInterface (QSlowTypes::QSlowEleInterface_t &iface)
 Get front-end interface.
bool GetBSInterface (QSlowTypes::QSlowEleInterface_t &iface)
 Get Bessel interface.
bool GetPSInterface (QSlowTypes::QSlowEleInterface_t &iface)
 Get Pulser interface.
bool SetFEInterface (QSlowTypes::QSlowEleInterface_t iface)
 Load the Front-End controller using the specified communication interface.
bool SetBSInterface (QSlowTypes::QSlowEleInterface_t iface)
 Load the Bessel controller using the specified communication interface.
bool SetPSInterface (QSlowTypes::QSlowEleInterface_t iface)
 Load the Front-End controlled using the specified communication interface.
bool WritePulser (unsigned short pulseId, char mem0, char mem1, char mem2, char mem3)
 write pulser registers
bool GetPulserRegister (unsigned short id, size_t reg, int &value)
 Get Pulser register.
bool SetEleRegister (unsigned short lg, size_t reg, int value)
 set Front End or Bessel register
bool GetEleRegister (unsigned short lg, size_t reg, int &value)
 Get Front End or Bessel register.
bool SetFEGain (unsigned short lg, int value)
 set Front End bias
bool GetFEGain (unsigned short lg, int &value)
 get Front End Gain
bool SetFEBias (unsigned short lg, int value)
 set Front End Gain
bool GetFEBias (unsigned short lg, int &value)
 get Front End bias
bool GetFEBiasPolarity (unsigned short lg, bool &pol)
 get Front End bias polarity
bool SetFEBiasPolarity (unsigned short lg, bool pol)
 set Front End bias polarity
bool InvertFEBiasPolarity (unsigned short lg)
 invert Front End bias polarity
bool SetFELoadResistor (unsigned short lg, bool rload)
 set Front End load resitor value.
bool GetFELoadResistor (unsigned short lg, bool &rload)
 get Front End load resitor value.
bool SetFEInput (unsigned short lg, bool input)
 set Front End input.
bool GetFEInput (unsigned short lg, bool &input)
 get Front End inout.
bool AdjustFEOffset (unsigned short lg)
 adjust baseline baseline
bool SetFEOffsetDAC (unsigned short lg, int value)
 write the offset DAC on the Front End.
bool GetFEOffsetDAC (unsigned short lg, int &value)
 read the offset DAC from the Front End
bool SetFEOffsetMSB (unsigned short lg, int value)
 write the offset MSBs on the Front End .
bool GetFEOffsetMSB (unsigned short lg, int &value)
 read offset MSBs from the Front End
bool GetFEOffsetPolarity (unsigned short lg, bool &pol)
 get Front End offset polarity
bool SetFEOffsetPolarity (unsigned short lg, bool pol)
 set Front End offset polarity
bool InvertFEOffsetPolarity (unsigned short lg)
 invert Front End offset polarity
bool GetFEOffsetSpecialBit (unsigned short lg, bool &status)
 get Front End offset special bit
bool SetFEOffsetSpecialBit (unsigned short lg, bool status)
 set Front End offset special bit
bool InvertFEOffsetSpecialBit (unsigned short lg)
 invert Front End offset special bit
bool SetBSCutFreq (unsigned short lg, int cutFreq)
 set the cut frequency on the Bessel.
bool GetBSCutFreq (unsigned short lg, int &cutFreq)
 get the frequency from the Bessel.
bool SetBSFilterEnable (unsigned short lg, bool status)
 set Filter enable Status
bool GetBSFilterEnable (unsigned short lg, bool &status)
 get Filter enable Status
bool TurnBSFilterON (unsigned short lg)
 enable Filter
bool TurnBSFilterOFF (unsigned short lg)
 Disable Filter.
bool SetPSupplyInterface (QSlowTypes::QSlowEleInterface_t iface)
 Load the Power Supply controller using the specified communication interface.
bool GetPSupplyInterface (QSlowTypes::QSlowEleInterface_t &iface)
 Get power supply interface.
bool SetPSupplyVset (unsigned short channel, double vset)
 set power supply voltage
bool SetPSupplyIset (unsigned short channel, double iset)
 set power supply current
bool SetPSupplyVsetDiff (double vset)
 set power supply differential voltage vset
bool GetPSupplyVsetDiff (double &vset)
 get power supply differential voltage vset
bool GetPSupplyVoutDiff (double &vout)
 get power supply differential voltage vset
bool GetPSupplyVset (unsigned short channel, double &vset)
 get power supply voltage set
bool GetPSupplyIset (unsigned short channel, double &iset)
 get power supply current set
bool GetPSupplyVout (unsigned short channel, double &vout)
 get power supply output voltage
bool GetPSupplyIout (unsigned short channel, double &iout)
 get power supply output current
bool SetPSupplyOutputEnable (unsigned short channel, bool status)
 set power supply output enable
bool GetPSupplyOutputEnable (unsigned short channel, bool &status)
 get power supply output enable
bool TurnPSupplyOutputON (unsigned short channel)
 enable power supply output
bool TurnPSupplyOutputOFF (unsigned short channel)
 disable power supply output


Member Function Documentation

bool QSlowControlClient::SetWriteMode ( bool  canWrite  ) 

set write mode

Parameters:
canWrite true if write mode is on, false if it is off
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetBaseMode (  ) 

set server mode to "base"

Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetRunMode (  ) 

set server mode to "run"

Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetTuningMode ( unsigned int  basket  ) 

set server mode to "tuning"

Parameters:
basket db settings basket to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetMode ( QSlowTypes::QSlowMode_t &  mode  ) 

get current slow server mode

Parameters:
mode this variable is set to current server mode
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetBasket ( int &  basket  ) 

Get current settings basket.

Parameters:
basket this variable is set to current settings basket
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::LoadDevice ( QSlowTypes::QSlowDevice_t  dev,
QSlowTypes::QSlowEleInterface_t  iface 
)

Load the specified device controller using the specified communication interface.

Parameters:
dev device to load
iface used communication interface
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetInterface ( QSlowTypes::QSlowDevice_t  dev,
QSlowTypes::QSlowEleInterface_t &  iface 
)

Get used interface for the specified device controller.

Parameters:
dev device
iface returned communication interface
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetFEInterface ( QSlowTypes::QSlowEleInterface_t &  iface  ) 

Get front-end interface.

Parameters:
iface current communication interface
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetBSInterface ( QSlowTypes::QSlowEleInterface_t &  iface  ) 

Get Bessel interface.

Parameters:
iface current communication interface
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetPSInterface ( QSlowTypes::QSlowEleInterface_t &  iface  ) 

Get Pulser interface.

Parameters:
iface current communication interface
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetFEInterface ( QSlowTypes::QSlowEleInterface_t  iface  ) 

Load the Front-End controller using the specified communication interface.

Parameters:
iface used communication interface
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetBSInterface ( QSlowTypes::QSlowEleInterface_t  iface  ) 

Load the Bessel controller using the specified communication interface.

Parameters:
iface used communication interface
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetPSInterface ( QSlowTypes::QSlowEleInterface_t  iface  ) 

Load the Front-End controlled using the specified communication interface.

Parameters:
iface used communication interface
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::WritePulser ( unsigned short  pulseId,
char  mem0,
char  mem1,
char  mem2,
char  mem3 
)

write pulser registers

Parameters:
pulseId pulser id as found in db
mem0 mem0 (1 byte)
mem0 mem1 (1 byte)
mem0 mem2 (1 byte)
mem0 mem3 (1 byte)
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetPulserRegister ( unsigned short  id,
size_t  reg,
int &  value 
)

Get Pulser register.

Parameters:
reg register to be get
value,register get value
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetEleRegister ( unsigned short  lg,
size_t  reg,
int  value 
)

set Front End or Bessel register

Parameters:
reg register to be set
value value to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetEleRegister ( unsigned short  lg,
size_t  reg,
int &  value 
)

Get Front End or Bessel register.

Parameters:
reg register to be set
value,register get value
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetFEGain ( unsigned short  lg,
int  value 
)

set Front End bias

Parameters:
value this variable is bias value to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetFEGain ( unsigned short  lg,
int &  value 
)

get Front End Gain

Parameters:
value this variable is set to the get gain value
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetFEBias ( unsigned short  lg,
int  value 
)

set Front End Gain

Parameters:
value this variable is the gain value to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetFEBias ( unsigned short  lg,
int &  value 
)

get Front End bias

Parameters:
value this variable is set to the get bias value
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetFEBiasPolarity ( unsigned short  lg,
bool &  pol 
)

get Front End bias polarity

Parameters:
pol this variable is set to the get bias polarity
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetFEBiasPolarity ( unsigned short  lg,
bool  pol 
)

set Front End bias polarity

Parameters:
pol,this variable is the bias polarity to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::InvertFEBiasPolarity ( unsigned short  lg  ) 

invert Front End bias polarity

Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetFELoadResistor ( unsigned short  lg,
bool  rload 
)

set Front End load resitor value.

Parameters:
rload this variable is the load resistor value to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetFELoadResistor ( unsigned short  lg,
bool &  rload 
)

get Front End load resitor value.

Parameters:
rload this variable is set to the get load reistance
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetFEInput ( unsigned short  lg,
bool  input 
)

set Front End input.

Parameters:
input this variable specified the selected input (bolometer or test signal)
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetFEInput ( unsigned short  lg,
bool &  input 
)

get Front End inout.

Parameters:
input this variable is set with the current selected input (bolometer or test signal
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::AdjustFEOffset ( unsigned short  lg  ) 

adjust baseline baseline

Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetFEOffsetDAC ( unsigned short  lg,
int  value 
)

write the offset DAC on the Front End.

Parameters:
value,value to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetFEOffsetDAC ( unsigned short  lg,
int &  value 
)

read the offset DAC from the Front End

Parameters:
value,value get
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetFEOffsetMSB ( unsigned short  lg,
int  value 
)

write the offset MSBs on the Front End .

Parameters:
value,DAC value to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetFEOffsetMSB ( unsigned short  lg,
int &  value 
)

read offset MSBs from the Front End

Parameters:
value,value get
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetFEOffsetPolarity ( unsigned short  lg,
bool &  pol 
)

get Front End offset polarity

Parameters:
pol this variable is set to the get bias polarity
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetFEOffsetPolarity ( unsigned short  lg,
bool  pol 
)

set Front End offset polarity

Parameters:
pol,this variable is the bias polarity to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::InvertFEOffsetPolarity ( unsigned short  lg  ) 

invert Front End offset polarity

Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetFEOffsetSpecialBit ( unsigned short  lg,
bool &  status 
)

get Front End offset special bit

Parameters:
pol this variable is set to the get special bit
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetFEOffsetSpecialBit ( unsigned short  lg,
bool  status 
)

set Front End offset special bit

Parameters:
pol,this variable is the special bit to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::InvertFEOffsetSpecialBit ( unsigned short  lg  ) 

invert Front End offset special bit

Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetBSCutFreq ( unsigned short  lg,
int  cutFreq 
)

set the cut frequency on the Bessel.

Parameters:
value,cut frequency value to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetBSCutFreq ( unsigned short  lg,
int &  cutFreq 
)

get the frequency from the Bessel.

Parameters:
value,cut frequency value get from the Bessel
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetBSFilterEnable ( unsigned short  lg,
bool  status 
)

set Filter enable Status

Parameters:
pol,this variable is the enable status to be loaded
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetBSFilterEnable ( unsigned short  lg,
bool &  status 
)

get Filter enable Status

Parameters:
pol,filter enable status get from the Bessel
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::TurnBSFilterON ( unsigned short  lg  ) 

enable Filter

Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::TurnBSFilterOFF ( unsigned short  lg  ) 

Disable Filter.

Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetPSupplyInterface ( QSlowTypes::QSlowEleInterface_t  iface  ) 

Load the Power Supply controller using the specified communication interface.

Parameters:
iface used communication interface
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetPSupplyInterface ( QSlowTypes::QSlowEleInterface_t &  iface  ) 

Get power supply interface.

Parameters:
iface current communication interface
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetPSupplyVset ( unsigned short  channel,
double  vset 
)

set power supply voltage

Parameters:
vset,returned output voltage
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetPSupplyIset ( unsigned short  channel,
double  iset 
)

set power supply current

Parameters:
iset,returned set current
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetPSupplyVsetDiff ( double  vset  ) 

set power supply differential voltage vset

Parameters:
vset voltage in V that is set both as V+ and V-.
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().
Channel 1 is used for V+, channel 3 for V-.

bool QSlowControlClient::GetPSupplyVsetDiff ( double &  vset  ) 

get power supply differential voltage vset

Parameters:
vset voltage in V. It is the average of V+ and V-.
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().
Channel 1 is used for V+, channel 3 for V-.

bool QSlowControlClient::GetPSupplyVoutDiff ( double &  vout  ) 

get power supply differential voltage vset

Parameters:
vout differential voltage in V. It is the average of Vout+ and Vout-.
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().
Channel 1 is used for V+, channel 3 for V-.

bool QSlowControlClient::GetPSupplyVset ( unsigned short  channel,
double &  vset 
)

get power supply voltage set

Parameters:
vset,voltage to set
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetPSupplyIset ( unsigned short  channel,
double &  iset 
)

get power supply current set

Parameters:
vset,voltage to set
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetPSupplyVout ( unsigned short  channel,
double &  vout 
)

get power supply output voltage

Parameters:
vout,returned output voltage in V
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetPSupplyIout ( unsigned short  channel,
double &  iout 
)

get power supply output current

Parameters:
vout,returned output current in A
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::SetPSupplyOutputEnable ( unsigned short  channel,
bool  status 
)

set power supply output enable

Parameters:
status,enable status to set
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::GetPSupplyOutputEnable ( unsigned short  channel,
bool &  status 
)

get power supply output enable

Parameters:
status,returned output enable
Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::TurnPSupplyOutputON ( unsigned short  channel  ) 

enable power supply output

Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().

bool QSlowControlClient::TurnPSupplyOutputOFF ( unsigned short  channel  ) 

disable power supply output

Returns:
true on success, false on failure. In case of failure, QError is set to something different from QERR_SUCCESS and can be retrieved by mean of GetError().


The documentation for this class was generated from the following files:
Generated on Fri Mar 6 13:40:44 2009 for CUORE Software by  doxygen 1.5.1