histo_updater.h

Go to the documentation of this file.

//Copyright (C) 2011 Lutz Foucar

/**
 * @file histo_updater.h file contains the classes that update histograms
 *
 * @author Lutz Foucar
 */

#ifndef _HISTOUPDATER_H_
#define _HISTOUPDATER_H_

#include <memory>
#include <string>

#include <TTimer.h>

class HistogramUpdater
{
public:
  /** constructor
   *
   * connects the timers Timeout() signal with the updateHistogram() method
   * of this class
   *
   * @param server the server ip or name
   * @param port the server port
   */
  HistogramUpdater(const std::string &server, int port);

  /** update the shown histograms
   *
   * create the server address from the _server and _port members. With this
   * create a tcpclient object and use it to retrieve the list of available
   * histograms. Use checkList() to filter out the ones that need to be updated.
   * Now go through the list of to update histograms and call updateHist() for
   * each one of them. After that update all Pads in the Canvases using
   * updateCanvases().
   */
  void syncHistograms();

  /** copy a single result into a histogram
   *
   * @param name The name of the result to retrieve
   */
  void syncHistogram(const std::string &name);

  /** set the server
   *
   * @param server the server ip or name
   */
  void setServer(const std::string & server) {_server = server;}

  /** set server port
   *
   * @param port port that the server listens to
   */
  void setPort(int port) {_port = port;}

  /** automaticly update
   *
   * start autoupdate with requested frequency. If frequency is 0 stop
   * autoupdate.
   *
   * @param freq The frequency with which the histogram should be updated in Hz
   */
  void autoSync(double freq);

  /** set the updateCanvas flag
   *
   * @param update the flag status
   */
  void alsoUpdateCanvas(bool update) {_updateCanv = update;}

  /** write all histograms to a root file
   *
   * first update all available histograms, then go through the list of root
   * histograms and write them to file
   *
   * @param name the name of the root file
   */
  void writeRootFile(const std::string& name);

  /** tell the server reload the .ini parameters */
  void reloadIni();

  /** control the dark calibration */
  void controlCalibration(const std::string& command="startDarkcal");

private:
  /** the server */
  std::string _server;

  /** the server port */
  int _port;

  /** the timer for auto update */
  std::auto_ptr<TTimer> _timer;

  /** flag whether after updating the histogram the canvas should also update */
  bool _updateCanv;
};

/** global acces variable for updater */
R__EXTERN HistogramUpdater *gCASSClient;

#endif