JobCInput.h

Go to the documentation of this file.

// $Id: JobCInput.h,v 1.22 2009/01/05 06:10:20 schubert Exp $
//
// A module used for getting data into and emtpy data record. This
// module is implemented in terms of any of a variety of
// user/framework provided inputs modules
//
// messier@huhepl.harvard.edu
#ifndef JOBCINPUT_H
#define JOBCINPUT_H
#ifndef JOBCINPUTMODULE_H
#include "JobControl/JobCInputModule.h"
#endif
#ifndef PER_H
#include "Persistency/Per.h"
#endif
#ifdef SITE_HAS_SIGC
# ifndef __CINT__
# include "sigc++/signal.h"
# endif
#else
  // In order to get alignment right when a script using JobC.h 
  // is compiled using ACLiC, we must account for the space used by
  // the signals below or the offsets for the JobC's member variables
  // "Msg" and "Path" are incorrect.

  // ACLiC knows nothing about SITE_HAS_SIGC, nor does it have
  // sigc++ in it's include path.

  // This hack assumes the space requirements of sigc++1.2 where
  // Signal0 derives from SignalBase which holds only a single
  // pointer (4bytes) and neither has a vtbl.

  namespace SigC {
    class SignalNode;

    class SignalBasePlaceHolder {
    public:
      SignalBasePlaceHolder() : impl_(0) { ; }
    protected: 
      mutable SignalNode *impl_;
    };  // SignalBasePlaceHolder
    class Signal0PlaceHolder : public SignalBasePlaceHolder {
    public:
      Signal0PlaceHolder() { ; }
    };  // Signal0PlaceHolder
  }
#endif
#ifndef ROOT_Rtypes
#if !defined(__CINT__) || defined(__MAKECINT__)
#include "Rtypes.h" // Needed for ClassDef and ClassImp macros
#endif
#endif

#include <cassert>

class JobCResult;
class MomNavigator;

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

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

  // Methods to manage the list of attached files
  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 = "*");
  void DefineStream(const char* stream, const char* tree);
  void Select(const char* stream, const char* cut, bool isrequired = false);
  void SetSequenceMode(const char* stream, 
                       Per::ESequenceMode seqmode=Per::kKey);
  void SetTestMode(const char* stream, bool testmode);
  void SetPerOwnedDisabled(const char* stream, bool perowneddisabled = true);
  void SetWindow(const char* stream, double lower, double upper);

  void SetMaxFileRepeat(const char* stream, int numRepeat);
  void SetMeanMom(const char* stream, double mean);
  void SetPushRandom(const char* stream, bool setRandom);
  void SetRandomSeed(int rSeed);

  // Methods to set the position in the file list
  JobCResult NextFile(int n=1, const char* streamlist = "*");
  JobCResult PrevFile(int n=1, const char* streamlist = "*");
  JobCResult GoToFile(int i=0, const char* streamlist = "*");
  JobCResult GoToFile(const char* filename, const char* streamlist = "*");
  
  // Which job module should we use to implement this class?
  void Use(const char* name);

  // Complete the JobModule interface
  void BeginJob();
  void EndJob();
  void BeginFile();
  void EndFile();
  void BeginRun();
  void EndRun();

  // Module configuration
  const Registry& DefaultConfig() const;
  void            Config(const Registry& r);
  Registry&       GetConfig();
  
  // Input/output
  // JobCResult Get(MomNavigator *mom);
  // JobCResult Put(const MomNavigator *mom);

  // Interactive mode methods
  void Cmd(const char* command);
  void HandleCommand(JobCommand *command);
  void Help();
  void Report();
  void Reset();

#ifdef SITE_HAS_SIGC
# ifndef __CINT__
  // Send a signal when methods which change current record set are called
  SigC::Signal0<void> SigGet;
  SigC::Signal0<void> SigNext;
  SigC::Signal0<void> SigPrev;  
  SigC::Signal0<void> SigGoTo;
#endif
private:
  // SigC::Signal0 derives from SignalBase which has a private operator=
  // CINT attempts to generate explicit assignment unless told not to do so
  JobCInput& operator= (const JobCInput&); // no assignment
#else
  // Inelegant hack to make a script using JobC work when compiled
  // with ACLiC.  The declaration of these stand-ins make the alignment
  // the same whether compiled externally or via ACLiC (which doesn't
  // have SITE_HAS_SIGC defined, nor (even if it did) know where to
  // find the sigc++ includes.
  
  // Names must match usage above or one gets problems with ROOT's 
  // automated generation of ShowMembers();

  SigC::Signal0PlaceHolder SigGet;
  SigC::Signal0PlaceHolder SigNext;
  SigC::Signal0PlaceHolder SigPrev;
  SigC::Signal0PlaceHolder SigGoTo;
# endif
  
private:
  int CheckImpl() const;

private:
  JobCInputModule* fImpl; // The implementation of the input module

  // Get() hides this from base class JobCModule & JobCInputModule
  virtual JobCResult Get(MomNavigator*) { assert(0); return JobCResult::kFatal; }

  ClassDef(JobCInput,0) // JobControl's interface to input module(s)
};

#endif

---