xAOD::EventFormat_v1 Class Reference

#include <EventFormat_v1.h>

List of all members.

Public Types
typedef KeyedData_t::const_iterator	const_iterator
	Iterator for looping over the elements of the object.
Public Member Functions
	EventFormat_v1 ()
	Default constructor.
void	add (const EventFormatElement &element, bool updatePersistent=true)
	Add the description of a new branch.
bool	exists (const std::string &key) const
	Check if a description exists about a given branch.
bool	exists (uint32_t hash) const
	Check if a description exists about a given branch.
const EventFormatElement *	get (const std::string &key, bool quiet=false) const
	Get the description of a given branch.
const EventFormatElement *	get (uint32_t hash, bool quiet=false) const
	Get the description of a given branch.
void	clear ()
	Clear the object.
const_iterator	begin () const
	STL-like function for getting the beginning of the container.
const_iterator	end () const
	STL-like function for getting the end of the container.
void	toTransient ()
	Interpret the persistent members of the object.
void	dump () const
	Dump the contents of this object.

---

Detailed Description

Event format metadata for xAOD files

This class is used to save file-level metadata about the format of xAOD files. It is not meant to be used directly by analysers, but just by the code that they use, behind the scenes.

Author:

Attila Krasznahorkay <Attila.Krasznahorkay@cern.ch>

Revision

641134

Date

2015-01-22 20:35:12 +0100 (Thu, 22 Jan 2015)

---

Member Function Documentation

void xAOD::EventFormat_v1::add	(	const EventFormatElement &	element,
		bool	updatePersistent = true
	)

Add the description of a new branch.

This function can be used to extend the object with a new element.

Parameters:

element

The element to add to the object

bool xAOD::EventFormat_v1::exists

(

uint32_t

hash

)

const

Check if a description exists about a given branch.

Parameters:

hash

Hashed version of the branch name to check

Returns:

true if the branch is knows, false if not

bool xAOD::EventFormat_v1::exists

(

const std::string &

key

)

const

Check if a description exists about a given branch.

Parameters:

key

The name of the branch to check

Returns:

true if the branch is knows, false if not

const EventFormatElement * xAOD::EventFormat_v1::get	(	uint32_t	hash,
		bool	quiet = false
	)			const

Get the description of a given branch.

This function can return the element describing a given branch. Notice that the user code should first check if an element exists, and only use this function if it does.

Parameters:

	hash	The hashed version of the name of the branch
	quiet	If true, silently return 0 if the hash isn't found; otherwise, print an error.

Returns:

A pointer to the element describing the requested branch

const EventFormatElement * xAOD::EventFormat_v1::get	(	const std::string &	key,
		bool	quiet = false
	)			const

Get the description of a given branch.

This function can be used to get access to one element in the object. Notice that the user code should first check if an element exists, and only use this function if it does.

Parameters:

	key	The name of the branch to get the information for
	quiet	If true, silently return 0 if the hash isn't found; otherwise, print an error.

Returns:

A pointer to the element describing the requested branch

---

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

• /cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.28/xAODEventFormat/xAODEventFormat/versions/EventFormat_v1.h
• /cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.28/xAODEventFormat/Root/EventFormat_v1.cxx