HepMC3 event record library
Public Member Functions | Private Attributes | Static Private Attributes
PhotosValidationTool Class Reference

Interface for validatio to Photos. More...

#include <PhotosValidationTool.h>

+ Inheritance diagram for PhotosValidationTool:
+ Collaboration diagram for PhotosValidationTool:

Public Member Functions

const std::string name ()
 Get name of the tool. More...
 
bool tool_modifies_event ()
 Get information if this tool modifies the event. More...
 
Timertimer ()
 Get timer for this tool (if this tool is being timed) More...
 
void initialize ()
 Initialize. More...
 
int process (GenEvent &hepmc)
 Process event. More...
 
void finalize ()
 Finalize. More...
 
virtual const std::string long_name ()
 Get long name of the tool. More...
 

Private Attributes

int m_photons_added [MAX_PHOTONS_TO_KEEP_TRACK_OF]
 Added photons. More...
 
int m_more_photons_added
 More added photons. More...
 
Timer m_timer
 Timer. More...
 

Static Private Attributes

static const int MAX_PHOTONS_TO_KEEP_TRACK_OF = 4
 Number of tracked photons. More...
 

Detailed Description

Interface for validatio to Photos.

Definition at line 24 of file PhotosValidationTool.h.

Member Function Documentation

void finalize ( )
virtual

Finalize.

Implements ValidationTool.

Definition at line 54 of file PhotosValidationTool.cc.

void initialize ( )
virtual

Initialize.

Implements ValidationTool.

Definition at line 15 of file PhotosValidationTool.cc.

virtual const std::string long_name ( )
inlinevirtualinherited

Get long name of the tool.

Reimplemented in PythiaValidationTool, and OutputValidationTool.

Definition at line 57 of file ValidationTool.h.

const std::string name ( )
inlinevirtual

Get name of the tool.

Implements ValidationTool.

Definition at line 29 of file PhotosValidationTool.h.

int process ( GenEvent hepmc)
virtual

Process event.

Implements ValidationTool.

Definition at line 23 of file PhotosValidationTool.cc.

References GenEvent::particles().

Timer* timer ( )
inlinevirtual

Get timer for this tool (if this tool is being timed)

Note that normally the tool itself should not use the timer it provides However, if one want to exclude some part of initialization timer()->start() can be used to restart the timer per each event

Reimplemented from ValidationTool.

Definition at line 31 of file PhotosValidationTool.h.

References m_timer.

bool tool_modifies_event ( )
inlinevirtual

Get information if this tool modifies the event.

Tools that do not modify event will be ignored during event printing and momentum conservation checks

Implements ValidationTool.

Definition at line 30 of file PhotosValidationTool.h.

Field Documentation

int m_more_photons_added
private

More added photons.

Definition at line 40 of file PhotosValidationTool.h.

int m_photons_added[MAX_PHOTONS_TO_KEEP_TRACK_OF]
private

Added photons.

Definition at line 39 of file PhotosValidationTool.h.

Timer m_timer
private

Timer.

Definition at line 41 of file PhotosValidationTool.h.

const int MAX_PHOTONS_TO_KEEP_TRACK_OF = 4
staticprivate

Number of tracked photons.

Definition at line 38 of file PhotosValidationTool.h.


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