IoInputModule.h

Go to the documentation of this file.

// $Id: IoInputModule.h,v 1.38 2009/01/05 05:55:13 schubert Exp $
//
// messier@huhepl.harvard.edu
#ifndef IOINPUTMODULE_H
#define IOINPUTMODULE_H
#include "TStopwatch.h"

#ifndef MAP
#include <map>
#define MAP
#endif
#ifndef STRING
#include <string>
#define STRING
#endif
#ifndef LIST
#include <list>
#define LIST
#endif
using namespace std;

#include "JobControl/JobCInputModule.h"
#include "Dispatcher/DDS.h"

#ifndef IOFILELISTITEM_H
#include "IoModules/IoFileListItem.h"
#endif
#ifndef PER_H
#include "Persistency/Per.h"
#endif
#ifdef SITE_HAS_SAM
#include "sam_cpp_api/SamProject.hpp"
#endif

class IoDataStreamItr;
class Registry;
class VldContext;
class MomNavigator;

class IoInputModule : public JobCInputModule {

public:
  IoInputModule();
  ~IoInputModule();
  
  // JobCModule interface
  void BeginJob();
  void EndJob();
  const Registry& DefaultConfig() const;
  void            Config(const Registry& r);
  
  // JobCInputModule interface
  JobCResult Get();

  JobCResult Next(int n=1);
  JobCResult Prev(int n=1);
  JobCResult GoTo(int run, int snarl, int searchDir=0);
  JobCResult GoTo(const VldContext& vld);

  void List(const char* streamlist = "*") const;
  void AddFile(const char *filename, const char* streamlist = "*",int at = -1);
  void RemoveFile(const char* filename, const char* streamlist = "*");

  JobCResult NextFile(int n=1, const char* streamlist = "*");
  JobCResult PrevFile(int n=1, const char* streamlist = "*");
  JobCResult GoToFile(int i, const char* streamlist = "*");
  JobCResult GoToFile(const char* filename, const char* streamlist = "*");
  
  void DefineStream(const char* stream, const char* tree);
  void Select(const char* stream, const char* select, bool isRequired = false);
  void SetSequenceMode(const char* stream, 
                       Per::ESequenceMode sequenceMode = Per::kKey);
  void SetPerOwnedDisabled(const char* stream,
                           bool perowneddisabled = true);
  void SetTestMode(const char* stream, 
                   bool testMode);
  void SetWindow(const char* stream, double lower, double upper);

  void SetMaxFileRepeat(const char* stream,int numRepeat); // for Per::kSequential & Per::kRandom
  void SetMeanMom(const char* stream, double mean);    // for Per::kSequential & Per::kRandom
  void SetPushRandom(const char* stream, bool setRandom); // for Per::kSequential & Per::kRandom
  void SetRandomSeed(int rSeed); // for Per::kSequential & Per::kRandom

  // Query methods
  Int_t GetCurrentRun()   const { return fCurrentRun; };
  Int_t GetLastRun()   const { return fLastRun; };
  const char* GetCurrentFile(const char* streamname = "*") const;
  const char* GetLastFile(const char* streamname = "*") const;
  Int_t GetCurrentSnarl() const { return fCurrentSnarl; }; 
  
private:

  void LoadFilesFromCommandLine();
  int  ReadHeader();
  void UpdateDDSConfig();
  void UpdateFormatConfig();
  void UpdateFileList();
  void UpdateStreamConfig();
  int  OpenStreamItr();
  void CloseStreamItr();

  // Quell "hiding method" compiler warnings
  JobCResult Get(MomNavigator*) { return JobCResult::kAOK; }

private:
  std::map<std::string,std::string> fStreamSelectionMap; // map of stream/cut
  std::map<std::string,bool> fStreamRequiredMap; // map of stream/isrequired
  std::map<std::string,std::string> fStreamDefMap; // map of stream/definition
  std::map<std::string,Per::ESequenceMode> fStreamSeqModeMap;
  std::map<std::string,bool> fStreamPerOwnedDisabledMap;
  std::map<std::string,bool> fStreamTestModeMap; 
  std::map<std::string,std::pair<double,double> > fStreamWindowMap; 
                                                // map of stream/sequence mode
  std::list<IoFileListItem>         fFileList;    // Files to get events from
  IoDataStreamItr*                  fDataStreamItr; // Current stream itr

  std::string fFormat;     // Format of data stream
  std::string fStreamList; // Comma sep list of streams to open

  std::map<std::string,int> fStreamMaxRepeatMap; // map of stream/max file repeat
  std::map<std::string,double> fStreamMeanMap; // map of stream/mean
  std::map<std::string,bool> fStreamPushRandomMap; // map of stream/push (rand/const)
  int fRandomSeed; // for kSequential & kRandom seq modes
 
  // DDS options
  std::string fServer;       // DDS server hostname
  int         fPort;         // DDS port number
  int         fTimeOut;      // DDS time out limit (seconds)
  int         fDataSource;   // DDS data source
  int         fKeepUpMode;   // DDS keep up mode
  int         fMaxSyncDelay; // DDS max sync delay (seconds)
  bool        fOffLine;      // DDS offline symbolic link bool
  int         fMaxRetry;     // DDS retry count for failed connections
  int         fRetryDelay;   // DDS wait n seconds between retries
  DDS::EClientType fClientType;   // DDS client type
  string      fClientName;   // DDS client name

  // Information about the current state
  JobCResult    fStatus;       // Status of input stream
  int           fLastRun;      // Last recorded run number
  int           fLastSnarl;    // Last recorded snarl number
  int           fCurrentRun;   // Current run number
  int           fCurrentSnarl; // Current snarl number
  std::map<std::string,std::string> fCurrentFileMap;//used to track file change
  std::map<std::string,std::string> fLastFileMap;//used to track file change
  std::string                       fLastBeginFile;
  std::string                       fLastEndFile;
  bool          fLoadedCommandLineFiles; // Have we read the command line?
  TStopwatch    fStopwatch;    // used for i/o timing stats

#ifdef SITE_HAS_SAM

  // SAM options

  std::string fStation;         // SAM Station to use e.g. minos-sam
  int  fSnapShotVers;           // Dataset snapshot to use
  std::string fWorkGroupName;   // Work group e.g. minos
  std::string fApplicationName; // Application name, e.g. loon
  std::string fApplicationVers; // Application version
  std::string fProjectName;     // Project name - timestamp will be appended
  int  fMaxNumberOfFiles;       // Maximum number of files to process 
  int  fStartNewProject;             // Is this a new project
  sam::SamProject* fsamProject;
#endif

};

#endif // IOINPUTMODULE_H

---