jobc::Node Class Reference

A node is the smallest unit of analysis and/or reconstruction code that defines a job. More...

#include <Node.h>

Inheritance diagram for jobc::Node:

List of all members.

Public Member Functions
	Node ()
	Node (const char *name, const char *ver="default", bool isSeq=false)
	Node (const Node &n)
virtual	~Node ()
const char *	Name () const
const char *	FolderName () const
bool	IsSequence () const
void	SetFilter (bool onoff=true)
void	ReverseFilter (bool onoff=true)
void	ActivateReco (bool onoff=true)
void	ActivateAna (bool onoff=true)
void	StepInToFolder () const
void	StepOutOfFolder () const
Node &	operator= (const Node &rhs)
Module *	GetModule ()
virtual Node *	GetNode (const char *)
virtual bool	Exec (edm::EventHandle &evt)
virtual void	Print (const char *indent=0) const
virtual void	ResourceReport (bool printheader=false) const
double	AnaTime () const
double	RecoTime () const
std::string	AsXML () const
Protected Attributes
Module *	fModule
bool	fIsSequence
std::string	fName
	Name of module/node.
std::string	fVersion
	Configuration version used by module.
std::string	fFolderName
	Name of folder used for histogram output.
bool	fFilterActive
	Are the filters active?
bool	fFilterReversed
	Reverse the meanings of pass/fail?
bool	fRecoActive
	Run the Reco method?
bool	fAnaActive
	Run the Ana method?
unsigned int	fNpassReco
	# of events which passed Reco method
unsigned int	fNfailReco
	# of events which passed Reco method
unsigned int	fNpassAna
	# of events which passed Ana method
unsigned int	fNfailAna
	# of events which failed Ana method
Resource	fResourceAna
	Resources used by Ana method.
Resource	fResourceReco
	Resources used by Reco method.

---

Detailed Description

A node is the smallest unit of analysis and/or reconstruction code that defines a job.

Definition at line 21 of file Node.h.

---

Constructor & Destructor Documentation

Node::Node (   )

Definition at line 25 of file Node.cxx. Referenced by jobc::Sequence::PushBack(), and jobc::Sequence::PushFront(). : fModule ( 0 ), fIsSequence ( false ), fName ( "*" ), fVersion ( "*" ), fFolderName ( "?" ), fFilterActive ( true ), fFilterReversed ( false ), fRecoActive ( true ), fAnaActive ( true ), fNpassReco ( 0 ), fNfailReco ( 0 ), fNpassAna ( 0 ), fNfailAna ( 0 ) { }

Node::Node (  const char *  name, const char *  ver = "default", bool  isSeq = false )

