BrHistIOModule

class description - source file - inheritance tree

class BrHistIOModule : public BrIOModule


    public:

       BrHistIOModule BrHistIOModule()
       BrHistIOModule BrHistIOModule(const Char_t* name, const Char_t* title)
       BrHistIOModule BrHistIOModule(BrHistIOModule&)
         virtual void ~BrHistIOModule()
         virtual void Begin()
       static TClass* Class()
       virtual Bool_t Close()
         virtual void End()
         virtual void Event(BrEventNode*, BrEventNode*)
         virtual void Event(BrEvent*)
         virtual void Finish()
      virtual TClass* IsA() const
       virtual Bool_t Open(const Char_t* fileName, const Option_t* option = "0")
         virtual void Print(Option_t* option = "B") const
         virtual void SetIOMode(UInt_t)
         virtual void ShowMembers(TMemberInspector& insp, char* parent)
         virtual void Streamer(TBuffer& b)
                 void StreamerNVirtual(TBuffer& b)

Data Members

    private:

      TFile* fFile  Pointer to ROOT file

Class Description

 Histogram file module.

 This is an extremly simple module. All it does, is to open a ROOT
 file and stay in that directory. This means, that it is ideal to
 use for booking histograms in a BrModuleContainer pipeline.

 To use it, have something like

   BrModuleContainer* container =
     new BrModuleContainer("container", "A Module Container");
   BrHistIOModule* histModule =
     new BrHistIOModule("histModule", "A hsitogram module");
   histModule->AddFile("myhistograms.root");
   container->AddModule(histModule);
   ... the remaining modules should be defined and added to the
   ... container AFTER this

 With BrMainModule, you can do something like

   if (histOption->GetValue()[0] != '\0') {
     BrHistIOModule* histModule =
       new BrHistIOModule("histModule", "A hsitogram module");
     histModule->AddFile("myhistograms.root");
     mainModule->AddModule(histModule);
     mainModule->SetHistOn()
   }

 and all histograms will be booked in BrMainModule::Main

BrHistIOModule()

 Default constructor. DO NOT USE

BrHistIOModule(const Char_t* name, const Char_t* title) : BrIOModule(const_cast<char*>(name), const_cast<char*>(title))

 Named constructor
 Default IO mode (see BrIOModule) is: JOB & RECREATE

~BrHistIOModule()

 Destructor

void Finish()

 This method differs from BrIOModule::Finish, cause modules may
 manipulate histograms in Finish method.

Bool_t Open(const Char_t* fileName, const Option_t* option)

 Open the histogram file

Bool_t Close()

 Close the histogram file

void Print(Option_t* option) const

 Module Information method

 Options: (see also BrModule::Print)

Inline Functions

                  void SetIOMode(UInt_t)
                  void Begin()
                  void Event(BrEventNode*, BrEventNode*)
                  void Event(BrEvent*)
                  void End()
               TClass* Class()
               TClass* IsA() const
                  void ShowMembers(TMemberInspector& insp, char* parent)
                  void Streamer(TBuffer& b)
                  void StreamerNVirtual(TBuffer& b)
        BrHistIOModule BrHistIOModule(BrHistIOModule&)

This page automatically generated by script docBrat by Christian Holm

Validate HTML
Validate CSS