JobCInputModule.h

Go to the documentation of this file.

// $Id: JobCInputModule.h,v 1.15 2009/01/05 06:10:20 schubert Exp $
//
// Define the interface for an input module
//
// messier@huhepl.harvard.edu
#ifndef JOBCINPUTMODULE_H
#define JOBCINPUTMODULE_H
#ifndef JOBCMODULE_H
#include "JobControl/JobCModule.h"
#endif
#ifndef PER_H
#include "Persistency/Per.h"
#endif

class MomNavigator;
class VldContext;

class JobCInputModule : public JobCModule
{
public:
  JobCInputModule();
  virtual ~JobCInputModule();

  // Read in event at current position in input stream
  virtual JobCResult Get();
  
  // Methods to set the position in the record stream
  virtual JobCResult Next(int n=1);
  virtual JobCResult Prev(int n=1);
  virtual JobCResult GoTo(int runNumber, int snarlNumber, int searchDir=0);
  virtual JobCResult GoTo(const VldContext& vld);

  // Methods to manage the list of attached files
  virtual void List(const char* streamlist = "*") const;
  virtual void AddFile(const char* filename, const char* streamlist = "*",
                                             int at = -1);
  virtual void RemoveFile(const char* filename, const char* streamlist = "*");
  virtual void Select(const char* stream, const char* cut, bool isrequired = false);
  virtual void SetSequenceMode(const char* stream, 
                               Per::ESequenceMode seqmode = Per::kKey);
  virtual void SetTestMode(const char* stream,bool testmode);
  virtual void SetPerOwnedDisabled(const char* stream,
                                   bool perowneddisabled = true);
  virtual void SetWindow(const char* stream, double lower, double upper);
  virtual void DefineStream(const char* stream, const char* tree);

  virtual void SetMaxFileRepeat(const char* stream, int numRepeat = 0);
  virtual void SetMeanMom(const char* stream, double mean = 0.);
  virtual void SetPushRandom(const char* stream, bool setRandom = true);
  virtual void SetRandomSeed(int rSeed = 0);
  
  // Methods to set the position in the file list
  virtual JobCResult NextFile(int n=1, const char* streamlist = "*");
  virtual JobCResult PrevFile(int n=1, const char* streamlist = "*");
  virtual JobCResult GoToFile(int i, const char* streamlist = "*");
  virtual JobCResult GoToFile(const char* filename,const char* streamlist="*");
  
  // Methods which are not normally needed for interactive use
  void          SetMom(MomNavigator* mom);
  MomNavigator* GetMom() const;

  // Query methods
  virtual Int_t GetCurrentRun() const;
  virtual Int_t GetLastRun() const;
  virtual const char* GetCurrentFile(const char* streamname = "*") const;
  virtual const char* GetLastFile(const char* streamname = "*") const;
  virtual Int_t GetCurrentSnarl() const;

private:
  // this base class method is hidden by public arg-less version
  virtual JobCResult Get(MomNavigator* mom);

  MomNavigator* fMom; // *Not* owned
};

#endif

---