#include </dev/shm/kenichi/update-github-e1039-doc/e1039-core/framework/fun4all/SubsysReco.h>

Inherits Fun4AllBase.

Inherited by AnaEffCham, AnaEffHodo, AnaModule, AnaModule, AnaModule, AnaRealDst, AnaSimDst, AnaTrkQA, AnaWait, CalibEvtQual, CalibInTime, CalibMergeH4, CalibXT, DbUpRun, DbUpSpill, DetectorConstructionWrapper, DPTriggerAnalyzer, EvtDispFilter, EvtFilter, FilterSimEvent, HepMCCompress, HepMCFlowAfterBurner, HepMCNodeReader, OnlMonClient, PatternDBGen, PHEventDisplay, PHG4BlockCellReco, PHG4ConsistencyCheck, PHG4CylinderCellReco, PHG4CylinderCellTPCReco, PHG4DSTReader, PHG4GenHit, PHG4HeadReco, PHG4HitReadBack, PHG4InEventCompress, PHG4InEventReadBack, PHG4InputFilter, PHG4ParticleGeneratorBase, PHG4Reco, PHG4Subsystem, PHGeomFileImport, PHHepMCParticleSelectorDecayProductChain, PHPythia8, RequireParticlesInAcc, RndmEmbed, SimDstTrimmer, SimpleTree, SQDigitizer, SQReco, SQTruthVertexing, SRawEventEmbed, TruthEval, TruthNodeMaker, and VertexFit.

Collaboration diagram for SubsysReco:

Public Member Functions
virtual	~SubsysReco ()

virtual int	End (PHCompositeNode *)
	Called at the end of all processing. More...

virtual int	EndRun (const int)
	Called at the end of each run. More...

virtual int	Init (PHCompositeNode *)

virtual int	InitRun (PHCompositeNode *)

virtual int	process_event (PHCompositeNode *)

virtual int	Reset (PHCompositeNode *)
	Reset. More...

virtual int	ResetEvent (PHCompositeNode *)
	Clean up after each event. More...

virtual void	Print (const std::string &what="ALL") const

Public Member Functions inherited from Fun4AllBase
virtual	~Fun4AllBase ()

virtual const std::string	Name () const
	Returns the name of this module. More...

virtual void	Name (const std::string &name)
	Sets the name of this module. More...

virtual void	Verbosity (const int ival)
	Sets the verbosity of this module (0 by default=quiet). More...

virtual void	Verbosity (enu_Verbosity ival)
	Sets the verbosity of this module (0 by default=quiet). More...

virtual int	Verbosity () const
	Gets the verbosity of this module. More...

Protected Member Functions
	SubsysReco (const std::string &name="NONAME")

Protected Member Functions inherited from Fun4AllBase
	Fun4AllBase (const std::string &name="NONAME")

Additional Inherited Members
Public Types inherited from Fun4AllBase
enum	enu_Verbosity { VERBOSITY_QUIET = 0, VERBOSITY_SOME = 1, VERBOSITY_MORE = 2, VERBOSITY_EVEN_MORE = 3, VERBOSITY_A_LOT = 4, VERBOSITY_MAX = INT_MAX - 10 }

Protected Attributes inherited from Fun4AllBase
std::string	ThisName

int	verbosity
	The verbosity level. 0 means not verbose at all. More...

Detailed Description

Base class for all reconstruction and analysis modules to be used under the Fun4All framework.

If you write a reconstruction/analysis module, you must derive from this base class and you have to implement this class methods. None of these are strictly required as far as C++ is concerned, but as far as your job is concerned, at least process_event(), to do the job, and InitRun(), to initialize, should be implemented.

Definition at line 20 of file SubsysReco.h.

Constructor & Destructor Documentation

virtual SubsysReco::~SubsysReco ( )

inlinevirtual

dtor. Does nothing as this is a base class only.

Definition at line 28 of file SubsysReco.h.

SubsysReco::SubsysReco ( const std::string & name = "NONAME" )

inlineprotected

ctor.

Parameters

name	is the reference used inside the Fun4AllServer

Definition at line 67 of file SubsysReco.h.

Member Function Documentation

virtual int SubsysReco::End ( PHCompositeNode * )

inlinevirtual

Called at the end of all processing.

Reimplemented in DPTriggerAnalyzer, OnlMonClient, VertexFit, TruthNodeMaker, SimpleTree, PHG4Reco, AnaTrkQA, SRawEventEmbed, PHG4DSTReader, PatternDBGen, RndmEmbed, SQReco, PHEventDisplay, SQTruthVertexing, PHPythia8, EvtFilter, AnaSimDst, TruthEval, AnaEffCham, CalibEvtQual, AnaModule, AnaRealDst, DetectorConstructionWrapper, PHGeomFileImport, RequireParticlesInAcc, AnaEffHodo, AnaModule, PHG4PileupGenerator, AnaModule, SimDstTrimmer, AnaWait, EvtDispFilter, FilterSimEvent, PHG4InEventCompress, CalibInTime, CalibXT, DbUpRun, CalibMergeH4, DbUpSpill, and PHG4InEventReadBack.

Definition at line 31 of file SubsysReco.h.

Referenced by PHG4PileupGenerator::End().

Here is the caller graph for this function:

virtual int SubsysReco::EndRun ( const int )

inlinevirtual

Called at the end of each run.

Reimplemented in PHG4PileupGenerator.

Definition at line 34 of file SubsysReco.h.

Referenced by PHG4PileupGenerator::EndRun().

Here is the caller graph for this function:

virtual int SubsysReco::Init ( PHCompositeNode * )

inlinevirtual

Called during initialization. Typically this is where you can book histograms, and e.g. register them to Fun4AllServer (so they can be output to file using Fun4AllServer::dumpHistos() method).

Reimplemented in DPTriggerAnalyzer, OnlMonClient, VertexFit, TruthNodeMaker, SimpleTree, AnaTrkQA, SRawEventEmbed, PatternDBGen, RndmEmbed, SQReco, PHG4DSTReader, PHG4Reco, PHEventDisplay, SQTruthVertexing, PHPythia8, SQPrimaryParticleGen, AnaSimDst, TruthEval, AnaEffCham, PHG4CylinderCellTPCReco, EvtFilter, PHG4ConeSubsystem, CalibEvtQual, SQDigitizer, HepMCNodeReader, AnaModule, AnaRealDst, DetectorConstructionWrapper, PHGeomFileImport, PHG4DetectorGroupSubsystem, RequireParticlesInAcc, AnaEffHodo, PHG4DetectorSubsystem, AnaModule, AnaModule, SimDstTrimmer, HepMCCompress, AnaWait, EvtDispFilter, PHG4PileupGenerator, FilterSimEvent, CalibInTime, CalibXT, DbUpRun, PHG4HeadReco, CalibMergeH4, and DbUpSpill.