HistManModule Class Reference
[DataUtil]

A module to write out any histograms held in the HistMan hierarchy. More...

#include <HistManModule.h>

Inheritance diagram for HistManModule:

List of all members.

Public Member Functions
	HistManModule ()
	~HistManModule ()
virtual void	EndFile ()
virtual void	EndJob ()
virtual const Registry &	DefaultConfig () const
virtual JobCResult	Put (const MomNavigator *)
Static Public Member Functions
HistMan	GetHistMan (JobCModule &mod, const char *subdir=0)

---

Detailed Description

A module to write out any histograms held in the HistMan hierarchy.

Configuration parameters:

"OutputFilename" sets the name of the end-of-job file to write out. Set to 0 or "" to not write out end-of-job

"FileExtension" sets the end-of-file extension to use when writing out end-of-file histograms. This is mutually exclusive with and if set, supersedes "OutputFilename". This causes one HistMan file to be written out for each input file. The output filename will be formed by using the input filename up to the first "." with the "FileExtension" added (should include an initial "." if one is desired).

There is a static method, HistMan::GetHistMan(), to get a uniquely rooted HistMan based on the UniqueName of the given JobCModule and an optional subdirectory.

One should place "HistMan::Put" in the path to get the histograms written out.

Author:

(last to touch it)

Author

bv

Version:

Revision

1.3

Date:

Date

2005/11/28 21:22:37

Contact: bv@bnl.gov

Created on: Fri Apr 15 10:40:34 2005

Id

HistManModule.h,v 1.3 2005/11/28 21:22:37 bv Exp

Definition at line 51 of file HistManModule.h.

---

Constructor & Destructor Documentation

HistManModule::HistManModule (   )

Definition at line 13 of file HistManModule.cxx. { }

HistManModule::~HistManModule (   )

Definition at line 17 of file HistManModule.cxx. { }

---

Member Function Documentation

const Registry & HistManModule::DefaultConfig (   )  const [virtual]

Get the default configuration registry. This should normally be overridden. One useful idiom is to implement it like: const Registry& MyModule::DefaultConfig() const { static Registry cfg; // never is destroyed if (cfg.Size()) return cfg; // already filled it // set defaults: cfg.Set("TheAnswer",42); cfg.Set("Units","unknown"); return cfg; } Reimplemented from JobCModule. Definition at line 52 of file HistManModule.cxx. References Registry::Set(), and Registry::Size(). { static Registry r; if (!r.Size()) { r.Set("OutputFilename","histman.root"); r.Set("FileExtension",""); } return r; }

void HistManModule::EndFile (   )  [virtual]

Implement for notification of end of file. See GetLastFile(). Reimplemented from JobCModule. Definition at line 28 of file HistManModule.cxx. References Registry::Get(), JobCModule::GetConfig(), make_name(), and HistMan::WriteOut(). { const char* fileext = ""; this->GetConfig().Get("FileExtension",fileext); if (! (fileext && fileext[0])) return; string filename = make_name(this->GetLastFile(),fileext); HistMan hm(""); hm.WriteOut(filename.c_str()); }

void HistManModule::EndJob (   )  [virtual]

Implement for notification of end of job Reimplemented from JobCModule. Definition at line 40 of file HistManModule.cxx. References Registry::Get(), JobCModule::GetConfig(), and HistMan::WriteOut(). { const char* fileext = ""; this->GetConfig().Get("FileExtension",fileext); if (fileext && fileext[0]) return; const char* filename = "histman.root"; this->GetConfig().Get("OutputFilename",filename); HistMan hm(""); hm.WriteOut(filename); }

HistMan HistManModule::GetHistMan (  JobCModule &  mod, const char *  subdir = 0 )  [static]

Definition at line 69 of file HistManModule.cxx. References Form(), and JobCModule::GetUniqueName(). Referenced by UserAnalysis::BeginJob(). { if (subdir) return HistMan(Form("%s/%s",mod.GetUniqueName(),subdir)); return HistMan(mod.GetUniqueName()); }

JobCResult HistManModule::Put (  const MomNavigator *   )  [virtual]

Implement if your module needs to write data to some external sink. Reimplemented from JobCModule. Definition at line 62 of file HistManModule.cxx. { // dummy so we can get our EndJob done. return JobCResult::kAOK; }

---

The documentation for this class was generated from the following files:

• HistManModule.h
• HistManModule.cxx

---