Definition at line 43 of file Node.cxx. References fFolderName, fIsSequence, and fVersion. : fModule ( 0 ), fIsSequence ( isSeq ), fName ( name ), fVersion ( version ), fFolderName ( "" ), fFilterActive ( true ), fFilterReversed ( false ), fRecoActive ( true ), fAnaActive ( true ), fNpassReco ( 0 ), fNfailReco ( 0 ), fNpassAna ( 0 ), fNfailAna ( 0 ) { // strip ':' (which come from namespaces) from folder names for (int i=0; name[i]!='\0'; ++i) if (name[i] != ':') fFolderName += name[i]; // Attach version to folder name if its not 'default' if (fIsSequence==false && fVersion!="default") { fFolderName += "_"; fFolderName += fVersion; } }

Node::Node (  const Node &  n  )

Definition at line 73 of file Node.cxx. : fModule ( 0 ), fIsSequence ( false ), fName ( "*" ), fVersion ( "*" ), fFolderName ( "?" ), fFilterActive ( true ), fFilterReversed ( false ), fRecoActive ( true ), fAnaActive ( true ), fNpassReco ( 0 ), fNfailReco ( 0 ), fNpassAna ( 0 ), fNfailAna ( 0 ), fResourceAna (n.fResourceAna), fResourceReco (n.fResourceReco) { *this = n; }

Node::~Node (   )  [virtual]

Definition at line 93 of file Node.cxx. References fModule, StepInToFolder(), and jobc::HistoFile::StepOut(). { if (fModule) { this->StepInToFolder(); delete fModule; fModule = 0; HistoFile::StepOut(); } }

---

Member Function Documentation

void jobc::Node::ActivateAna (  bool  onoff = true  )  [inline]

Definition at line 35 of file Node.h. Referenced by jobc::nodeBuilder::Build(), testJobCJob(), testJobCNode(), and testJobCSequence(). { fAnaActive = onoff; }

void jobc::Node::ActivateReco (  bool  onoff = true  )  [inline]

Definition at line 34 of file Node.h. Referenced by jobc::nodeBuilder::Build(), testJobCJob(), testJobCNode(), and testJobCSequence(). { fRecoActive = onoff; }

double Node::AnaTime (   )  const

Definition at line 105 of file Node.cxx. References fResourceAna, jobc::Resource::stime, and jobc::Resource::utime. Referenced by jobc::Sequence::Print(). { return fResourceAna.stime+fResourceAna.utime; }

std::string Node::AsXML (   )  const

Return a string which contains the XML flags required to create this node Reimplemented in jobc::Job, and jobc::Sequence. Definition at line 371 of file Node.cxx. References fName, and fVersion. Referenced by testJobCNode(). { std::ostringstream xml; xml << "<node "; if (fIsSequence) xml << "sequence=\"" << fName << "\" "; else xml << "module=\"" << fName << "\" "; xml << "config=\"" << fVersion << "\" "; if (fRecoActive) xml << "reco=\"1\" "; else xml << "reco=\"0\" "; if (fAnaActive) xml << "ana=\"1\" "; else xml << "ana=\"0\" "; if (fFilterActive) { if (fFilterReversed) xml << "filter=\"reversed\""; else xml << "filter=\"on\""; } else { xml << "filter=\"off\""; } xml << "/>"; return xml.str(); }

bool Node::Exec (  edm::EventHandle &  evt  )  [virtual]

Todo: Support filters based on any combination of Reco and Ana results Reimplemented in jobc::Sequence. Definition at line 176 of file Node.cxx. References jobc::Module::Ana(), jobc::Resource::Difference(), fAnaActive, fFilterActive, fRecoActive, fResourceAna, fResourceReco, GetModule(), jobc::Resource::Log(), jobc::Module::Reco(), jobc::Result, StepInToFolder(), StepOutOfFolder(), and jobc::Resource::Sum(). { //====================================================================== // Run the Ana/Reco methods for the module //====================================================================== bool passed = true; Result passedReco = kPassed; Result passedAna = kPassed; Resource r0; Resource r1; if (fRecoActive) { // Execute the method this->StepInToFolder(); r0.Log(); passedReco = this->GetModule()->Reco(evt); r1.Log(); r1.Difference(r0); fResourceReco.Sum(r1); this->StepOutOfFolder(); if (passedReco==kPassed) ++fNpassReco; else ++fNfailReco; } if (fAnaActive) { this->StepInToFolder(); r0.Log(); passedAna = this->GetModule()->Ana(evt); r1.Log(); r1.Difference(r0); fResourceAna.Sum(r1); this->StepOutOfFolder(); if (passedAna==kPassed) ++fNpassAna; else ++fNfailAna; } // No filters active, pass all events if (fFilterActive==false) return true; // if (fFilterMode == kRecoOnly) passed = passedReco; // if (fFilterMode == kAnaOnly ) passed = passedAna; // if (fFilterMode == kRecoAndAna) passed = passedReco&passedAna; // if (fFilterMode == kRecoOrAna) passed = passedReco|passedAna; // if (fFilterMode == kRecoAndNotAna) passed = passedReco&(!passedAna); // if (fFilterMode == kNotRecoAndAna) passed = (!passedReco)&passedAna; // For now consider an event failed if either Reco or Ana fail the // event passed = true; if (fRecoActive && (passedReco==kFailed)) passed = false; if (fAnaActive && (passedAna ==kFailed)) passed = false; if (fFilterReversed) return !passed; // Flip pass/fail return passed; // Normal case }

const char* jobc::Node::FolderName (   )  const [inline]

Definition at line 29 of file Node.h. { return fFolderName.c_str(); }

Module * Node::GetModule (   )

Definition at line 117 of file Node.cxx. References fModule, fName, fVersion, jobc::ModuleFactory::Instance(), jobc::ModuleFactory::LookUp(), jobc::ModuleMaker_t, StepInToFolder(), and StepOutOfFolder(). Referenced by jobc::Sequence::EndFile(), jobc::Sequence::EndRun(), jobc::Sequence::EndSubrun(), Exec(), jobc::Sequence::NewFile(), jobc::Sequence::NewRun(), and jobc::Sequence::NewSubrun(). { //====================================================================== // Return the module associated with this node //====================================================================== if (fModule==0) { ModuleMaker_t mm = ModuleFactory::Instance().LookUp(fName.c_str()); if (mm==0) { std::cerr << "JobCNode:" << __LINE__ << " Unable to find module " << fName.c_str() << std::endl; abort(); return 0; } this->StepInToFolder(); fModule = (*mm)(fVersion.c_str()); // Build the module this->StepOutOfFolder(); } return fModule; }

virtual Node* jobc::Node::GetNode (  const char *   )  [inline, virtual]

Reimplemented in jobc::Sequence. Definition at line 43 of file Node.h. { return this; }

bool jobc::Node::IsSequence (   )  const [inline]

Definition at line 30 of file Node.h. Referenced by jobc::sequenceBuilder::Build(), jobc::jobBuilder::Build(), jobc::Sequence::EndFile(), jobc::Sequence::EndRun(), jobc::Sequence::EndSubrun(), jobc::Sequence::NewFile(), jobc::Sequence::NewRun(), jobc::Sequence::NewSubrun(), jobc::Sequence::operator=(), jobc::Sequence::Print(), and jobc::Sequence::ResourceReport(). { return fIsSequence; }

const char* jobc::Node::Name (   )  const [inline]

Definition at line 28 of file Node.h. Referenced by jobc::Sequence::GetNode(), jobc::SeqTable::Insert(), jobc::Sequence::Print(), and jobc::Job::Run(). { return fName.c_str(); }

Node & Node::operator= (  const Node &  rhs  )

Definition at line 139 of file Node.cxx. References fAnaActive, fFilterActive, fFilterReversed, fFolderName, fIsSequence, fModule, fName, fNfailAna, fNfailReco, fNpassAna, fNpassReco, fRecoActive, fVersion, StepInToFolder(), and StepOutOfFolder(). Referenced by jobc::Sequence::operator=(). { if (fModule) { this->StepInToFolder(); delete fModule; this->StepOutOfFolder(); } fModule = 0; fIsSequence = rhs.fIsSequence; fName = rhs.fName; fVersion = rhs.fVersion; fFolderName = rhs.fFolderName; fFilterActive = rhs.fFilterActive; fFilterReversed = rhs.fFilterReversed; fRecoActive = rhs.fRecoActive; fAnaActive = rhs.fAnaActive; fNpassReco = 0; fNfailReco = 0; fNpassAna = 0; fNfailAna = 0; return *this; }

void Node::Print (  const char *  indent = 0  )  const [virtual]

Definition at line 234 of file Node.cxx. References fFilterActive, fResourceAna, fResourceReco, jobc::Resource::stime, and jobc::Resource::utime. Referenced by jobc::Sequence::Print(), and testJobCNode(). { const char* filterStr = " "; if ( fFilterActive && !fFilterReversed) filterStr = "+"; if ( fFilterActive && fFilterReversed) filterStr = "!"; const char* recoStr = "-reco"; if (fRecoActive) recoStr = "+reco"; const char* anaStr = "-ana "; if (fAnaActive) anaStr = "+ana "; std::string mod(""); if (indent) mod += indent; mod += filterStr; mod += fName; mod += "/"; mod += fVersion; mod += "/"; char buff[256]; sprintf(buff, "%-32s %s/%.5d/%.5d/%.5d %.2e/%.2e\n" "%-32s %s/%.5d/%.5d/%.5d %.2e/%.2e", mod.c_str(), recoStr, fNpassReco, fNfailReco, fNpassReco+fNfailReco, fResourceReco.utime, fResourceReco.stime, "", anaStr, fNpassAna, fNfailAna, fNpassAna+fNfailAna, fResourceAna.utime, fResourceAna.stime); std::cout << buff << std::endl; }

double Node::RecoTime (   )  const

Definition at line 111 of file Node.cxx. References fResourceReco, jobc::Resource::stime, and jobc::Resource::utime. Referenced by jobc::Sequence::Print(). { return fResourceReco.stime+fResourceReco.utime; }

void Node::ResourceReport (  bool  printheader = false  )  const [virtual]

Reimplemented in jobc::Sequence. Definition at line 277 of file Node.cxx. References fName, fResourceAna, fResourceReco, jobc::Resource::idrss, jobc::Resource::inblock, jobc::Resource::isrss, jobc::Resource::ixrss, jobc::Resource::majflt, jobc::Resource::maxrss, jobc::Resource::minflt, jobc::Resource::msgrcv, jobc::Resource::msgsnd, jobc::Resource::nivcsw, jobc::Resource::nsignals, jobc::Resource::nswap, jobc::Resource::nvcsw, jobc::Resource::oublock, jobc::Resource::statm_drs, jobc::Resource::statm_dt, jobc::Resource::statm_lrs, jobc::Resource::statm_resident, jobc::Resource::statm_shared, jobc::Resource::statm_size, jobc::Resource::statm_trs, jobc::Resource::stime, and jobc::Resource::utime. Referenced by jobc::Sequence::ResourceReport(). { const char* label[] = { "Module/Method", "utime", "stime", "maxrss", "ixrss", "idrss", "isrss", "minflt", "majflt", "nswap", "inblock", "oublock", "msgsnd", "msgrcv", "nsignals", "nvcsw", "nivcsw", "size", "resident", "shared", "trs", "drs", "lrs", "dt", 0 }; if (printheader) { printf("%20s " "%8s %8s %8s %8s " "%8s %8s %8s %8s " "%8s %8s %8s %8s " "%8s %8s %8s %8s " "%8s %8s %8s %8s\n", label[0], label[1], label[2], label[3], label[4], label[5], label[6], label[7], label[5], label[9], label[10], label[11], label[6], label[13], label[14], label[15], label[16], label[17], label[18], label[19], label[20]); } std::string reco(fName); reco += ":reco"; printf("%20s " "%8.2e %8.2e %8.2e %8.2e %8.2e " "%8.2e %8.2e %8.2e %8.2e %8.2e " "%8.2e %8.2e %8.2e %8.2e %8.2e " "%8.2e %8.2e %8.2e %8.2e %8.2e " "%8.2e %8.2e %8.2e\n", reco.c_str(), fResourceReco.utime, fResourceReco.stime, fResourceReco.maxrss, fResourceReco.ixrss, fResourceReco.idrss, fResourceReco.isrss, fResourceReco.minflt, fResourceReco.majflt, fResourceReco.nswap, fResourceReco.inblock, fResourceReco.oublock, fResourceReco.msgsnd, fResourceReco.msgrcv, fResourceReco.nsignals, fResourceReco.nvcsw, fResourceReco.nivcsw, fResourceReco.statm_size, fResourceReco.statm_resident, fResourceReco.statm_shared, fResourceReco.statm_trs, fResourceReco.statm_drs, fResourceReco.statm_lrs, fResourceReco.statm_dt); std::string ana(fName); ana += ":ana"; printf("%20s " "%8.2e %8.2e %8.2e %8.2e %8.2e " "%8.2e %8.2e %8.2e %8.2e %8.2e " "%8.2e %8.2e %8.2e %8.2e %8.2e " "%8.2e %8.2e %8.2e %8.2e %8.2e " "%8.2e %8.2e %8.2e\n", ana.c_str(), fResourceAna.utime, fResourceAna.stime, fResourceAna.maxrss, fResourceAna.ixrss, fResourceAna.idrss, fResourceAna.isrss, fResourceAna.minflt, fResourceAna.majflt, fResourceAna.nswap, fResourceAna.inblock, fResourceAna.oublock, fResourceAna.msgsnd, fResourceAna.msgrcv, fResourceAna.nsignals, fResourceAna.nvcsw, fResourceAna.nivcsw, fResourceAna.statm_size, fResourceAna.statm_resident, fResourceAna.statm_shared, fResourceAna.statm_trs, fResourceAna.statm_drs, fResourceAna.statm_lrs, fResourceAna.statm_dt); }

void jobc::Node::ReverseFilter (  bool  onoff = true  )  [inline]

Definition at line 33 of file Node.h. Referenced by jobc::nodeBuilder::Build(), testJobCJob(), testJobCNode(), and testJobCSequence(). { fFilterReversed = onoff; }

void jobc::Node::SetFilter (  bool  onoff = true  )  [inline]

Definition at line 32 of file Node.h. Referenced by jobc::nodeBuilder::Build(), testJobCJob(), testJobCNode(), and testJobCSequence(). { fFilterActive = onoff; }

void Node::StepInToFolder (   )  const

Definition at line 164 of file Node.cxx. References jobc::HistoFile::StepIn(). Referenced by jobc::Sequence::EndFile(), jobc::Sequence::EndRun(), jobc::Sequence::EndSubrun(), Exec(), GetModule(), jobc::Sequence::NewFile(), jobc::Sequence::NewRun(), jobc::Sequence::NewSubrun(), operator=(), and ~Node(). { HistoFile::StepIn(this->fFolderName.c_str()); }

void Node::StepOutOfFolder (   )  const

Definition at line 170 of file Node.cxx. References jobc::HistoFile::StepOut(). Referenced by jobc::Sequence::EndFile(), jobc::Sequence::EndRun(), jobc::Sequence::EndSubrun(), Exec(), GetModule(), jobc::Sequence::NewFile(), jobc::Sequence::NewRun(), jobc::Sequence::NewSubrun(), and operator=(). { HistoFile::StepOut(); }

---

Member Data Documentation

bool jobc::Node::fAnaActive [protected]

Run the Ana method? Definition at line 62 of file Node.h. Referenced by Exec(), and operator=().

bool jobc::Node::fFilterActive [protected]

Are the filters active? Definition at line 59 of file Node.h. Referenced by Exec(), operator=(), and Print().

bool jobc::Node::fFilterReversed [protected]

Reverse the meanings of pass/fail? Definition at line 60 of file Node.h. Referenced by operator=().

std::string jobc::Node::fFolderName [protected]

Name of folder used for histogram output. Definition at line 58 of file Node.h. Referenced by Node(), and operator=().

bool jobc::Node::fIsSequence [protected]

Definition at line 54 of file Node.h. Referenced by Node(), and operator=().

Module* jobc::Node::fModule [protected]

Definition at line 53 of file Node.h. Referenced by GetModule(), operator=(), and ~Node().

std::string jobc::Node::fName [protected]

Name of module/node. Definition at line 56 of file Node.h. Referenced by AsXML(), GetModule(), operator=(), and ResourceReport().

unsigned int jobc::Node::fNfailAna [protected]

# of events which failed Ana method Definition at line 66 of file Node.h. Referenced by operator=().

unsigned int jobc::Node::fNfailReco [protected]

# of events which passed Reco method Definition at line 64 of file Node.h. Referenced by operator=().

unsigned int jobc::Node::fNpassAna [protected]

# of events which passed Ana method Definition at line 65 of file Node.h. Referenced by operator=().

unsigned int jobc::Node::fNpassReco [protected]

# of events which passed Reco method Definition at line 63 of file Node.h. Referenced by operator=().

bool jobc::Node::fRecoActive [protected]

Run the Reco method? Definition at line 61 of file Node.h. Referenced by Exec(), and operator=().

Resource jobc::Node::fResourceAna [protected]

Resources used by Ana method. Definition at line 67 of file Node.h. Referenced by AnaTime(), Exec(), Print(), and ResourceReport().

Resource jobc::Node::fResourceReco [protected]

Resources used by Reco method. Definition at line 68 of file Node.h. Referenced by Exec(), Print(), RecoTime(), and ResourceReport().

std::string jobc::Node::fVersion [protected]

Configuration version used by module. Definition at line 57 of file Node.h. Referenced by AsXML(), GetModule(), Node(), and operator=().

---

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

• Node.h
• Node.cxx

---