ana::IToolScheduler Class Reference

TODO: needs documentation. More...

#include <IToolScheduler.h>

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

List of all members.

Public Member Functions

StatusCode addTools (const Configuration &conf, InternalConfiguration &internal, const std::string &prefix)
virtual StatusCode addTool (IAnaTool *tool)=0
virtual CP::SystematicSet affectingSystematics () const =0
virtual CP::SystematicSet recommendedSystematics () const =0
virtual StatusCode applySystematicVariation (const CP::SystematicSet &systConfig)=0
virtual StatusCode fillEventObjects (IEventObjects *&object)=0
virtual const std::vector
< CP::SystematicSet > & 
systematics () const =0
 the list of systematics configured
virtual StatusCode setSystematics (const std::vector< CP::SystematicSet > &val_systematics)=0
 set the value of systematics
virtual EventData getEventData () const =0
 make an EventData object describing the objects created

Detailed Description

TODO: needs documentation.


Member Function Documentation

virtual StatusCode ana::IToolScheduler::addTool ( IAnaTool tool  )  [pure virtual]

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

Implemented in ana::OptimizedScheduler, and ana::ToolScheduler.

StatusCode ana::IToolScheduler::addTools ( const Configuration conf,
InternalConfiguration internal,
const std::string &  prefix 
)

effects: add all the tools from the configuration guarantee: basic failures: tool creation errors failures: out of memory III

virtual CP::SystematicSet ana::IToolScheduler::affectingSystematics (  )  const [pure virtual]

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

Implemented in ana::OptimizedScheduler, and ana::ToolScheduler.

virtual StatusCode ana::IToolScheduler::applySystematicVariation ( const CP::SystematicSet systConfig  )  [pure 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

Implemented in ana::OptimizedScheduler, and ana::ToolScheduler.

virtual StatusCode ana::IToolScheduler::fillEventObjects ( IEventObjects *&  object  )  [pure 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

Implemented in ana::OptimizedScheduler, and ana::ToolScheduler.

virtual EventData ana::IToolScheduler::getEventData (  )  const [pure virtual]

make an EventData object describing the objects created

Guarantee
strong
Failures
out of memory II

Implemented in ana::OptimizedScheduler, and ana::ToolScheduler.

virtual CP::SystematicSet ana::IToolScheduler::recommendedSystematics (  )  const [pure virtual]

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

Implemented in ana::OptimizedScheduler, and ana::ToolScheduler.

virtual StatusCode ana::IToolScheduler::setSystematics ( const std::vector< CP::SystematicSet > &  val_systematics  )  [pure virtual]

set the value of systematics

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

Implemented in ana::OptimizedScheduler, and ana::ToolScheduler.

virtual const std::vector<CP::SystematicSet>& ana::IToolScheduler::systematics (  )  const [pure virtual]

the list of systematics configured

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

Implemented in ana::OptimizedScheduler, and ana::ToolScheduler.


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