TModule


class description - source file - inheritance tree

class TModule : public TDataSet


    public:
TModule TModule(const char* name, const char* dummy = 0) TModule TModule(TModule&) virtual void ~TModule() virtual void AddAlias(const char* log, const char* act, const char* dir = .aliases) virtual void AddConst(TDataSet* data = 0) virtual TDataSet* AddData(TDataSet* data = 0, const char* dir = .data) virtual void AddGarb(TDataSet* data = 0) virtual void AddHist(TH1* h, const char* dir = 0) virtual void AddModule(TModule* mk) virtual TObjectSet* AddObj(TObject* obj, const char* dir) virtual void AddRunco(TDataSet* data = 0) virtual void AddRunco(double par, const char* name, const char* comment) void AddRunCont(TDataSet* data = 0) virtual TModule* cd() virtual TModule* Cd() static TClass* Class() virtual void Clear(Option_t* option) static EDataSetPass ClearDS(TDataSet* ds, void* user) virtual Double_t CpuTime() virtual TDataSet* DataSet(const char* logInput) const virtual Int_t Debug() const virtual void EndModule(int ierr) virtual void Fatal(int Ierr, const char* Com) virtual Int_t Finish() virtual Int_t FinishRun(int oldrunumber) virtual TString GetAlias(const char* log, const char* dir = .aliases) const static TModule* GetChain() virtual const char* GetCVS() const virtual TDataSet* GetData(const char* name, const char* dir = .data) const virtual TDataSet* GetDataBase(const char* logInput) virtual TDataSet* GetDataSet(const char* logInput, const TModule* uppMk = 0, const TModule* dowMk = 0) const virtual Int_t GetDate() const virtual TDatime GetDateTime() const virtual Int_t GetDebug() const TObject* GetDirObj(const char* dir) const static TModule* GetFailedModule() virtual TH1* GetHist(const Char_t* histName) const virtual TList* GetHistList() const virtual TString GetInput(const char* log) const virtual TDataSet* GetInputDB(const char* logInput) virtual TDataSet* GetInputDS(const char* logInput) const virtual TList* GetMakeList() const virtual Int_t GetMakeReturn() const virtual TModule* GetModule(const char* mkname) static TModule* GetModule(const TDataSet* ds) virtual Int_t GetNumber() const virtual TString GetOutput(const char* log) const virtual TModule* GetParentChain() const virtual TModule* GetParentModule() const virtual Int_t GetTime() const virtual TList* Histograms() const virtual Int_t Init() virtual Int_t InitRun(int runumber) virtual TClass* IsA() const virtual Bool_t IsActive() virtual Int_t IsChain() const virtual Int_t Make() virtual Int_t Make(int number) virtual void MakeDoc(const TString& stardir = $(STAR), const TString& outdir = $(STAR)/StRoot/html, Bool_t baseClasses = kTRUE) virtual TModule* Module(const char* mkname) static TModule* New(const Char_t* classname, const Char_t* name, void* title = 0) virtual void PrintInfo() const virtual void PrintTimer(Option_t* option) virtual void PrintTotalTime() virtual Double_t RealTime() virtual void SetActive(Bool_t k = kTRUE) virtual void SetAlias(const char* log, const char* act, const char* dir = .aliases) virtual void SetDateTime(int idat, int itim) virtual void SetDebug(Int_t l = 1) virtual void SetDEBUG(Int_t l = 1) void SetDirObj(TObject* obj, const char* dir) virtual void SetInput(const char* log, const char* act) virtual void SetMakeReturn(Int_t ret) virtual void SetMode(Int_t mode = 0) virtual void SetNumber(Int_t number) virtual void SetOutput(const char* log, const char* act) virtual void SetOutput(const char* log, TDataSet* ds) virtual void SetOutput(TDataSet* ds) virtual void SetOutputAll(TDataSet* ds, Int_t level = 1) virtual void ShowMembers(TMemberInspector& insp, char* parent) virtual void StartModule() virtual void StartTimer(Bool_t reset = kFALSE) virtual void StopTimer() virtual void Streamer(TBuffer& b) void StreamerNVirtual(TBuffer& b) virtual TDataSet* UpdateDB(TDataSet* ds) virtual TDataSet* UpdateDB(const char* logInput)

Data Members

    private:
protected:
TDataSet* m_DataSet ! TDataSet* m_ConstSet ! TDataSet* m_GarbSet ! TDataSet* m_Inputs !list of logInput:ActualInput TDataSet* m_Ouputs !list of logOuput:ActualOuput TDataSet* m_Runco !Run Control parameters TList* m_Histograms !list of Histograms static TModule* fgStChain current pointer to StChain static TModule* fgFailedModule current pointer to failed maker static Int_t fgTallyModule[5] counters Int_t m_Mode Integer mode of maker Int_t m_Number Serial event number Int_t m_DebugLevel Debug level Int_t m_MakeReturn Make() return flag TStopwatch m_Timer Timer object Bool_t fActive true if active public:
static const TModule::EDebugLevel kNormal static const TModule::EDebugLevel kDebug static const enum TObject:: kSTAFCV_BAD static const enum TObject:: kSTAFCV_OK static const enum TObject:: kSTAFCV_ERR static const enum TObject:: kSTAFCV_FATAL enum TObject:: EModule_return_Status static const enum TObject:: kOK static const enum TObject:: kWarn static const enum TObject:: kEOF static const enum TObject:: kErr static const enum TObject:: kFatal enum TObject:: TModule_return_Status

Class Description

                                                                      
 TModule is a  base class to define the member of the chain           
 to perform some complex action                                       
                                                                      
 ("Root" service within Athena framework, for example)                
                                                                      


