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

Interface for validatio to Pythia. More...

#include <OutputValidationTool.h>

+ Inheritance diagram for OutputValidationTool:
+ Collaboration diagram for OutputValidationTool:

Public Member Functions

 OutputValidationTool (const std::string &filename)
 Constructor. More...
 
const std::string name ()
 Get name of the tool. More...
 
const std::string long_name ()
 Get long 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...
 

Private Attributes

std::string m_filename
 Used file. More...
 
Timer m_timer
 Timer. More...
 

Detailed Description

Interface for validatio to Pythia.

Definition at line 22 of file OutputValidationTool.h.

Constructor & Destructor Documentation

OutputValidationTool ( const std::string &  filename)

Constructor.

Definition at line 8 of file OutputValidationTool.cc.

Member Function Documentation

void finalize ( )
virtual

Finalize.

Implements ValidationTool.

Definition at line 23 of file OutputValidationTool.cc.

void initialize ( )
virtual

Initialize.

Implements ValidationTool.

Definition at line 11 of file OutputValidationTool.cc.

References m_filename.

const std::string long_name ( )
inlinevirtual

Get long name of the tool.

Reimplemented from ValidationTool.

Definition at line 27 of file OutputValidationTool.h.

References m_filename, and name().

const std::string name ( )
inlinevirtual

Get name of the tool.

Implements ValidationTool.

Definition at line 26 of file OutputValidationTool.h.

int process ( GenEvent hepmc)
virtual

Process event.

Implements ValidationTool.

Definition at line 16 of file OutputValidationTool.cc.

References m_timer, and Timer::start().

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 30 of file OutputValidationTool.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 29 of file OutputValidationTool.h.

Field Documentation

std::string m_filename
private

Used file.

Definition at line 37 of file OutputValidationTool.h.

Timer m_timer
private

Timer.

Definition at line 38 of file OutputValidationTool.h.


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