JSFModule

class JSFModule : public TNamed

    protected:

      void ConfDirectory()

    public:

                           JSFModule(const Char_t* name = "JSFModule", const Char_t* title = "JSF Default Module", Option_t* opt)
                           JSFModule(const JSFModule&)
                   virtual ~JSFModule()
            virtual Bool_t BeginRun(Int_t nrun)
            static TClass* Class()
            virtual Bool_t EndRun()
      virtual JSFEventBuf* EventBuf()
                  TBranch* GetBranch()
                    TFile* GetFile()
            virtual Bool_t GetLastRunInfo()
                    Bool_t GetMakeBranch()
                    TTree* GetTree()
            virtual Bool_t Initialize()
           virtual TClass* IsA() const
                    Bool_t IsWritable()
              virtual void MakeBranch(TTree* tree)
              virtual void PrintInfo()
            virtual Bool_t Process(Int_t event)
            virtual Bool_t ReadCommandArgument(int* argc, char** argv)
              virtual void SetBranch(TTree* tree)
                      void SetBufferSize(Int_t size)
                      void SetFile(TFile* file)
                      void SetMakeBranch(Bool_t flag)
                      void SetModuleStatus(EJSFModuleStatus stat)
                      void SetRunNumber(Int_t nrun)
                      void SetSplit(Int_t split)
              virtual void ShowMembers(TMemberInspector& insp, char* parent)
              virtual void Streamer(TBuffer& b)
                      void StreamerNVirtual(TBuffer& b)
            virtual Bool_t Terminate()

Data Members

    protected:

                 Int_t fVersion     Version number of the module
                TList* fHistograms  ! Pointer to the histograms ( =0 no histo)
                TFile* fFile        ! Where the data of this module is read/write
                TTree* fTree        ! pointer to event tree. 
              TBranch* fBranch      ! Branch for this module.
                 Int_t fRunNumber   run number
                 Int_t fSplit       Split value for the branch
                 Int_t fBufferSize  Buffer size of the branch
                Bool_t fMakeBranch  kTRUE to create branch for this module.
          JSFEventBuf* fEventBuf    ! Pointer to event data, saved in the Event tree
      EJSFModuleStatus fStat        ! Module status

See also

JSFGenerator, JSFLCFULL, JSFMEGenerator, JSFMergeEvent, JSFQuickSim, JSFSIMDST, JSFSpring

Class Description

  JSFModule

  Basic unit of data analysis

  User Analysis class should be derived from this class.
  Basic member functions for data analysis are,
      Initialize()
        BeginRun(Int_t RunNumber)
          Process(Int_t EventNumber)
        EndRun()
      Terminate()
  User class should override these functions.

  fFile is a pointer data member to the file.  It is set by JSFSteer
  and can be READ/WRITE/UPDATE. (UPDATE may not work properly yet.)
  Event data is stored in the tree, Event, in the "fFile".  Other
  configuration data are stored as an Keyed file in the "fFile".
  Directory and key names are,
       Initialize()  --> /conf/init/[modulename]
       BeginRun(nnn) --> /conf/beginNNNNNN/[modulename]
       EndRun(nnn)   --> /conf/endNNNNN/[modulename]
       Terminate()   --> /conf/term/[modulename]
  Note that key names have been changed since JSF-1-11, to
  simplfy the directory structure.
  The member function, ConfDirectory(), creates and cd to proper
  directory.  How to write/read data is depend on the implementaion
  of the class.
  Process is called only when the "fFile" is writable, while other
  functions are called evenif fFile is not writable.  If Initialize,
  BeginRun, EndRun, or Terminate is called when fFile is not writable,
  they should prepare data member of the class properly.

  Event data is saved in the object pointed by fEventBuf, which is
  the JSFEventBuf object.  JSFModule does not create JSFEventBuf.
  User class dereived from JSFModule should define fEventBuf.

  The member function, MakeBranch() and SetBranch() is called from
  JSFSteer::Initialize(). MakeBranch() defines the tree branch to
  store event data, while SetBranch() set addresses to read tree data.
  Usually, user read event data by tree->Fill(), which readin all branches
  in the tree. If the branch address is not set properly, the program will
  crash.  When reading the root data, JSFSteer  read the header and creats
  the objetcs required to get tree data.

$Id: JSFModule.cxx,v 1.7 2001/11/06 05:17:15 miyamoto Exp $

 Default constructor of JSF module.
 If opt != "", the module is not included in the module list of JSFSteer.

  Destrutor of JSF module.

   Called at each events.  This function is not called when
   the default file assigned to the class (fFile) is not writable.

 cd to conf directory to access configuration information
 or where event tree is.

 The BeginRun function is called when new run is started.
 Each module
 should output run dependant parameter here by object->Write() statement.

  End of run.

  End of run.

  Make branch of the module

  Set Branch address for this module

Inline Functions

                void SetModuleStatus(EJSFModuleStatus stat)
                void SetRunNumber(Int_t nrun)
              Bool_t ReadCommandArgument(int* argc, char** argv)
                void SetSplit(Int_t split)
                void SetBufferSize(Int_t size)
            TBranch* GetBranch()
                void SetMakeBranch(Bool_t flag)
              Bool_t GetMakeBranch()
              TFile* GetFile()
              TTree* GetTree()
                void SetFile(TFile* file)
        JSFEventBuf* EventBuf()
              Bool_t IsWritable()
             TClass* Class()
             TClass* IsA() const
                void ShowMembers(TMemberInspector& insp, char* parent)
                void Streamer(TBuffer& b)
                void StreamerNVirtual(TBuffer& b)
           JSFModule JSFModule(const JSFModule&)