HepMC3 event record library
Public Member Functions
McTesterValidationTool Class Reference

Detailed Description

Interface to MCTester.

Definition at line 23 of file McTesterValidationTool.h.

#include <McTesterValidationTool.h>

+ Inheritance diagram for McTesterValidationTool:
+ Collaboration diagram for McTesterValidationTool:

Public Member Functions

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

Member Function Documentation

◆ finalize()

void finalize ( )
virtual

Finalize.

Implements ValidationTool.

Definition at line 23 of file McTesterValidationTool.cc.

◆ initialize()

void initialize ( )
virtual

Initialize.

Implements ValidationTool.

Definition at line 8 of file McTesterValidationTool.cc.

◆ long_name()

virtual const std::string long_name ( )
inlinevirtualinherited

Get long name of the tool.

Reimplemented in OutputValidationTool, and PythiaValidationTool.

Definition at line 57 of file ValidationTool.h.

◆ name()

const std::string name ( )
inlinevirtual

Get name of the tool.

Implements ValidationTool.

Definition at line 25 of file McTesterValidationTool.h.

◆ process()

int process ( GenEvent hepmc)
virtual

Process event.

Implements ValidationTool.

Definition at line 14 of file McTesterValidationTool.cc.

◆ timer()

virtual class Timer * timer ( )
inlinevirtualinherited

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 OutputValidationTool, PhotosValidationTool, PythiaValidationTool, and TauolaValidationTool.

Definition at line 65 of file ValidationTool.h.

◆ tool_modifies_event()

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 26 of file McTesterValidationTool.h.


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