Event format metadata for xAOD files. More...

#include <EventFormat_v1.h>

Collaboration diagram for xAOD::EventFormat_v1:

Public Types
typedef KeyedData_t::const_iterator	const_iterator
	Iterator for looping over the elements of the object. More...

Public Member Functions
	EventFormat_v1 ()
	Default constructor. More...

void	add (const EventFormatElement &element, bool updatePersistent=true)
	Add the description of a new branch. More...

bool	exists (const std::string &key) const
	Check if a description exists about a given branch. More...

bool	exists (uint32_t hash) const
	Check if a description exists about a given branch. More...

const EventFormatElement *	get (const std::string &key, bool quiet=false) const
	Get the description of a given branch. More...

const EventFormatElement *	get (uint32_t hash, bool quiet=false) const
	Get the description of a given branch. More...

void	clear ()
	Clear the object. More...

const_iterator	begin () const
	STL-like function for getting the beginning of the container. More...

const_iterator	end () const
	STL-like function for getting the end of the container. More...

void	toTransient ()
	Interpret the persistent members of the object. More...

void	dump () const
	Dump the contents of this object. More...

Private Types
typedef std::map< std::string, EventFormatElement >	KeyedData_t
	Type of the key->data in-memory object. More...

typedef std::map< uint32_t, EventFormatElement >	HashedData_t
	Type of the hash->data in-memory object. More...

Private Attributes
KeyedData_t	m_keyedData
	Object associating string keys with the descriptions. More...

HashedData_t	m_hashedData
	Object associating hash keys with the descriptions. More...

std::vector< std::string >	m_branchNames
	Names of the branches that we are describing. More...

std::vector< std::string >	m_classNames
	Names of the transient objects belonging to the branch names. More...

std::vector< std::string >	m_parentNames
	Names of the auxiliary parents of the branches. More...

std::vector< uint32_t >	m_branchHashes
	Hashed versions of the branch names. More...

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 Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Revision: 641134

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

Definition at line 38 of file EventFormat_v1.h.

Member Typedef Documentation

◆ const_iterator

typedef KeyedData_t::const_iterator xAOD::EventFormat_v1::const_iterator

Iterator for looping over the elements of the object.

Definition at line 67 of file EventFormat_v1.h.

◆ HashedData_t

typedef std::map< uint32_t, EventFormatElement > xAOD::EventFormat_v1::HashedData_t

private

Type of the hash->data in-memory object.

Definition at line 43 of file EventFormat_v1.h.

◆ KeyedData_t

typedef std::map< std::string, EventFormatElement > xAOD::EventFormat_v1::KeyedData_t

private

Type of the key->data in-memory object.

Definition at line 41 of file EventFormat_v1.h.

Constructor & Destructor Documentation

◆ EventFormat_v1()

xAOD::EventFormat_v1::EventFormat_v1 ( )

Default constructor.

Definition at line 35 of file EventFormat_v1.cxx.

       : m_keyedData(), m_hashedData() {
  
    }

Member Function Documentation

◆ add()

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

Definition at line 43 of file EventFormat_v1.cxx.

                                                      {
  
       // Set the transient-only variables:
       m_keyedData[ element.branchName() ] = element;
       m_hashedData[ element.hash() ]      = element;
  
       // Set the persistent variables:
       if( updatePersistent ) {
          m_branchNames.push_back( element.branchName() );
          m_classNames.push_back( element.className() );
          m_parentNames.push_back( element.parentName() );
          m_branchHashes.push_back( element.hash() );
       }
       return;
    }

◆ begin()

EventFormat_v1::const_iterator xAOD::EventFormat_v1::begin ( ) const

STL-like function for getting the beginning of the container.

Definition at line 158 of file EventFormat_v1.cxx.

                                                             {
  
       return m_keyedData.begin();
    }

◆ clear()

void xAOD::EventFormat_v1::clear ( )

Clear the object.

Definition at line 144 of file EventFormat_v1.cxx.

                               {
  
       // Clear the transient variables:
       m_keyedData.clear();
       m_hashedData.clear();
  
       // Clear the persistent variables:
       m_branchNames.clear();
       m_classNames.clear();
       m_parentNames.clear();
       m_branchHashes.clear();
       return;
    }

◆ dump()

void xAOD::EventFormat_v1::dump ( ) const

Dump the contents of this object.

Definition at line 223 of file EventFormat_v1.cxx.

    {
      std::cout << *this;
    }

◆ end()

EventFormat_v1::const_iterator xAOD::EventFormat_v1::end ( ) const

STL-like function for getting the end of the container.

Definition at line 163 of file EventFormat_v1.cxx.

                                                           {
  
       return m_keyedData.end();
    }

◆ exists() [1/2]

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

