BrModule


class description - source file - inheritance tree

class BrModule : public TNamed


    public:
BrModule BrModule(Char_t* name, Char_t* title) BrModule BrModule(BrModule&) BrModule BrModule() void ~BrModule() virtual void AddRequiredTable(TObject* tablename) virtual void Begin() TClass* Class() Int_t DebugLevel() virtual void End() virtual void Event() virtual void Event(BrEventNode* inev, BrEventNode* outev) virtual void EventStatisticsEnd() virtual void EventStatisticsStart() virtual TList* GetRequiredTableList() TList* HistogramList() virtual void Info() virtual void Init() virtual TClass* IsA() virtual void ListEventStatistics() void SetDebugLevel(Int_t level) void SetRequiredData(Char_t* name) void SetVerbose(Int_t Verbose) virtual void ShowMembers(TMemberInspector& insp, char* parent) virtual void Streamer(TBuffer& b)

Data Members

private:
Int_t d_DebugLevel Level for amount of debug information TList* d_HistogramList_p List of histograms associated with Int_t d_Verbose Option flag TList* fRequiredTableList TStopwatch fTimer Double_t fCpuTime


See also

BrCombineTrack, BrDigitizeDC, BrDigitizeTPC, BrDigitizeTof, BrLocalTrackModule

Class Description

	BrModule

	BRAHMS Analysis Module Class

	A standard Physics analysis Module should be derived from
	this base class. This ensure that the general framework
	is capable of accessing these in a common and general way.
	The methods (member functions) consists of a general set for
	all modules; but the user if free to add specific ones for
	specific needs. Ideas for this has been taken from both the
	PHOBOS tool set as well as from the BABAR framework. The initial version
	is derived from the ROOT base classes,

	Author :	Flemming Videbaek
	Created:	27/12/97
	Version:	1.0



BrModule()
 Vanilla constructor; Should  not be called within the ROOT environment.


BrModule(Char_t *Name, Char_t *Title)
 Constructor. This is the default constructor to use. The names of the
 Modules can be used for navigation and identification.


~BrModule()
 default destructor; Should  not be called within the ROOT environment.


void Event()
 Event method with no Data objects. In normal application to be called once per event.
 The method should also be overwritten in the concrete class. A dummy
 routine is supplied in case a module for some strange reason is not called
 per event.


void Event(BrEventNode* inev, BrEventNode* outev)
 Default Event method with in/out Data objects. In normal application to be
 called once per event.
 method should also be overwritten in the concrete class. A dummy
 routine is supplied in case a module for some strange reason is not called
 per event.


void Info() const
 Information module. In the final implementation this MUST be overwritten by the derived
 class. Here a default behaviour is implemented.

void SetRequiredData(Char_t* name)
 Set the name of a required DataObject. The name will be stored in
 a list. The intent is that the calling Event method can check against
 the names (by calling a base Module member function which will search
 the input Event and return a pointer to the object.

 CheckDataObjects();
 GetDataObject
 Note none of this is implemented so far.
 2/17/98


void EventStatisticsStart()

void EventStatisticsEnd()

void ListEventStatistics()



Inline Functions


               void Init()
               void Begin()
               void End()
               void AddRequiredTable(TObject* tablename)
             TList* GetRequiredTableList()
             TList* HistogramList()
               void SetDebugLevel(Int_t level)
              Int_t DebugLevel()
               void SetVerbose(Int_t Verbose)
            TClass* Class()
            TClass* IsA()
               void ShowMembers(TMemberInspector& insp, char* parent)
               void Streamer(TBuffer& b)
           BrModule BrModule(BrModule&)


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.