JobCEnv.h

Go to the documentation of this file.

// $Id: JobCEnv.h,v 1.17 2005/06/06 15:52:19 bv Exp $
//
// A class which encapsulates information about the conditions (the
// "environment") in which the job is running.
//
// messier@huhepl.harvard.edu
#ifndef JOBCENV_H
#define JOBCENV_H
#ifndef VECTOR
#include <vector>
#define VECTOR
#endif
#ifndef STRING
#include <string>
#define STRING
#endif
#ifndef CTIME
#include <ctime>
#define CTIME
#endif

class MomNavigator;
class JobController;
class JobCRootEnv;

class JobCEnv
{
public:
  ~JobCEnv();
  
  // Command line arguments
  int           GetArgc()                    const;
  char* const*  GetArgv()                    const;
  const char*   GetArgv(int i)               const;
  const char*   GetModuleHelpList()          const;
  const char*   GetMacroFile(unsigned int i) const;
  const char*   GetFileName(int i)           const;
  int           GetNfile()                   const;
  const char*   GetDefaultOutputFileName()   const;
  bool          HaveInaccessibleFile() const;

  // Run limits
  bool ContinueRun(int n)      const;
  bool CheckTimeLimit(int* t)  const;
  bool CheckRecordLimit(int n) const;
  
  // Run mode
  bool IsBatch() const;
  
  // Set run mode parameters
  int RunRootApp();

  static JobCEnv& Instance();
  static JobCEnv& Instance(int argc, char** argv);

  // Helper class to handle deletion of singleton
  struct Cleaner {
    void ClassIsUsed() { }; // Dummy method to keep compilers quiet
    ~Cleaner() {
      if (JobCEnv::fInstance) {
        delete JobCEnv::fInstance;
        JobCEnv::fInstance = 0;
      }
    }
  };
  friend struct Cleaner;

private:
  JobCEnv();
  JobCEnv(int argc, char** argv);

  void AddDataFile(const char *filename);
  void AddMacroFile(const char *filelist);
  void CreateInteractiveMom();
  void DeleteInteractiveMom();
  void ProcessCommandLine(int argc, char *const *argv);
  void SetTimeLimit(const char* timelimit);
  void SetSignalHandlers();
  
  // Information from command line
  int                      fArgc;          // Command line argument
  char* const*             fArgv;          // Command line arguments
  const char*              fModuleHelpList;// List of modules from -H option
  std::vector<std::string> fDataFileList;  // Files from command line
  std::vector<std::string> fMacroFileList; // Macros listed on the cmd line
  std::string              fDfltOutFile;   // Default name for output files

  // Information about run limits
  time_t                   fTimeStart;     // Time job started
  double                   fTimeLimit;     // Time limit of job
  int                      fRecordLimit;   // Limit on number of records

  // Information concerning run mode
  bool                     fIsBatch;       // Is this a batch job?

  // Data needed for ROOT use
  JobCRootEnv*             fRootEnv;       // ROOT data

  // The sole instance of the class
  static JobCEnv* fInstance;
};

#endif // JOBCENV_H

---