JobCModule.h

Go to the documentation of this file.

// $Id: JobCModule.h,v 1.21 2005/06/03 22:53:41 rhatcher Exp $
//
// This defines the interface analysis modules. A module has several
// possible entry points which can get called at various points during
// a job. Several of these entry points can act as filters to control
// what files, runs, and events get processed
//
// A module should provide an implementation for at least one of the
// following methods. Default "dummy" methods are provided for any
// methods not required by your module. The possible user entry
// points for a job modules are listed by category.
//
// Analysis/Reconstruction:
//  Ana            - read-only analysis of data records
//  Reco           - read-write access to data records
//
// Status changes:
//  BeginJob  - Notice of begin job
//  EndJob    - Notice of end job
//  BeginFile - Notice of begin of file
//  EndFile   - Notice of end of file
//  BeginRun  - Notice of begin of run
//  EndRun    - Notice of end of run
//
// Interactive entry points:
//  HandleCommand - parse module commands
//  Help          - print help for the module
//  Report        - print module status and information
//  Reset         - return the module to its initial state
//
// I/O Methods (in general provided by framework):
//  Get - get a header/event
//  Put - write a header/event
//
// messier@huhepl.harvard.edu
#ifndef JOBCMODULE_H
#define JOBCMODULE_H
#ifndef STRING
#include <string>
#define STRING
#endif
#ifndef REGISTRY_H
#include "Registry/Registry.h"
#define REGISTRY_H
#endif
#ifndef JOBCRESULT_H
#include "JobControl/JobCResult.h"
#endif
#ifndef JOBCDIALOG_H
#include "JobControl/JobCDialog.h"
#endif

class MomNavigator;
class JobCEnv;
class JobCommand;
class JobCPath;
class JobCInputModule;

//......................................................................

class JobCModule
{
public:
    JobCModule();
    virtual ~JobCModule();
  
  
    const char* GetName() const;
  
    virtual JobCResult Ana(const MomNavigator *mom);

    virtual JobCResult Reco(MomNavigator *mom);
  
    virtual void BeginJob();
    virtual void EndJob();
    virtual void BeginFile();
    virtual void EndFile();
    virtual void BeginRun();
    virtual void EndRun();

    Int_t GetCurrentRun() const;
    Int_t GetLastRun() const;

    const char* GetCurrentFile(const char* streamname="*") const;
    const char* GetLastFile(const char* streamname="*") const;

    virtual const Registry& DefaultConfig() const;

    virtual void            Config(const Registry& r);
  
    virtual JobCResult Get(MomNavigator *mom);

    virtual JobCResult Put(const MomNavigator *mom);

    virtual void Cmd(const char* command);
    virtual void HandleCommand(JobCommand *command);
    virtual void Help();
    virtual void Report();
    virtual void Reset();

    // Not normally needed
    void              Init(const char* name);
    void              Set(const char* paramlist);
    void              Set(JobCDialog* d=0);
    virtual Registry& GetConfig();

    bool SetUniqueName(const char* name);
    const char* GetUniqueName() const;

    JobCPath* GetPath() { return fPath; }
    void SetPath(JobCPath* path) { fPath = path; }

private:

    JobCInputModule* GetJobCInputModule() const;

    std::string fName;   // The name of this module
    Registry    fConfig; // The configuration parameters for the module
    JobCPath*   fPath;   // The associated job path, if any.
};

#endif // JOBCMODULE_H

---