ana::OptimizedScheduler Class Reference

#include <OptimizedScheduler.h>

Inheritance diagram for ana::OptimizedScheduler:
ana::IToolScheduler asg::AsgTool asg::IAsgTool asg::IAsgTool

List of all members.

Public Member Functions

void testInvariant () const
 OptimizedScheduler (const std::string &name)
 ~OptimizedScheduler ()
 standard destructor
virtual StatusCode initialize () override
virtual StatusCode addTool (IAnaTool *tool) override
virtual CP::SystematicSet affectingSystematics () const override
virtual CP::SystematicSet recommendedSystematics () const override
virtual StatusCode applySystematicVariation (const CP::SystematicSet &systConfig) override
virtual StatusCode fillEventObjects (IEventObjects *&object) override
virtual const std::vector
< CP::SystematicSet > & 
systematics () const override
 the list of systematics configured
virtual StatusCode setSystematics (const std::vector< CP::SystematicSet > &val_systematics) override
 set the value of systematics
virtual EventData getEventData () const override
 make an EventData object describing the objects created

Detailed Description

The optimized tool scheduler.

Holds and manages the OptimizedStore and the OptimizedTools.


Constructor & Destructor Documentation

ana::OptimizedScheduler::OptimizedScheduler ( const std::string &  name  ) 

effects: standard constructor guarantee: strong failures: out of memory II

ana::OptimizedScheduler::~OptimizedScheduler (  ) 

standard destructor

I defined my own destructor to break include file dependencies in Athena

Guarantee
no-fail

Member Function Documentation

StatusCode ana::OptimizedScheduler::addTool ( IAnaTool tool  )  [override, virtual]

effects: add another tool to the scheduler guarantee: strong failures: out of memory I

Implements ana::IToolScheduler.

CP::SystematicSet ana::OptimizedScheduler::affectingSystematics (  )  const [override, virtual]

returns: the list of all systematics the tools can be affected by guarantee: strong failures: out of memory II

Implements ana::IToolScheduler.

StatusCode ana::OptimizedScheduler::applySystematicVariation ( const CP::SystematicSet systConfig  )  [override, virtual]

effects: configure this tool for the given list of systematic variations. any requested systematics that are not affecting this tool will be silently ignored (unless they cause other errors). guarantee: basic failures: tool specific

Implements ana::IToolScheduler.

StatusCode ana::OptimizedScheduler::fillEventObjects ( IEventObjects *&  object  )  [override, virtual]

effects: fill the event objects structure with the fully corrected objects for the current systematics guarantee: basic failures: tool specific warning: this should only be called once per event

Implements ana::IToolScheduler.

EventData ana::OptimizedScheduler::getEventData (  )  const [override, virtual]

make an EventData object describing the objects created

Guarantee
strong
Failures
out of memory II

Implements ana::IToolScheduler.

StatusCode ana::OptimizedScheduler::initialize ( void   )  [override, virtual]

Dummy implementation of the initialisation function

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

CP::SystematicSet ana::OptimizedScheduler::recommendedSystematics (  )  const [override, virtual]

returns: the list of all systematics the tools recommend to use guarantee: strong failures: out of memory II

Implements ana::IToolScheduler.

StatusCode ana::OptimizedScheduler::setSystematics ( const std::vector< CP::SystematicSet > &  val_systematics  )  [override, virtual]

set the value of systematics

Guarantee
basic
Failures
systematics configuration error
Precondition:
initialize() has been called

Implements ana::IToolScheduler.

const std::vector< CP::SystematicSet > & ana::OptimizedScheduler::systematics (  )  const [override, virtual]

the list of systematics configured

Guarantee
no-fail
Precondition:
initialize() has been called

Implements ana::IToolScheduler.

void ana::OptimizedScheduler::testInvariant (  )  const

effects: test the invariant of this object guarantee: no-fail


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 1 Dec 2017 for RootCore Packages by  doxygen 1.6.1