ana::OptimizedTool Class Reference

#include <OptimizedTool.h>

Inheritance diagram for ana::OptimizedTool:

List of all members.

Public Member Functions
void	testInvariant () const
	test the invariant of this object
	OptimizedTool (std::unique_ptr< IAnaTool > val_tool)
	initializing constructor
	~OptimizedTool ()
	standard destructor
std::string	name () const
	the name of this tool
AnalysisStep	step () const
	the step of this tool
CP::SystematicSet	affectingSystematics () const
	the list of all systematics this tool can be affected by
CP::SystematicSet	recommendedSystematics () const
	the list of all systematics this tool recommends to use
StatusCode	execute ()
	apply this analysis tool to the objects
void	fillEventDataSource (EventData &event) const
	call IAnaTool::fillEventDataSource
bool	hasDirectInput (const OptimizedTool &input) const noexcept
	whether we use the tool directly, i.e. whether it has an output that is one of our inputs and is executed on an earlier step
bool	hasOutput (const OptimizedTool *that) const noexcept
	whether the given tool has been registered via addOutput as using the output of his tool directly or indirectly
void	addOutput (OptimizedTool *output)
	register the given tool as using the output of this tool as an input
StatusCode	configureSystematics (OptimizedStore *store)
	configure this wrapper for the given target set of systematics

---

Detailed Description

Holds tool and meta-information for the optimized scheduler.

---

Constructor & Destructor Documentation

ana::OptimizedTool::OptimizedTool

(

std::unique_ptr< IAnaTool >

val_tool

)

initializing constructor

Guarantee

strong

Failures

out of memory I

ana::OptimizedTool::~OptimizedTool

(

)

standard destructor

explicit destructor to reduce number of header file includes

Guarantee

no-fail

---

Member Function Documentation

void ana::OptimizedTool::addOutput

(

OptimizedTool *

output

)

register the given tool as using the output of this tool as an input

Guarantee

basic

Failures

out of memory II

CP::SystematicSet ana::OptimizedTool::affectingSystematics

(

)

const

the list of all systematics this tool can be affected by

Guarantee

strong

Failures

out of memory II

StatusCode ana::OptimizedTool::configureSystematics

(

OptimizedStore *

store

)

configure this wrapper for the given target set of systematics

Guarantee

basic

Failures

out of memory II

StatusCode ana::OptimizedTool::execute

(

)

apply this analysis tool to the objects

Parameters:

objects

the objects to apply this too

Guarantee

basic

Failures

tool dependent

void ana::OptimizedTool::fillEventDataSource

(

EventData &

event

)

const

call IAnaTool::fillEventDataSource

Guarantee

basic

Failures

out of memory II

bool ana::OptimizedTool::hasDirectInput

(

const OptimizedTool &

input

)

const

whether we use the tool directly, i.e. whether it has an output that is one of our inputs and is executed on an earlier step

Guarantee

no-fail

bool ana::OptimizedTool::hasOutput

(

const OptimizedTool *

that

)

const

whether the given tool has been registered via addOutput as using the output of his tool directly or indirectly

Guarantee

no-fail

std::string ana::OptimizedTool::name

(

)

const

the name of this tool

Guarantee

strong

Failures

out of memory II

CP::SystematicSet ana::OptimizedTool::recommendedSystematics

(

)

const

the list of all systematics this tool recommends to use

Guarantee

strong

Failures

out of memory II

AnalysisStep ana::OptimizedTool::step

(

)

const

the step of this tool

Guarantee

no-fail

void ana::OptimizedTool::testInvariant

(

)

const

test the invariant of this object

Guarantee

no-fail

---

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

• /cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.28/QuickAna/QuickAna/OptimizedTool.h
• /cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.28/QuickAna/Root/OptimizedTool.cxx