ana::EventData Class Reference

the list of all container names we put into the event More...

#include <EventData.h>

List of all members.

Public Member Functions

void testInvariant () const
 test the invariant of this object
 EventData ()
 standard constructor
const std::set< ObjectType > & getObjectTypes () const
 get the list of object types available
const std::set
< CP::SystematicSet > & 
getSystematics () const
 get the list of systematics configured
const std::string & getName (ObjectType type, const CP::SystematicSet &sys) const
 get the name of the given collection for the given systematic, or the empty string if that collection is not defined.
void setName (ObjectType type, const CP::SystematicSet &sys, const std::string &val_name)
 set the name returned by getName
std::vector< std::string > getNames (ObjectType type) const
 get the list of all unique names for one object type
const std::string & getSourceName (ObjectType type, const CP::SystematicSet &sys) const
 get the name of the original collection from which the collection returned by getName was copied
void setSourceName (ObjectType type, const CP::SystematicSet &sys, const std::string &val_sourceName)
 set the name returned by getName
std::vector< std::string > getSourceNames (ObjectType type) const
 get the list of all unique source names for one object type

Detailed Description

the list of all container names we put into the event

This is meant to be used in several places:

The interface here is probably going to change: For one thing I want to phase out the ObjectType enum, so this will have to be changed from ObjectType to string at some point in the future. For another, it might be nice to provide a retrieve function as well. Also, I probably need some functions to check which containers and systematics are actually defined. And there may be some changes as well to make this consistent with how xAOD meta-data is used.

For now this is just bolted on to the rest of the QuickAna implementation, but the hope is that I can eventually integrate this more closely into the rest of the implementation, which may require some further changes.


Constructor & Destructor Documentation

ana::EventData::EventData (  ) 

standard constructor

Guarantee
no-fail

Member Function Documentation

const std::string & ana::EventData::getName ( ObjectType  type,
const CP::SystematicSet sys 
) const

get the name of the given collection for the given systematic, or the empty string if that collection is not defined.

Guarantee
strong
Failures
out of memory II
unknown systematic for the given collection
Precondition:
unsigned (type) < EnumSize<ObjectType>::dataSize
std::vector< std::string > ana::EventData::getNames ( ObjectType  type  )  const

get the list of all unique names for one object type

Precondition:
unsigned (type) < EnumSize<ObjectType>::dataSize
const std::set< ObjectType > & ana::EventData::getObjectTypes (  )  const

get the list of object types available

This is a set instead of a bit-map to make it easier to migrate from ObjectType to std::string in the future.

Guarantee
no-fail
const std::string & ana::EventData::getSourceName ( ObjectType  type,
const CP::SystematicSet sys 
) const

get the name of the original collection from which the collection returned by getName was copied

This is for shallow copies only. This is just an empty string if the given collection was not obtained by shallow-copying an input container.

This is meant solely for providing the output tool with all the information it needs. ordinary users should not need to access this information at all.

Guarantee
strong
Failures
out of memory II
unknown systematic for the given collection
Precondition:
unsigned (type) < EnumSize<ObjectType>::dataSize
std::vector< std::string > ana::EventData::getSourceNames ( ObjectType  type  )  const

get the list of all unique source names for one object type

Precondition:
unsigned (type) < EnumSize<ObjectType>::dataSize
const std::set< CP::SystematicSet > & ana::EventData::getSystematics (  )  const

get the list of systematics configured

Guarantee
no-fail
void ana::EventData::setName ( ObjectType  type,
const CP::SystematicSet sys,
const std::string &  val_name 
)

set the name returned by getName

Guarantee
basic
Failures
out of memory II
Precondition:
unsigned (type) < EnumSize<ObjectType>::dataSize
!val_name.empty()
void ana::EventData::setSourceName ( ObjectType  type,
const CP::SystematicSet sys,
const std::string &  val_sourceName 
)

set the name returned by getName

Guarantee
basic
Failures
out of memory II
Precondition:
unsigned (type) < EnumSize<ObjectType>::dataSize
!val_name.empty()
void ana::EventData::testInvariant (  )  const

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