Definition at line 65 of file EventFormat_v1.cxx.

                                                            {
  
       return ( m_keyedData.find( key ) != m_keyedData.end() );
    }

◆ exists() [2/2]

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

Definition at line 75 of file EventFormat_v1.cxx.

                                                     {
  
       return ( m_hashedData.find( hash ) != m_hashedData.end() );
    }

◆ get() [1/2]

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

Definition at line 91 of file EventFormat_v1.cxx.

                                                                {
  
       KeyedData_t::const_iterator itr = m_keyedData.find( key );
       if( itr == m_keyedData.end() ) {
          if (!quiet) {
            std::cerr << "<xAOD::EventFormat_v1::get>"
                      << " Information requested about unknown branch ("
                      << key << ")" << std::endl;
          }
          return nullptr;
       }
  
       return &( itr->second );
    }

◆ get() [2/2]

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

Definition at line 116 of file EventFormat_v1.cxx.

                                                                                    {
  
       HashedData_t::const_iterator itr = m_hashedData.find( hash );
       if( itr == m_hashedData.end() ) {
          if (!quiet) {
            // Get the current state of the stream:
            const char fillChar = std::cerr.fill();
            const std::ios_base::fmtflags flags = std::cerr.flags();
            const std::streamsize width = std::cerr.width();
  
            // Do the printout:
            std::cerr << "<xAOD::EventFormat_v1::get>"
                      << " Information requested about unknown hash ("
                      << std::setw( 8 ) << std::hex << std::setfill( '0' )
                      << hash << ")" << std::endl;
  
            // Restore the original state of the stream:
            std::cerr.fill( fillChar );
            std::cerr.flags( flags );
            std::cerr.width( width );
          }
  
          return nullptr;
       }
  
       return &( itr->second );
    }

◆ toTransient()

void xAOD::EventFormat_v1::toTransient ( )

Interpret the persistent members of the object.

Definition at line 168 of file EventFormat_v1.cxx.

                                     {
  
       // Clear the transient variables:
       m_keyedData.clear();
       m_hashedData.clear();
  
       // A little sanity check:
       if( ( m_branchNames.size() != m_classNames.size() ) ||
           ( m_branchNames.size() != m_parentNames.size() ) ||
           ( m_branchNames.size() != m_branchHashes.size() ) ) {
          std::cerr << "<xAOD::EventFormat_v1::toTransient> "
                    << "Internal inconsistency in the persistent data"
                    << std::endl;
          std::cerr << "  m_branchNames  = " << m_branchNames << std::endl;
          std::cerr << "  m_classNames   = " << m_classNames << std::endl;
          std::cerr << "  m_parentNames  = " << m_parentNames << std::endl;
          std::cerr << "  m_branchHashes = " << m_branchHashes << std::endl;
          return;
       }
  
       // Set up the transient variables:
       for( size_t i = 0; i < m_branchNames.size(); ++i ) {
          add( EventFormatElement( m_branchNames[ i ],
                                   m_classNames[ i ],
                                   m_parentNames[ i ],
                                   m_branchHashes[ i ] ),
               false );
       }
  
       return;
    }

Member Data Documentation

◆ m_branchHashes

std::vector< uint32_t > xAOD::EventFormat_v1::m_branchHashes

private

Hashed versions of the branch names.

Definition at line 92 of file EventFormat_v1.h.

◆ m_branchNames

std::vector< std::string > xAOD::EventFormat_v1::m_branchNames

private

Names of the branches that we are describing.

Definition at line 86 of file EventFormat_v1.h.

◆ m_classNames

std::vector< std::string > xAOD::EventFormat_v1::m_classNames

private

Names of the transient objects belonging to the branch names.

Definition at line 88 of file EventFormat_v1.h.

◆ m_hashedData

HashedData_t xAOD::EventFormat_v1::m_hashedData

private

Object associating hash keys with the descriptions.

Definition at line 83 of file EventFormat_v1.h.

◆ m_keyedData

KeyedData_t xAOD::EventFormat_v1::m_keyedData

private

Object associating string keys with the descriptions.

Definition at line 81 of file EventFormat_v1.h.

◆ m_parentNames

std::vector< std::string > xAOD::EventFormat_v1::m_parentNames

private

Names of the auxiliary parents of the branches.

Definition at line 90 of file EventFormat_v1.h.

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

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ HashedData_t

◆ KeyedData_t

Constructor & Destructor Documentation

◆ EventFormat_v1()

Member Function Documentation

◆ add()

◆ begin()

◆ clear()

◆ dump()

◆ end()

◆ exists() [1/2]

◆ exists() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ toTransient()

Member Data Documentation

◆ m_branchHashes

◆ m_branchNames

◆ m_classNames

◆ m_hashedData

◆ m_keyedData

◆ m_parentNames