ATLAS Offline Software
Public Member Functions | List of all members
ITruthClassificationTool Class Referenceabstract

a tool interface to classify particles into multiple categories based on their truth information More...

#include <ITruthClassificationTool.h>

Inheritance diagram for ITruthClassificationTool:
Collaboration diagram for ITruthClassificationTool:

Public Member Functions

virtual ~ITruthClassificationTool ()=default
 
virtual StatusCode classify (const xAOD::IParticle &particle, unsigned int &classification) const =0
 classify and return unsigned int re-declaration needed due to the same name used More...
 
virtual StatusCode classify (const xAOD::IParticle &particle, Truth::Type &classification) const =0
 classify and return Truth::Type More...
 
virtual void print () const =0
 Print the state of the tool. More...
 

Detailed Description

a tool interface to classify particles into multiple categories based on their truth information

The tools either assignes them an unsigned integer using the base CP::IClassificationTool interface or a Truth::Type enum representing possible truth classification classes.

Definition at line 54 of file ITruthClassificationTool.h.

Constructor & Destructor Documentation

◆ ~ITruthClassificationTool()

virtual ITruthClassificationTool::~ITruthClassificationTool ( )
virtualdefault

Member Function Documentation

◆ classify() [1/2]

virtual StatusCode ITruthClassificationTool::classify ( const xAOD::IParticle particle,
Truth::Type classification 
) const
pure virtual

classify and return Truth::Type

Implemented in TruthClassificationTool.

◆ classify() [2/2]

virtual StatusCode ITruthClassificationTool::classify ( const xAOD::IParticle particle,
unsigned int &  classification 
) const
pure virtual

classify and return unsigned int re-declaration needed due to the same name used

Implements CP::IClassificationTool.

Implemented in TruthClassificationTool.

◆ print()

virtual void asg::IAsgTool::print ( ) const
pure virtualinherited

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