runinfo.hh

Go to the documentation of this file.

#ifndef RUNINFO_h
#define RUNINFO_h

//hide this from ROOT
#include "Rtypes.h"
#ifndef __CINT__
#include "ParameterList.hh"
#endif 


#include <vector>
#include <map>
#include <string>
#include <set>
#include <sstream>
#include <time.h>

class TMacro;

#ifndef __CINT__
class runinfo : public ParameterList{
#else
class runinfo{
#endif
public:
  runinfo(long id=-1);
  virtual ~runinfo() {}
  void Init(bool reset=false);
  void InitializeParameterList(); 

  void ResetRunStats();
  
  int LoadSavedInfo(TMacro* mac);
  
  //metadata to save for all runs, determined automatically from daq settings
  
  /* note: By default runs have a prefix (per experiment, default 'rawdaq') 
     and suffix (the date expressed as yymmddHHMM). 
     The suffix is equivalent to the runid in this case. 
     
     Alternatively, if the filename is given as *Run######", then the 6 digit
     suffix will be interpreted as the run id. In this case it is up to the 
     user to ensure unique IDs
  */

  long runid;                  
  time_t starttime;            
  time_t endtime;              
  long triggers;               
  long events;                 
  

public:
  typedef std::set<std::string> stringset;
  typedef std::vector<std::string> stringvec;
  typedef std::map<std::string, std::string> stringmap;
  
#ifndef __CINT__
  class DialogField : public ParameterList{
  public:
    DialogField(const std::string& field_="", const std::string& desc = "",
                bool required_=true, const std::string& default_="");
    virtual ~DialogField() {}
    bool IsValueValid(const std::string& val) const;
    std::string fieldname;
    std::string description;
    std::vector<std::string> allowed_values;
    bool required;
    std::string defaultvalue;
  };
  
  typedef std::vector<DialogField> FieldList;
#endif

private:
  //these fields allow the user to define additional metadata via config files
  stringmap metadata; 
  
#ifndef __CINT__
  //All the dialog fields refer to entries in the main metadata map
  FieldList prerun_dialog_fields;
  FieldList postrun_dialog_fields;
#endif

  bool force_prerun_dialog;
  bool force_postrun_dialog;
    
  std::map<int, stringmap > channel_metadata;
  //(may add a required_channel_metadata in the future)
  
public:
  //all of the following return 0 for success, 1 for user cancelled, <0 on error
  enum FILLTIME {RUNSTART, RUNEND};
  int FillDataForRun(FILLTIME when=RUNSTART);

  std::string GetMetadata(const std::string& key)
  { stringmap::iterator it = metadata.find(key);
    return it == metadata.end() ? std::string("") : it->second ; }
  void SetMetadata(const std::string& key, const std::string& val)
  { metadata[key] = val; }

  template<class T> void SetMetadata(const std::string& key, const T& val){
    std::stringstream s;
    s<<val;
    metadata[key] = s.str();
  }

  
private:
  ClassDef(runinfo,1);
}; 


#endif