ATLAS Offline Software
Public Types | Public Member Functions | Private Attributes | List of all members
xAOD::EventFormatElement Class Reference

Class describing one branch of the ROOT file. More...

#include <EventFormatElement.h>

Collaboration diagram for xAOD::EventFormatElement:

Public Types

using sgkey_t = SG::sgkey_t
 

Public Member Functions

 EventFormatElement (const std::string &branchName="", const std::string &className="", const std::string &parentName="", sgkey_t hash=0)
 Constructor with all members specified. More...
 
const std::string & branchName () const
 Get the branch/key name. More...
 
const std::string & className () const
 Get the class name of this branch/key. More...
 
const std::string & parentName () const
 Get the name of the parent auxiliary object. More...
 
sgkey_t hash () const
 Get the hash belonging to this branch/key. More...
 

Private Attributes

std::string m_branchName
 The branch/key name. More...
 
std::string m_className
 The class name belonging to this branch/key. More...
 
std::string m_parentName
 The name of the parent auxiliary object. More...
 
sgkey_t m_hash
 The hash belonging to this branch/key. More...
 

Detailed Description

Class describing one branch of the ROOT file.

This class describes a single, ROOT-readable branch of an xAOD file. It is used to figure out the hash <-> branch name associations, and which auxiliary branches belong to which auxiliary object.

This class doesn't have a "versioned name", as it is not meant to be written to a file directly, it should just be used as a transient means of storing data.

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
568357
Date
2013-11-01 17:21:30 +0100 (Fri, 01 Nov 2013)

Definition at line 39 of file EventFormatElement.h.

Member Typedef Documentation

◆ sgkey_t

Definition at line 42 of file EventFormatElement.h.

Constructor & Destructor Documentation

◆ EventFormatElement()

xAOD::EventFormatElement::EventFormatElement ( const std::string &  branchName = "",
const std::string &  className = "",
const std::string &  parentName = "",
sgkey_t  hash = 0 
)

Constructor with all members specified.

Parameters
branchNameName of the branch that is described by the object
classNameName of the transient class to be used for reading
parentNameName of the parent auxiliary object
hashA hashed version of the branch name

Definition at line 20 of file EventFormatElement.cxx.

26 
27  }

Member Function Documentation

◆ branchName()

const std::string & xAOD::EventFormatElement::branchName ( ) const

Get the branch/key name.

Returns
The name of the branch that this object describes

Definition at line 30 of file EventFormatElement.cxx.

30  {
31 
32  return m_branchName;
33  }

◆ className()

const std::string & xAOD::EventFormatElement::className ( ) const

Get the class name of this branch/key.

Returns
The name of the transient class to be read from the branch

Definition at line 36 of file EventFormatElement.cxx.

36  {
37 
38  return m_className;
39  }

◆ hash()

EventFormatElement::sgkey_t xAOD::EventFormatElement::hash ( ) const

Get the hash belonging to this branch/key.

Returns
A hashed version of the branch's name

Definition at line 48 of file EventFormatElement.cxx.

48  {
49 
50  return m_hash;
51  }

◆ parentName()

const std::string & xAOD::EventFormatElement::parentName ( ) const

Get the name of the parent auxiliary object.

Returns
The name of the parent auxiliary class (or "" if there is none)

Definition at line 42 of file EventFormatElement.cxx.

42  {
43 
44  return m_parentName;
45  }

Member Data Documentation

◆ m_branchName

std::string xAOD::EventFormatElement::m_branchName
private

The branch/key name.

Definition at line 61 of file EventFormatElement.h.

◆ m_className

std::string xAOD::EventFormatElement::m_className
private

The class name belonging to this branch/key.

Definition at line 63 of file EventFormatElement.h.

◆ m_hash

sgkey_t xAOD::EventFormatElement::m_hash
private

The hash belonging to this branch/key.

Definition at line 67 of file EventFormatElement.h.

◆ m_parentName

std::string xAOD::EventFormatElement::m_parentName
private

The name of the parent auxiliary object.

Definition at line 65 of file EventFormatElement.h.


The documentation for this class was generated from the following files:
xAOD::EventFormatElement::parentName
const std::string & parentName() const
Get the name of the parent auxiliary object.
Definition: EventFormatElement.cxx:42
xAOD::EventFormatElement::branchName
const std::string & branchName() const
Get the branch/key name.
Definition: EventFormatElement.cxx:30
xAOD::EventFormatElement::m_className
std::string m_className
The class name belonging to this branch/key.
Definition: EventFormatElement.h:63
xAOD::EventFormatElement::m_parentName
std::string m_parentName
The name of the parent auxiliary object.
Definition: EventFormatElement.h:65
xAOD::EventFormatElement::hash
sgkey_t hash() const
Get the hash belonging to this branch/key.
Definition: EventFormatElement.cxx:48
xAOD::EventFormatElement::className
const std::string & className() const
Get the class name of this branch/key.
Definition: EventFormatElement.cxx:36
xAOD::EventFormatElement::m_branchName
std::string m_branchName
The branch/key name.
Definition: EventFormatElement.h:61
xAOD::EventFormatElement::m_hash
sgkey_t m_hash
The hash belonging to this branch/key.
Definition: EventFormatElement.h:67