ana::AnaToolRetrieve Class Reference

The tool class implementing basic object retrieval. More...

#include <AnaToolRetrieve.h>

Inheritance diagram for ana::AnaToolRetrieve:
ana::IAnaTool ana::AnaTool CP::ISystematicsTool ana::IAnaTool asg::AsgTool asg::IAsgTool CP::ISystematicsTool asg::IAsgTool asg::IAsgTool

List of all members.

Public Member Functions

 AnaToolRetrieve (const std::string &name)
 standard constructor
 AnaToolRetrieve (const std::string &name, const std::string &containerName)
 initializing constructor
virtual StatusCode setObjectType (ObjectType type, const std::string &workingPoint) override
 set the object type to work on
virtual AnalysisStep step () const override
 the processing step we are working on
virtual unsigned inputTypes () const override
 a bit-map indicating which object types we use
virtual unsigned outputTypes () const override
 a bit-map indicating which output types we will create
virtual void fillEventDataSource (EventData &event) const override
 fill the source component of the EventData
virtual StatusCode execute (IEventObjects &objects) override
 apply this analysis tool to the objects
virtual StatusCode getInitialConfiguration (InternalConfiguration &conf) override
 fill the initial configuration before initialize

Public Attributes

std::string m_containerName

Detailed Description

The tool class implementing basic object retrieval.


Constructor & Destructor Documentation

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

standard constructor

Guarantee
strong
Failures
out of memory II
ana::AnaToolRetrieve::AnaToolRetrieve ( const std::string &  name,
const std::string &  containerName 
)

initializing constructor

Guarantee
strong
Failures
out of memory II

Member Function Documentation

StatusCode ana::AnaToolRetrieve::execute ( IEventObjects objects  )  [override, virtual]

apply this analysis tool to the objects

Parameters:
objects the objects to apply this too
Guarantee
basic
Failures
tool dependent

Implements ana::IAnaTool.

void ana::AnaToolRetrieve::fillEventDataSource ( EventData event  )  const [override, virtual]

fill the source component of the EventData

This is meant to be implemented by the retrieval tools that perform the shallow copy to document what they do. All other tools can safely ignore this.

Guarantee
basic
Failures
out of memory II

Reimplemented from ana::AnaTool.

StatusCode ana::AnaToolRetrieve::getInitialConfiguration ( InternalConfiguration conf  )  [override, virtual]

fill the initial configuration before initialize

this is mostly used so that retrieval tools can broadcast the input collections they are using

Guarantee
basic
Failures
tool dependent

Reimplemented from ana::AnaTool.

unsigned ana::AnaToolRetrieve::inputTypes (  )  const [override, virtual]

a bit-map indicating which object types we use

Guarantee
no-fail

Implements ana::IAnaTool.

unsigned ana::AnaToolRetrieve::outputTypes (  )  const [override, virtual]

a bit-map indicating which output types we will create

Guarantee
no-fail

Implements ana::IAnaTool.

StatusCode ana::AnaToolRetrieve::setObjectType ( ObjectType  type,
const std::string &  workingPoint 
) [override, virtual]

set the object type to work on

this is called straight after the tool is created and before it is initialized. the primary reason for this function is to allow jet definitions to be used for either jets or fat jets.

Parameters:
type the object type we work on
workingPoint the name of the working point we are working on or the empty string if this is a sole working point or working points do not apply
Guarantee
strong
Failures
unsupported object type this interface may change when I introduce multiple simultaneous working points

Implements ana::IAnaTool.

AnalysisStep ana::AnaToolRetrieve::step (  )  const [override, virtual]

the processing step we are working on

Guarantee
no-fail

Implements ana::IAnaTool.


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