ATLAS Offline Software
Public Member Functions | Private Member Functions | Private Attributes | List of all members
xAOD::TFileChecker Class Reference

Tool for running sanity checks on xAOD files. More...

#include <TFileChecker.h>

Inheritance diagram for xAOD::TFileChecker:
Collaboration diagram for xAOD::TFileChecker:

Public Member Functions

 TFileChecker ()
 Default constructor. More...
 
StatusCode check (TEvent &event)
 Execute all sanity checks on a given file. More...
 
void setStopOnError (::Bool_t value)
 Set whether the validation should stop when an error is found. More...
 
::Bool_t stopOnError () const
 Check whether the validation will stop when an error is found. More...
 
void addIgnoredVariable (const std::string &name)
 Add a variable to be ignored in the test. More...
 
void setIgnoredVariables (const std::set< std::string > &value)
 Set the list of variables to be ignored in the test. More...
 
const std::set< std::string > & ignoredVariables () const
 Get the list of variables which are ignored in the test. More...
 

Private Member Functions

StatusCode checkContainer (const SG::AuxVectorBase &vec, const std::string &name)
 Check the health of a container. More...
 

Private Attributes

::Bool_t m_stopOnError
 Stop the validation when an issue is found? More...
 
std::set< std::string > m_ignoredVariables
 List of variables to ignore in the test. More...
 
std::set< std::string > m_orpannedContainers
 List of containers without an auxiliary store. More...
 

Detailed Description

Tool for running sanity checks on xAOD files.

There are some typical issues that can show up in xAOD files due to common coding issues in the reconstruction/analysis code. This class can check for most of these issues in the file given to it.

Author
Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 39 of file TFileChecker.h.

Constructor & Destructor Documentation

◆ TFileChecker()

xAOD::TFileChecker::TFileChecker ( )

Default constructor.

Member Function Documentation

◆ addIgnoredVariable()

void xAOD::TFileChecker::addIgnoredVariable ( const std::string &  name)

Add a variable to be ignored in the test.

◆ check()

StatusCode xAOD::TFileChecker::check ( TEvent event)

Execute all sanity checks on a given file.

◆ checkContainer()

StatusCode xAOD::TFileChecker::checkContainer ( const SG::AuxVectorBase vec,
const std::string &  name 
)
private

Check the health of a container.

◆ ignoredVariables()

const std::set< std::string >& xAOD::TFileChecker::ignoredVariables ( ) const

Get the list of variables which are ignored in the test.

◆ setIgnoredVariables()

void xAOD::TFileChecker::setIgnoredVariables ( const std::set< std::string > &  value)

Set the list of variables to be ignored in the test.

◆ setStopOnError()

void xAOD::TFileChecker::setStopOnError ( ::Bool_t  value)

Set whether the validation should stop when an error is found.

◆ stopOnError()

::Bool_t xAOD::TFileChecker::stopOnError ( ) const

Check whether the validation will stop when an error is found.

Member Data Documentation

◆ m_ignoredVariables

std::set< std::string > xAOD::TFileChecker::m_ignoredVariables
private

List of variables to ignore in the test.

Definition at line 68 of file TFileChecker.h.

◆ m_orpannedContainers

std::set< std::string > xAOD::TFileChecker::m_orpannedContainers
private

List of containers without an auxiliary store.

Definition at line 71 of file TFileChecker.h.

◆ m_stopOnError

::Bool_t xAOD::TFileChecker::m_stopOnError
private

Stop the validation when an issue is found?

Definition at line 66 of file TFileChecker.h.


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