TModule(const char *name,const char *):TDataSet(name,".maker"),fActive(kTRUE)
 Steering TDataSet to control the program flow control
 and pass data between program modules the standard way

void AddModule(TModule *mk)

~TModule()

void SetNumber(Int_t number)

Int_t GetNumber() const

TModule* GetParentModule() const

TModule* GetModule(const char *mkname)

TObject* GetDirObj(const char *dir) const

void SetDirObj(TObject *obj,const char *dir)

TObjectSet* AddObj(TObject *obj,const char *dir)

void AddHist(TH1 *h,const char *dir)

void AddRunco (double par,const char* name,const char* comment)

TDataSet* AddData(TDataSet *ds, const char* dir)

TDataSet* GetData(const char *name, const char* dir) const

void AddAlias(const char* log, const char* act,const char* dir)

void SetAlias(const char* log, const char* act,const char* dir)

void SetOutput(const char* log,TDataSet *ds)

void SetOutputAll(TDataSet *ds, Int_t level)

TList* GetMakeList() const

TString GetAlias(const char* log,const char* dir) const

TDataSet* GetDataSet(const char* logInput, const TModule *uppMk, const TModule *dowMk) const

TDataSet* GetDataBase(const char* logInput)

TDataSet* UpdateDB(const char* logInput)

void Clear(Option_t *option)

Int_t Init()

void StartModule()

void EndModule(int ierr)

Int_t Finish()
    Terminate a run
   place to make operations on histograms, normalization,etc.

Int_t Make()
   Loop on all makers

void Fatal(int Ierr, const char *com)

TModule* GetModule(const TDataSet *ds)

EDataSetPass ClearDS (TDataSet* ds,void * )
 Reduce the size of the table to the used rows + 1
 and filll the last empty row awith a special pattern
 Check the table for NaN floating cells if any

void PrintInfo() const

TModule* GetParentChain() const

TDatime GetDateTime() const

Int_t GetDate() const
_____________________________________________________________________________

Int_t GetTime() const

void PrintTimer(Option_t *option)
 Print timer information of this maker
 Entries counts how many times the methods:
    Init(), Make() and Finish ()
 were called

void MakeDoc(const TString &stardir,const TString &outdir, Bool_t baseClasses)
 MakeDoc - creates the HTML doc for this class and for the base classes
           (if baseClasses == kTRUE):

         *  St_XDFFile   St_Module      TTable       *
         *  TDataSet   St_DataSetIter St_FileSet     *
         *  TModule      StChain        StEvent        *
         *  St_TLA_Module                               *

 stardir - the "root" directory to lookup the subdirectories as follows.
           = "$(STAR)"             by default
 outdir  - directory to write the generated HTML and Postscript files into
           = "$(STAR)/StRoot/html" by default

            The following subdirectories are used to look it up:
            $(stardir)
            $(stardir) + "StRoot/St_base"
            $(stardir) + "StRoot/StChain"
            $(stardir) + "StRoot/xdf2root"
            $(stardir) + "StRoot/StarClassLibrary"
            $(stardir) + "StRoot/StEvent"
            $(stardir) + ".share/tables"
            $(stardir) + "include",
            $(stardir) + "include/tables",
            $(stardir) + "StRoot/<this class name>",

   where $(stardir) is the input parameter (by default = "$STAR")

 baseClasses - flag to mark whether the base classes HTML docs will be created as well
               = kTRUE by default

void Streamer(TBuffer &)

TModule* New(const Char_t *classname, const Char_t *name, void *title)
 This static method creates a new TModule object if provided

void SetDEBUG(Int_t l)

Int_t InitRun(int runumber)
_____________________________________________________________________________

Int_t FinishRun(int runumber)



Inline Functions


              Int_t IsChain() const
              Int_t Make(int number)
               void AddConst(TDataSet* data = 0)
               void AddGarb(TDataSet* data = 0)
               void AddRunco(double par, const char* name, const char* comment)
               void AddRunCont(TDataSet* data = 0)
             TList* GetHistList() const
               TH1* GetHist(const Char_t* histName) const
           TModule* cd()
           TModule* Cd()
           TModule* GetChain()
           TModule* GetFailedModule()
               void SetDateTime(int idat, int itim)
          TDataSet* DataSet(const char* logInput) const
          TDataSet* GetInputDS(const char* logInput) const
          TDataSet* GetInputDB(const char* logInput)
          TDataSet* UpdateDB(const char* logInput)
              Int_t GetDebug() const
              Int_t Debug() const
              Int_t GetMakeReturn() const
             TList* Histograms() const
            TString GetInput(const char* log) const
            TString GetOutput(const char* log) const
             Bool_t IsActive()
           TModule* Module(const char* mkname)
               void SetDebug(Int_t l = 1)
               void SetActive(Bool_t k = kTRUE)
               void SetMakeReturn(Int_t ret)
               void SetInput(const char* log, const char* act)
               void SetOutput(const char* log, TDataSet* ds)
               void SetOutput(TDataSet* ds)
               void SetMode(Int_t mode = 0)
           Double_t RealTime()
           Double_t CpuTime()
               void StartTimer(Bool_t reset = kFALSE)
               void StopTimer()
               void PrintTotalTime()
        const char* GetCVS() const
            TClass* Class()
            TClass* IsA() const
               void ShowMembers(TMemberInspector& insp, char* parent)
               void StreamerNVirtual(TBuffer& b)
            TModule TModule(TModule&)


Last update: Wed Apr 17 21:53:41 2002


ROOT page - Class index - Top of the page

This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.