HepMC3 event record library
Public Member Functions
ValidationTool Class Referenceabstract

Virtual Interface to validation tools. More...

#include <ValidationTool.h>

+ Inheritance diagram for ValidationTool:

Public Member Functions

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

Detailed Description

Virtual Interface to validation tools.

Definition at line 26 of file ValidationTool.h.

Constructor & Destructor Documentation

virtual ~ValidationTool ( )
inlinevirtual

Virtual destructor

Definition at line 32 of file ValidationTool.h.

Member Function Documentation

virtual void finalize ( )
pure virtual
virtual void initialize ( )
pure virtual
virtual const std::string long_name ( )
inlinevirtual

Get long name of the tool.

Reimplemented in PythiaValidationTool, and OutputValidationTool.

Definition at line 57 of file ValidationTool.h.

virtual const std::string name ( )
pure virtual
virtual int process ( GenEvent hepmc)
pure virtual
virtual class 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 in PythiaValidationTool, PhotosValidationTool, TauolaValidationTool, and OutputValidationTool.

Definition at line 65 of file ValidationTool.h.

virtual bool tool_modifies_event ( )
pure virtual

Get information if this tool modifies the event.

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

Implemented in PythiaValidationTool, PhotosValidationTool, TauolaValidationTool, OutputValidationTool, McTesterValidationTool, and SimpleEventTool.


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