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

Class holding file-level metadata about an xAOD file. More...

#include <FileMetaData_v1.h>

Inheritance diagram for xAOD::FileMetaData_v1:
Collaboration diagram for xAOD::FileMetaData_v1:

Public Types

enum  MetaDataType {
  productionRelease = 0, amiTag = 1, AODFixVersion = 2, AODCalibVersion = 3,
  dataType = 4, geometryVersion = 5, conditionsTag = 6, beamEnergy = 7,
  beamType = 8, mcProcID = 9, simFlavour = 10, isDataOverlay = 11,
  mcCampaign = 12, generatorsInfo = 13, dataYear = 14, END = 15
}
 Pre-defined metadata value types. More...
 
using TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor
 
template<class T , class ALLOC = AuxAllocator_t<T>>
using ConstAccessor = SG::ConstAccessor< T, ALLOC >
 
template<class T , class ALLOC = AuxAllocator_t<T>>
using Accessor = SG::Accessor< T, ALLOC >
 
template<class T , class ALLOC = AuxAllocator_t<T>>
using Decorator = SG::Decorator< T, ALLOC >
 

Public Member Functions

 FileMetaData_v1 ()
 Default constructor. More...
 
bool value (MetaDataType type, std::string &val) const
 Get a pre-defined string value out of the object. More...
 
bool value (const std::string &type, std::string &val) const
 Get a generic string value out of the object. More...
 
bool setValue (MetaDataType type, const std::string &val)
 Set a pre-defined string value on the object. More...
 
bool setValue (const std::string &type, const std::string &val)
 Set a generic string value on the object. More...
 
bool value (MetaDataType type, uint32_t &val) const
 Get a pre-defined uint32_t value out of the object. More...
 
bool value (const std::string &type, uint32_t &val) const
 Get a generic uint32_t value out of the object. More...
 
bool setValue (MetaDataType type, uint32_t val)
 Set a pre-defined uint32_t value on the object. More...
 
bool setValue (const std::string &type, uint32_t val)
 Set a generic uint32_t value on the object. More...
 
bool value (MetaDataType type, float &val) const
 Get a pre-defined float value out of the object. More...
 
bool value (const std::string &type, float &val) const
 Get a generic float value out of the object. More...
 
bool setValue (MetaDataType type, float val)
 Set a pre-defined float value on the object. More...
 
bool setValue (const std::string &type, float val)
 Set a generic float value on the object. More...
 
bool value (MetaDataType type, bool &val) const
 Get a pre-defined bool value out of the object. More...
 
bool value (const std::string &type, bool &val) const
 Get a generic bool value out of the object. More...
 
bool setValue (MetaDataType type, bool val)
 Set a pre-defined bool value on the object. More...
 
bool setValue (const std::string &type, bool val)
 Set a generic bool value on the object. More...
 
bool value (const std::string &type, std::vector< uint32_t > &val) const
 Get a generic list value out of the object. More...
 
bool setValue (const std::string &type, const std::vector< uint32_t > &val)
 Set a generic list value on the object. More...
 
void assign (const AuxElement &other, bool warnUnlocked=false)
 Assignment. More...
 
const SG::AuxVectorDatacontainer () const
 Return the container holding this element. More...
 
SG::AuxVectorDatacontainer ()
 Return the container holding this element. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type auxdata (const std::string &name)
 Fetch an aux data variable, as a non-const reference. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type auxdata (const std::string &name, const std::string &clsname)
 Fetch an aux data variable, as a non-const reference. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type auxdata (const std::string &name) const
 Fetch an aux data variable, as a const reference. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type auxdata (const std::string &name, const std::string &clsname) const
 Fetch an aux data variable, as a const reference. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type auxdataConst (const std::string &name) const
 Fetch an aux data variable, as a const reference. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type auxdataConst (const std::string &name, const std::string &clsname) const
 Fetch an aux data variable, as a const reference. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool isAvailable (const std::string &name, const std::string &clsname="") const
 Check if an aux variable is available for reading. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool isAvailableWritable (const std::string &name, const std::string &clsname="")
 Check if an aux variable is available for writing. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
 Check if an aux variable is available for writing as a decoration. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type auxdecor (const std::string &name) const
 Fetch an aux decoration, as a non-const reference. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type auxdecor (const std::string &name, const std::string &clsname) const
 Fetch an aux decoration, as a non-const reference. More...
 
void makePrivateStore ()
 Create a new (empty) private store for this object. More...
 
template<class U1 >
void makePrivateStore (const U1 &other, bool warnUnlocked=false)
 Create a new private store for this object and copy aux data. More...
 
template<class U1 >
void makePrivateStore (const U1 *other, bool warnUnlocked=false)
 Create a new private store for this object and copy aux data. More...
 
void releasePrivateStore ()
 Release and free any private store associated with this object. More...
 
void setStore (const SG::IConstAuxStore *store)
 Set the store associated with this object. More...
 
void setStore (SG::IAuxStore *store)
 Set the store associated with this object. More...
 
void setStore (const DataLink< SG::IConstAuxStore > &store)
 Set the store associated with this object. More...
 
void setConstStore (const SG::IConstAuxStore *store)
 Synonym for setStore with IConstAuxStore. More...
 
void setNonConstStore (SG::IAuxStore *store)
 Synonym for setStore with IAuxStore. More...
 
bool usingPrivateStore () const
 Test to see if this object is currently using a private store. More...
 
bool usingStandaloneStore () const
 Test to see if this object is currently using a standalone store. More...
 
const SG::IConstAuxStoregetConstStore () const
 Return the current store, as a const interface. More...
 
SG::IAuxStoregetStore () const
 Return the current store, as a non-const interface. More...
 
void clearCache ()
 Clear the cached aux data pointers. More...
 
const SG::auxid_set_tgetAuxIDs () const
 Return a set of identifiers for existing data items for this object. More...
 
const SG::auxid_set_tgetDecorIDs () const
 Return a set of identifiers for decorations for this object. More...
 
bool hasStore () const
 Return true if this object has an associated store. More...
 
bool hasNonConstStore () const
 Return true if this object has an associated non-const store. More...
 
bool clearDecorations () const
 Clear all decorations. More...
 
bool trackIndices () const
 Return true if index tracking is enabled for this object. More...
 
size_t index () const
 Return the index of this element within its container. More...
 
size_t index () const
 Return the index of this element within its container. More...
 
Comparison operators
bool operator== (const FileMetaData_v1 &rhs) const
 Operator testing the equality of two objects. More...
 
bool operator!= (const FileMetaData_v1 &rhs) const
 Operator testing the inequality of two objects. More...
 
bool compareWith (const FileMetaData_v1 &rhs, const std::set< std::string > &ignore) const
 Compare this FMD object with another, optionally ignoring some attributes. More...
 

Static Public Attributes

static constexpr bool supportsThinning = true
 Mark that this type supports thinning operations. More...
 

Protected Member Functions

bool noPrivateData () const
 True if this element has no private data. More...
 
bool havePrivateData () const
 True if this element currently has private data. More...
 
bool hadPrivateData () const
 True if this element had private data before it was added to its current container. More...
 

Private Types

enum  PrivateStoreState : uint8_t { PrivateStoreState::NO_PRIVATE = 0, PrivateStoreState::HAVE_PRIVATE = 1, PrivateStoreState::HAD_PRIVATE = 2 }
 The current private data state. More...
 

Private Member Functions

void releasePrivateStoreForDtor ()
 Out-of-line portion of destructor. More...
 
void setIndex (size_t index, SG::AuxVectorData *container)
 Set the index/container for this element. More...
 
bool setIndexPrivate (size_t index, SG::AuxVectorData *container)
 Set the index/container for this element. More...
 
void makePrivateStore1 (const void *other, bool warnUnlocked)
 Create a new private store for this object and copy aux data. More...
 
void makePrivateStore1 (const AuxElement *other, bool warnUnlocked)
 Create a new private store for this object and copy aux data. More...
 
AuxElementStandaloneData * setStore1 (const SG::IConstAuxStore *store)
 Set the store associated with this object. More...
 
void clearAux ()
 Clear all aux data associated with this element. More...
 
void copyAux (const ConstAuxElement &other, bool warnUnlocked=false)
 Copy aux data from another object. More...
 
void setNoPrivateData ()
 Record that this element does not have private data. More...
 
void setHavePrivateData ()
 Record that this element currently has private data. More...
 
void setHadPrivateData ()
 Record that this element used to have private data. More...
 

Private Attributes

const SG::AuxVectorDatam_container
 The container of which this object is an element. More...
 
size_t m_index
 The index of this element within its container. More...
 
PrivateStoreState m_privateStoreState
 

Detailed Description

Class holding file-level metadata about an xAOD file.

Each xAOD file is expected to hold exactly one object of this type to describe much of the simple metadata about the file. So, metadata that might change event-by-event in the file is not stored in such objects.

Parameters
AttilaKrasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h
Revision
685184
Date
2015-07-23 22:25:43 +0200 (Thu, 23 Jul 2015)

Definition at line 34 of file FileMetaData_v1.h.

Member Typedef Documentation

◆ Accessor

template<class T , class ALLOC = AuxAllocator_t<T>>
using SG::AuxElement::Accessor = SG::Accessor<T, ALLOC>
inherited

Definition at line 572 of file AuxElement.h.

◆ ConstAccessor

template<class T , class ALLOC = AuxAllocator_t<T>>
using SG::AuxElement::ConstAccessor = SG::ConstAccessor<T, ALLOC>
inherited

Definition at line 569 of file AuxElement.h.

◆ Decorator

template<class T , class ALLOC = AuxAllocator_t<T>>
using SG::AuxElement::Decorator = SG::Decorator<T, ALLOC>
inherited

Definition at line 575 of file AuxElement.h.

◆ TypelessConstAccessor

using SG::AuxElement::TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor
inherited

Definition at line 566 of file AuxElement.h.

Member Enumeration Documentation

◆ MetaDataType

Pre-defined metadata value types.

Enumerator
productionRelease 

Release that was used to make the file [string].

amiTag 

AMI tag used to process the file the last time [string].

AODFixVersion 

Version of AODFix that was used on the file last [string].

AODCalibVersion 

Version of AODCalib that was used on the file last [string].

dataType 

Data type that's in the file [string].

geometryVersion 

Geometry version [string].

conditionsTag 

Conditions version used for simulation/reconstruction [string].

beamEnergy 

Beam energy [float].

beamType 

Beam type [string].

mcProcID 

Same as mc_channel_number [float].

simFlavour 

Fast or Full sim [string].

isDataOverlay 

Used data overlay for backgrounds [bool].

mcCampaign 

MC campaign [string].

generatorsInfo 

Generators information [string].

dataYear 

Data year [uint32_t].

END 

End marker.

Definition at line 54 of file FileMetaData_v1.h.

54  {
58  amiTag = 1,
60  AODFixVersion = 2,
62  AODCalibVersion = 3,
64  dataType = 4,
66  geometryVersion = 5,
68  conditionsTag = 6,
70  beamEnergy = 7,
72  beamType = 8,
74  mcProcID = 9,
76  simFlavour = 10,
78  isDataOverlay = 11,
80  mcCampaign = 12,
82  generatorsInfo = 13,
84  dataYear = 14,
86  END = 15
87  }; // enum MetaDataType

◆ PrivateStoreState

enum SG::IAuxElement::PrivateStoreState : uint8_t
strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE 
HAVE_PRIVATE 
HAD_PRIVATE 

Definition at line 131 of file IAuxElement.h.

132  {
133  NO_PRIVATE = 0,
134  HAVE_PRIVATE = 1,
135  HAD_PRIVATE = 2,
136  };

Constructor & Destructor Documentation

◆ FileMetaData_v1()

xAOD::FileMetaData_v1::FileMetaData_v1 ( )

Default constructor.

Definition at line 21 of file FileMetaData_v1.cxx.

21  : SG::AuxElement()
22  { }

Member Function Documentation

◆ assign()

void SG::AuxElement::assign ( const AuxElement other,
bool  warnUnlocked = false 
)
inherited

Assignment.

Parameters
otherThe object from which we're assigning.
warnUnlockedIf true, then warn when we skip unlocked decorations.

We don't copy container/index, as assignment doesn't change where this object is. However, if we have aux data, then we copy aux data if we're copying from an object that also has it; otherwise, if we're copying from an object with no aux data, then we clear ours.

◆ auxdata() [1/4]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata ( const std::string &  name)
inherited

Fetch an aux data variable, as a non-const reference.

Parameters
nameName of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ auxdata() [2/4]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata ( const std::string &  name) const
inherited

Fetch an aux data variable, as a const reference.

Parameters
nameName of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

◆ auxdata() [3/4]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata ( const std::string &  name,
const std::string &  clsname 
)
inherited

Fetch an aux data variable, as a non-const reference.

Parameters
nameName of the aux variable.
clsnameThe name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ auxdata() [4/4]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata ( const std::string &  name,
const std::string &  clsname 
) const
inherited

Fetch an aux data variable, as a const reference.

Parameters
nameName of the aux variable.
clsnameThe name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

◆ auxdataConst() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string &  name) const
inherited

Fetch an aux data variable, as a const reference.

Parameters
nameName of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

◆ auxdataConst() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string &  name,
const std::string &  clsname 
) const
inherited

Fetch an aux data variable, as a const reference.

Parameters
nameName of the aux variable.
clsnameThe name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

◆ auxdecor() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string &  name) const
inherited

Fetch an aux decoration, as a non-const reference.

Parameters
nameName of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

◆ auxdecor() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string &  name,
const std::string &  clsname 
) const
inherited

Fetch an aux decoration, as a non-const reference.

Parameters
nameName of the aux variable.
clsnameThe name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

◆ clearAux()

void SG::AuxElement::clearAux ( )
privateinherited

Clear all aux data associated with this element.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 580 of file AuxElement.cxx.

581 {
582  if (!m_container) return;
583  if (!m_container->hasStore()) return;
585  throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
586 
588  for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
589  r.clear (auxid, *container(), index(), 1);
590  }
591 }

◆ clearCache()

void SG::AuxElement::clearCache ( )
inherited

Clear the cached aux data pointers.

You should call this any time something changes in the aux store that could invalidate the vector pointers.

Definition at line 339 of file AuxElement.cxx.

340 {
341  if (container())
342  container()->clearCache();
343 }

◆ clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const
inherited

Clear all decorations.

Erase all decorations from an associated store, restoring the state to when lock was called.

Returns true if there were any decorations that were cleared, false if the store did not contain any decorations.

Definition at line 428 of file AuxElement.cxx.

429 {
430  if (havePrivateData())
431  return m_container->clearDecorations();
432  return false;
433 }

◆ compareWith()

bool xAOD::FileMetaData_v1::compareWith ( const FileMetaData_v1 rhs,
const std::set< std::string > &  ignore 
) const

Compare this FMD object with another, optionally ignoring some attributes.

Definition at line 25 of file FileMetaData_v1.cxx.

26  {
27  // Get the variable types from both objects:
28  SG::auxid_set_t auxids1 = this->getAuxIDs();
29  SG::auxid_set_t auxids2 = rhs.getAuxIDs();
31  for( const std::string& var : ignore ) {
32  SG::auxid_t varid = reg.findAuxID(var);
33  auxids1.erase(varid);
34  auxids2.erase(varid);
35  }
36 
37  // They need to be the same. If the two objects have different variables,
38  // that's bad. Unfortunately there's no equivalency operator for
39  // auxid_set_t, so this check needs to be spelled out. :-(
40  if( auxids1.size() != auxids2.size() ) {
41  return false;
42  }
43  for( SG::auxid_t auxid : auxids1 ) {
44  if( auxids2.find( auxid ) == auxids2.end() ) {
45  return false;
46  }
47  }
48 
49  // Now, compare all elements:
50  for( SG::auxid_t auxid : auxids1 ) {
51 
52  // Check the type of the variable:
53  const std::type_info* ti = reg.getType( auxid );
54  if( ! ti ) {
55  // This is weird, but there's not much that we can do about it
56  // here...
57  continue;
58  }
59  if( ( *ti != typeid( std::string ) ) &&
60  ( *ti != typeid( uint32_t ) ) &&
61  ( *ti != typeid( float ) ) &&
62  ( *ti != typeid( char ) ) &&
63  ( *ti != typeid( std::vector< uint32_t > ) ) ) {
64  // We just ignore every other type. Still, this is strange, let's
65  // warn the user about it.
66  std::cerr << "xAOD::FileMetaData::operator== WARNING Unsupported "
67  << "variable (\"" << reg.getName( auxid ) << "\"/"
69  << ") encountered" << std::endl;
70  continue;
71  }
72 
73  // The variable name:
74  const std::string name = reg.getName( auxid );
75 
76  // Treat different types separately:
77  if( *ti == typeid( std::string ) ) {
78 
79  // Retrieve the values:
81  const std::string& value1 = acc( *this );
82  const std::string& value2 = acc( rhs );
83  // And simply compare them:
84  if( value1 != value2 ) {
85  return false;
86  }
87 
88  } else if( *ti == typeid( uint32_t ) ) {
89 
90  // Retrieve the values:
92  const uint32_t& value1 = acc( *this );
93  const uint32_t& value2 = acc( rhs );
94  // And simply compare them:
95  if( value1 != value2 ) {
96  return false;
97  }
98 
99  } else if( *ti == typeid( float ) ) {
100 
101  // Retrieve the values:
103  const float& value1 = acc( *this );
104  const float& value2 = acc( rhs );
105  // And (not so simply) compare them:
106  if( std::abs( value1 - value2 ) > 0.001 ) {
107  return false;
108  }
109 
110  } else if( *ti == typeid( char ) ) {
111 
112  // Retrieve the values:
114  const char& value1 = acc( *this );
115  const char& value2 = acc( rhs );
116  // And (not so simply) compare them:
117  if( value1 != value2 ) {
118  return false;
119  }
120  } else if ( *ti == typeid( std::vector<uint32_t> ) ) {
121  // One code to retrieve them
123  const std::vector<uint32_t>& value1 = acc( *this );
124  const std::vector<uint32_t>& value2 = acc( rhs );
125  // and in simplicity compare them
126  if( value1 != value2 ) {
127  return false;
128  }
129  } else {
130  // We should really never end up here unless a coding mistake was
131  // made upstream.
132  std::abort();
133  }
134  }
135 
136  /*
137  // Compare the string properties:
138  std::array< MetaDataType, 8 > stringTypes{ { productionRelease, amiTag,
139  AODFixVersion, AODCalibVersion, dataType, geometryVersion,
140  conditionsTag, beamType } };
141  for( MetaDataType type : stringTypes ) {
142  // (Try to) Retrieve the properties:
143  std::string val1, val2;
144  const bool found1 = this->value( type, val1 );
145  const bool found2 = rhs.value( type, val2 );
146  // If both of them failed, then let's continue. If both of them are
147  // missing this variable, that's fine.
148  if( ( ! found1 ) && ( ! found2 ) ) {
149  continue;
150  }
151  // If the variable is only available on one of them, then we already
152  // have a difference. Although this point could be fine-tuned later on.
153  if( ( found1 && ( ! found2 ) ) || ( ( ! found1 ) && found2 ) ) {
154  return false;
155  }
156  // If both values were found, then let's compare them:
157  if( val1 != val2 ) {
158  return false;
159  }
160  }
161 
162  // Compare the float propery/properties:
163  std::array< MetaDataType, 1 > floatTypes{ { beamEnergy } };
164  for( MetaDataType type : floatTypes ) {
165  // (Try to) Retrieve the properties:
166  float val1 = 0.0, val2 = 0.0;
167  const bool found1 = this->value( type, val1 );
168  const bool found2 = rhs.value( type, val2 );
169  // If both of them failed, then let's continue. If both of them are
170  // missing this variable, that's fine.
171  if( ( ! found1 ) && ( ! found2 ) ) {
172  continue;
173  }
174  // If the variable is only available on one of them, then we already
175  // have a difference. Although this point could be fine-tuned later on.
176  if( ( found1 && ( ! found2 ) ) || ( ( ! found1 ) && found2 ) ) {
177  return false;
178  }
179  // If both values were found, then let's compare them:
180  if( std::abs( val1 - val2 ) > 0.001 ) {
181  return false;
182  }
183  }
184  */
185 
186  // The two objects were found to be equivalent:
187  return true;
188  }

◆ container() [1/2]

SG::AuxVectorData* SG::AuxElement::container ( )
inherited

Return the container holding this element.

◆ container() [2/2]

const SG::AuxVectorData* SG::AuxElement::container ( ) const
inherited

Return the container holding this element.

◆ copyAux()

void SG::AuxElement::copyAux ( const ConstAuxElement other,
bool  warnUnlocked = false 
)
privateinherited

Copy aux data from another object.

Parameters
otherThe object from which to copy.
warnUnlockedIf true, then warn when we skip unlocked decorations.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)

Definition at line 607 of file AuxElement.cxx.

609 {
610  if (!m_container) return;
611  if (!m_container->hasStore()) return;
613  throw SG::ExcConstAuxData ("copyAux");
614 
615  const SG::AuxVectorData* ocont = other.container();
616 
617  if (!ocont || !ocont->hasStore()) {
618  this->clearAux();
619  return;
620  }
621 
622  size_t oindex = other.index();
623  SG::auxid_set_t other_ids = ocont->getAuxIDs();
624 #ifndef XAOD_STANDALONE
625  SG::auxid_set_t other_decors = ocont->getDecorIDs();
626 #endif
627 
629 
630  SG::AuxVectorData& cont = *container();
631  for (SG::auxid_t auxid : other_ids) {
632 #ifndef XAOD_STANDALONE
633  if (other_decors.test (auxid)) {
634  // Don't copy decorations --- another thread may be modifying them.
635  other_ids.reset (auxid);
636  // Warn if we skip a decoration (except for mcEventWeights,
637  // for which this is expected).
638  if (warnUnlocked && r.getName(auxid) != "mcEventWeights") {
639  std::ostringstream ss;
640  ss << "skipped unlocked decoration " << r.getName(auxid)
641  << " (" << auxid << ")";
642  ATHCONTAINERS_WARNING("copyAux", ss.str());
643  }
644  }
645  else
646 #endif
647  if (!r.isLinked (auxid)) {
648  r.copy (auxid, cont, index(), *ocont, oindex, 1);
649  }
650  }
651 
652  for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
653  if (!other_ids.test (auxid)) {
654  r.clear (auxid, cont, index(), 1);
655  }
656  }
657 }

◆ getAuxIDs()

const SG::auxid_set_t & SG::AuxElement::getAuxIDs ( ) const
inherited

Return a set of identifiers for existing data items for this object.

If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.

Definition at line 355 of file AuxElement.cxx.

356 {
357 #ifdef ATHCONTAINERS_R21_COMPAT
358  if (havePrivateData())
359  return m_container->getConstStore()->getAuxIDs();
360  if (container())
361  return container()->getAuxIDs();
362  static const SG::auxid_set_t null_set;
363  return null_set;
364 #else
366 #endif
367 }

◆ getConstStore()

const SG::IConstAuxStore * SG::AuxElement::getConstStore ( ) const
inherited

Return the current store, as a const interface.

This will be non-zero if either a const or non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 304 of file AuxElement.cxx.

305 {
306  if (havePrivateData()) {
307  return m_container->getConstStore();
308  }
309  return 0;
310 }

◆ getDecorIDs()

const SG::auxid_set_t & SG::AuxElement::getDecorIDs ( ) const
inherited

Return a set of identifiers for decorations for this object.

   If this object has a private or standalone store, then information
   from that will be returned.  Otherwise, if this element
   is part of a container, then information for the container
   will be returned.  Otherwise, return an empty set.

Definition at line 378 of file AuxElement.cxx.

379 {
380 #ifdef ATHCONTAINERS_R21_COMPAT
381  if (havePrivateData())
383  if (container())
384  return container()->getDecorIDs();
385  static const SG::auxid_set_t null_set;
386  return null_set;
387 #else
389 #endif
390 }

◆ getStore()

SG::IAuxStore * SG::AuxElement::getStore ( ) const
inherited

Return the current store, as a non-const interface.

This will be non-zero if a non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 319 of file AuxElement.cxx.

320 {
321  if (havePrivateData()) {
322 #ifdef ATHCONTAINERS_R21_COMPAT
324 #else
325  SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
326 #endif
327  return container_nc->getStore();
328  }
329  return 0;
330 }

◆ hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const
protectedinherited

True if this element had private data before it was added to its current container.

◆ hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const
inherited

Return true if this object has an associated non-const store.

This will be true for either a private or standalone store.

Definition at line 411 of file AuxElement.cxx.

412 {
413  if (havePrivateData())
414  return m_container->hasNonConstStore();
415  return false;
416 }

◆ hasStore()

bool SG::AuxElement::hasStore ( ) const
inherited

Return true if this object has an associated store.

This will be true for either a private or standalone store.

Definition at line 398 of file AuxElement.cxx.

399 {
400  if (havePrivateData())
401  return m_container->hasStore();
402  return false;
403 }

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const
protectedinherited

True if this element currently has private data.

◆ index() [1/2]

size_t SG::IAuxElement::index ( ) const
inherited

Return the index of this element within its container.

◆ index() [2/2]

size_t SG::IAuxElement::index
inherited

Return the index of this element within its container.

Inherited from IAuxElement.

◆ isAvailable()

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailable ( const std::string &  name,
const std::string &  clsname = "" 
) const
inherited

Check if an aux variable is available for reading.

Parameters
nameName of the aux variable.
clsnameThe name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ isAvailableWritable()

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritable ( const std::string &  name,
const std::string &  clsname = "" 
)
inherited

Check if an aux variable is available for writing.

Parameters
nameName of the aux variable.
clsnameThe name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ isAvailableWritableAsDecoration()

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritableAsDecoration ( const std::string &  name,
const std::string &  clsname = "" 
) const
inherited

Check if an aux variable is available for writing as a decoration.

Parameters
nameName of the aux variable.
clsnameThe name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )
inherited

Create a new (empty) private store for this object.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

Definition at line 192 of file AuxElement.cxx.

193 {
194  if (m_container) {
195  throw SG::ExcBadPrivateStore ("store already exists");
196  }
197 
201 }

◆ makePrivateStore() [2/3]

template<class U1 >
void SG::AuxElement::makePrivateStore ( const U1 &  other,
bool  warnUnlocked = false 
)
inherited

Create a new private store for this object and copy aux data.

Parameters
otherThe object from which aux data should be copied.
warnUnlockedIf true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

◆ makePrivateStore() [3/3]

template<class U1 >
void SG::AuxElement::makePrivateStore ( const U1 *  other,
bool  warnUnlocked = false 
)
inherited

Create a new private store for this object and copy aux data.

Parameters
otherThe object from which aux data should be copied.
warnUnlockedIf true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

◆ makePrivateStore1() [1/2]

void SG::AuxElement::makePrivateStore1 ( const AuxElement other,
bool  warnUnlocked 
)
privateinherited

Create a new private store for this object and copy aux data.

Parameters
otherThe object from which aux data should be copied.
warnUnlockedIf true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does have aux data.

Definition at line 565 of file AuxElement.cxx.

567 {
569  if (other)
570  this->copyAux (*other, warnUnlocked);
571 }

◆ makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1 ( const void *  other,
bool  warnUnlocked 
)
privateinherited

Create a new private store for this object and copy aux data.

Parameters
otherThe object from which aux data should be copied.
warnUnlockedIf true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does not have aux data.

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const
protectedinherited

True if this element has no private data.

◆ operator!=()

Operator testing the inequality of two objects.

Definition at line 190 of file FileMetaData_v1.cxx.

190  {
191 
192  return !( this->operator==( rhs ) );
193  }

◆ operator==()

bool xAOD::FileMetaData_v1::operator== ( const FileMetaData_v1 rhs) const
inline

Operator testing the equality of two objects.

Definition at line 44 of file FileMetaData_v1.h.

44 { return compareWith(rhs, std::set<std::string>()); };

◆ releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )
inherited

Release and free any private store associated with this object.

ExcBadPrivateStore will be thrown if this object does not have a private store.

Definition at line 210 of file AuxElement.cxx.

211 {
212  if (hadPrivateData()) {
213  // We had a private store, but it was released because this object
214  // was added to a container. Just forget about it.
216  return;
217  }
218 
219  if (!havePrivateData() ||
220  !m_container ||
221  typeid(*m_container) != typeid(AuxElementPrivateData))
222  {
223  throw SG::ExcBadPrivateStore ("no private store exists");
224  }
225 
228  delete m_container;
229  m_container = 0;
230 }

◆ releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )
privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 441 of file AuxElement.cxx.

442 {
443 #ifdef ATHCONTAINERS_R21_COMPAT
444  if (havePrivateData()) {
445  delete m_container;
446  }
447 #else
449 #endif
450 }

◆ setConstStore()

void SG::AuxElement::setConstStore ( const SG::IConstAuxStore store)
inherited

Synonym for setStore with IConstAuxStore.

Parameters
storeThe new store.

◆ setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )
privateinherited

Record that this element used to have private data.

◆ setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )
privateinherited

Record that this element currently has private data.

◆ setIndex()

void SG::AuxElement::setIndex ( size_t  index,
SG::AuxVectorData container 
)
privateinherited

Set the index/container for this element.

Parameters
indexThe index of this object within the container.
containerThe container holding this object. May be null if this object is being removed from a container.

Usually this simply sets the index and container members of this object. However, in the case where this object has an associated private store, then we need to deal with releasing the store if the object is being added to a container, or making a new store if the object is being removed from a container.

◆ setIndexPrivate()

bool SG::AuxElement::setIndexPrivate ( size_t  index,
SG::AuxVectorData container 
)
privateinherited

Set the index/container for this element.

Parameters
indexThe index of this object within the container.
containerThe container holding this object. May be null if this object is being removed from a container.

This is called from setIndex when we have a private store to deal with.

Definition at line 505 of file AuxElement.cxx.

506 {
507 #ifdef ATHCONTAINERS_R21_COMPAT
508  if (hadPrivateData()) {
509  // We had a private store, but it was released because we were added
510  // to a container.
511 
512  if (container == 0) {
513  // We're being moved out of the container. Make a new private
514  // store, copy the data, and switch to it.
515  auto privateData = new SG::AuxElementPrivateData;
516  AuxElement to (privateData, 0);
517  to.copyAux (*this);
520  m_container = privateData;
521  return true;
522  }
523  }
524  else if (havePrivateData() &&
525  typeid(*m_container) == typeid(AuxElementPrivateData))
526  {
527  // We currently have a private store.
528 
529  if (container != 0 && container != m_container) {
530  // We're being added to a container.
531  // Aux data has already been copied.
532  // Release private store.
535  delete m_container;
537  return false;
538  }
539  }
540  else {
541  // We have a standalone store.
542  throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
543  "from a container.");
544  }
545 
548  return false;
549 #else
551 #endif
552 }

◆ setNonConstStore()

void SG::AuxElement::setNonConstStore ( SG::IAuxStore store)
inherited

Synonym for setStore with IAuxStore.

Parameters
storeThe new store.

◆ setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )
privateinherited

Record that this element does not have private data.

◆ setStore() [1/3]

void SG::AuxElement::setStore ( const DataLink< SG::IConstAuxStore > &  store)
inherited

Set the store associated with this object.

Parameters
storeThe new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Parameters
storeLink to the new store.

Definition at line 269 of file AuxElement.cxx.

270 {
271  AuxElementStandaloneData* data = setStore1 (store);
272  if (store)
273  data->setStore (store);
274 }

◆ setStore() [2/3]

void SG::AuxElement::setStore ( const SG::IConstAuxStore store)
inherited

Set the store associated with this object.

Parameters
storeThe new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 241 of file AuxElement.cxx.

242 {
243  AuxElementStandaloneData* data = setStore1 (store);
244  if (store)
245  data->setStore (store);
246 }

◆ setStore() [3/3]

void SG::AuxElement::setStore ( SG::IAuxStore store)
inherited

Set the store associated with this object.

Parameters
storeThe new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 257 of file AuxElement.cxx.

258 {
259  AuxElementStandaloneData* data = setStore1 (store);
260  if (store)
261  data->setStore (store);
262 }

◆ setStore1()

AuxElementStandaloneData * SG::AuxElement::setStore1 ( const SG::IConstAuxStore store)
privateinherited

Set the store associated with this object.

Parameters
storeThe new store.

Helper for setStore. Creates the AuxElementStandaloneData object if needed and returns it.

Parameters
storeThe new store.

Helper for setStore. Creates the @x AuxElementStandaloneData object if needed and returns it.

Definition at line 461 of file AuxElement.cxx.

462 {
463  if (store) {
464  // Want this object be standalone.
465  if (!m_container) {
466  // Not in a container (and no private store). Make a new object.
467  AuxElementStandaloneData* data = new AuxElementStandaloneData;
469  m_container = data;
470  return data;
471  }
472  if (usingStandaloneStore()) {
473  // Standalone --- return existing object.
474  return static_cast<AuxElementStandaloneData*> (container());
475  }
476  // Otherwise, it's an error.
477  throw ExcBadPrivateStore ("Attempt to attach a standalone store to an "
478  "object in a container or with a private store.");
479  }
480 
481  else {
482  // Getting rid of a standalone store.
483  if (usingStandaloneStore()) {
485  delete m_container;
486  m_container = 0;
487  }
488  else if (m_container != 0)
489  throw ExcBadPrivateStore ("Attempt to remove a standalone store from an "
490  "object in a container or with a private store.");
491  return 0;
492  }
493 }

◆ setValue() [1/9]

bool xAOD::FileMetaData_v1::setValue ( const std::string &  type,
bool  val 
)

Set a generic bool value on the object.

Definition at line 444 of file FileMetaData_v1.cxx.

444  {
445 
446  // Create the accessor object:
447  const Accessor< char > acc( type );
448 
449  // Set the value:
450  acc( *this ) = val;
451 
452  // We were successful:
453  return true;
454  }

◆ setValue() [2/9]

bool xAOD::FileMetaData_v1::setValue ( const std::string &  type,
const std::string &  val 
)

Set a generic string value on the object.

Definition at line 248 of file FileMetaData_v1.cxx.

249  {
250 
251  // Create the accessor object:
252  const Accessor< std::string > acc( type );
253 
254  // Set the value:
255  acc( *this ) = val;
256 
257  // We were successful:
258  return true;
259  }

◆ setValue() [3/9]

bool xAOD::FileMetaData_v1::setValue ( const std::string &  type,
const std::vector< uint32_t > &  val 
)

Set a generic list value on the object.

Definition at line 473 of file FileMetaData_v1.cxx.

474  {
475  // Create the accessor object:
476  const Accessor<std::vector<uint32_t> > acc(type);
477 
478  // Set the value:
479  acc(*this) = val;
480 
481  // We were successful:
482  return true;
483  }

◆ setValue() [4/9]

bool xAOD::FileMetaData_v1::setValue ( const std::string &  type,
float  val 
)

Set a generic float value on the object.

Definition at line 379 of file FileMetaData_v1.cxx.

379  {
380 
381  // Create the accessor object:
382  const Accessor< float > acc( type );
383 
384  // Set the value:
385  acc( *this ) = val;
386 
387  // We were successful:
388  return true;
389  }

◆ setValue() [5/9]

bool xAOD::FileMetaData_v1::setValue ( const std::string &  type,
uint32_t  val 
)

Set a generic uint32_t value on the object.

Definition at line 314 of file FileMetaData_v1.cxx.

314  {
315 
316  // Create the accessor object:
317  const Accessor< uint32_t > acc( type );
318 
319  // Set the value:
320  acc( *this ) = val;
321 
322  // We were successful:
323  return true;
324  }

◆ setValue() [6/9]

bool xAOD::FileMetaData_v1::setValue ( MetaDataType  type,
bool  val 
)

Set a pre-defined bool value on the object.

Definition at line 429 of file FileMetaData_v1.cxx.

429  {
430 
431  // Get the accessor for this type:
433  if( ! acc ) {
434  return false;
435  }
436 
437  // Set the value:
438  ( *acc )( *this ) = val;
439 
440  // We were successful:
441  return true;
442  }

◆ setValue() [7/9]

bool xAOD::FileMetaData_v1::setValue ( MetaDataType  type,
const std::string &  val 
)

Set a pre-defined string value on the object.

Definition at line 233 of file FileMetaData_v1.cxx.

233  {
234 
235  // Get the accessor for this type:
236  const Accessor< std::string >* acc = metaDataTypeStringAccessorV1( type );
237  if( ! acc ) {
238  return false;
239  }
240 
241  // Set the value:
242  ( *acc )( *this ) = val;
243 
244  // We were successful:
245  return true;
246  }

◆ setValue() [8/9]

bool xAOD::FileMetaData_v1::setValue ( MetaDataType  type,
float  val 
)

Set a pre-defined float value on the object.

Definition at line 364 of file FileMetaData_v1.cxx.

364  {
365 
366  // Get the accessor for this type:
368  if( ! acc ) {
369  return false;
370  }
371 
372  // Set the value:
373  ( *acc )( *this ) = val;
374 
375  // We were successful:
376  return true;
377  }

◆ setValue() [9/9]

bool xAOD::FileMetaData_v1::setValue ( MetaDataType  type,
uint32_t  val 
)

Set a pre-defined uint32_t value on the object.

Definition at line 299 of file FileMetaData_v1.cxx.

299  {
300 
301  // Get the accessor for this type:
302  const Accessor< uint32_t >* acc = metaDataTypeUIntAccessorV1( type );
303  if( ! acc ) {
304  return false;
305  }
306 
307  // Set the value:
308  ( *acc )( *this ) = val;
309 
310  // We were successful:
311  return true;
312  }

◆ trackIndices()

bool SG::AuxElement::trackIndices ( ) const
inherited

Return true if index tracking is enabled for this object.

Always returns true. Included here to be consistent with AuxVectorBase when standalone objects may be used as template parameters.

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const
inherited

Test to see if this object is currently using a private store.

Definition at line 280 of file AuxElement.cxx.

281 {
282  return havePrivateData() &&
283  typeid(*m_container) == typeid(AuxElementPrivateData);
284 }

◆ usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const
inherited

Test to see if this object is currently using a standalone store.

Test to see if this object is currently using a private store.

Definition at line 290 of file AuxElement.cxx.

291 {
292  return havePrivateData() &&
293  typeid(*m_container) == typeid(AuxElementStandaloneData);
294 }

◆ value() [1/9]

bool xAOD::FileMetaData_v1::value ( const std::string &  type,
bool val 
) const

Get a generic bool value out of the object.

Definition at line 411 of file FileMetaData_v1.cxx.

412  {
413 
414  // Create an accessor object:
415  const Accessor< char > acc( type );
416 
417  // Check if this variable is available:
418  if( ! acc.isAvailable( *this ) ) {
419  return false;
420  }
421 
422  // Read the value:
423  val = acc( *this );
424 
425  // We were successful:
426  return true;
427  }

◆ value() [2/9]

bool xAOD::FileMetaData_v1::value ( const std::string &  type,
float val 
) const

Get a generic float value out of the object.

Definition at line 346 of file FileMetaData_v1.cxx.

347  {
348 
349  // Create an accessor object:
350  const Accessor< float > acc( type );
351 
352  // Check if this variable is available:
353  if( ! acc.isAvailable( *this ) ) {
354  return false;
355  }
356 
357  // Read the value:
358  val = acc( *this );
359 
360  // We were successful:
361  return true;
362  }

◆ value() [3/9]

bool xAOD::FileMetaData_v1::value ( const std::string &  type,
std::string &  val 
) const

Get a generic string value out of the object.

Definition at line 215 of file FileMetaData_v1.cxx.

216  {
217 
218  // Create an accessor object:
219  const Accessor< std::string > acc( type );
220 
221  // Check if this variable is available:
222  if( ! acc.isAvailable( *this ) ) {
223  return false;
224  }
225 
226  // Read the value:
227  val = acc( *this );
228 
229  // We were successful:
230  return true;
231  }

◆ value() [4/9]

bool xAOD::FileMetaData_v1::value ( const std::string &  type,
std::vector< uint32_t > &  val 
) const

Get a generic list value out of the object.

Definition at line 456 of file FileMetaData_v1.cxx.

457  {
458  // Create an accessor object:
459  const Accessor<std::vector<uint32_t> > acc(type);
460 
461  // Check if this variable is available:
462  if (!acc.isAvailable(*this)) {
463  return false;
464  }
465 
466  // Read the value:
467  val = acc(*this);
468 
469  // We were successful:
470  return true;
471  }

◆ value() [5/9]

bool xAOD::FileMetaData_v1::value ( const std::string &  type,
uint32_t val 
) const

Get a generic uint32_t value out of the object.

Definition at line 281 of file FileMetaData_v1.cxx.

282  {
283 
284  // Create an accessor object:
285  const Accessor< uint32_t > acc( type );
286 
287  // Check if this variable is available:
288  if( ! acc.isAvailable( *this ) ) {
289  return false;
290  }
291 
292  // Read the value:
293  val = acc( *this );
294 
295  // We were successful:
296  return true;
297  }

◆ value() [6/9]

bool xAOD::FileMetaData_v1::value ( MetaDataType  type,
bool val 
) const

Get a pre-defined bool value out of the object.

Definition at line 391 of file FileMetaData_v1.cxx.

391  {
392 
393  // Get the accessor for this type:
395  if( ! acc ) {
396  return false;
397  }
398 
399  // Check if the variable is available:
400  if( ! acc->isAvailable( *this ) ) {
401  return false;
402  }
403 
404  // Read the value:
405  val = ( *acc )( *this );
406 
407  // We were successful:
408  return true;
409  }

◆ value() [7/9]

bool xAOD::FileMetaData_v1::value ( MetaDataType  type,
float val 
) const

Get a pre-defined float value out of the object.

Definition at line 326 of file FileMetaData_v1.cxx.

326  {
327 
328  // Get the accessor for this type:
330  if( ! acc ) {
331  return false;
332  }
333 
334  // Check if the variable is available:
335  if( ! acc->isAvailable( *this ) ) {
336  return false;
337  }
338 
339  // Read the value:
340  val = ( *acc )( *this );
341 
342  // We were successful:
343  return true;
344  }

◆ value() [8/9]

bool xAOD::FileMetaData_v1::value ( MetaDataType  type,
std::string &  val 
) const

Get a pre-defined string value out of the object.

Definition at line 195 of file FileMetaData_v1.cxx.

195  {
196 
197  // Get the accessor for this type:
198  const Accessor< std::string >* acc = metaDataTypeStringAccessorV1( type );
199  if( ! acc ) {
200  return false;
201  }
202 
203  // Check if the variable is available:
204  if( ! acc->isAvailable( *this ) ) {
205  return false;
206  }
207 
208  // Read the value:
209  val = ( *acc )( *this );
210 
211  // We were successful:
212  return true;
213  }

◆ value() [9/9]

bool xAOD::FileMetaData_v1::value ( MetaDataType  type,
uint32_t val 
) const

Get a pre-defined uint32_t value out of the object.

Definition at line 261 of file FileMetaData_v1.cxx.

261  {
262 
263  // Get the accessor for this type:
264  const Accessor< uint32_t >* acc = metaDataTypeUIntAccessorV1( type );
265  if( ! acc ) {
266  return false;
267  }
268 
269  // Check if the variable is available:
270  if( ! acc->isAvailable( *this ) ) {
271  return false;
272  }
273 
274  // Read the value:
275  val = ( *acc )( *this );
276 
277  // We were successful:
278  return true;
279  }

Member Data Documentation

◆ m_container

const SG::AuxVectorData* SG::ConstAuxElement::m_container
privateinherited

The container of which this object is an element.

Should be null if this object is not within a container, except that it may also point at a private store.

Definition at line 335 of file AuxElement.h.

◆ m_index

size_t SG::IAuxElement::m_index
privateinherited

The index of this element within its container.

Should be 0 if this object is not within a container.

Definition at line 128 of file IAuxElement.h.

◆ m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState
privateinherited

Definition at line 137 of file IAuxElement.h.

◆ supportsThinning

constexpr bool SG::AuxElement::supportsThinning = true
staticconstexprinherited

Mark that this type supports thinning operations.

See AthContainers/supportsThinning.h and AthenaPoolCnvSvc/T_AthenaPoolCnv.h. Helps guide which pool converter template will be used. If false, the default pool converter will be used rather than the aux store-specific one. Ordinary xAOD type should not touch this, but may be overridden in a derived class to handle certain special cases.

Definition at line 959 of file AuxElement.h.


The documentation for this class was generated from the following files:
SG::AuxVectorData::getConstStore
const SG::IConstAuxStore * getConstStore() const
Return the current store, as a const interface.
xAOD::metaDataTypeCharAccessorV1
const SG::AuxElement::Accessor< char > * metaDataTypeCharAccessorV1(FileMetaData_v1::MetaDataType type)
Helper function for getting an accessor for a pre-defined property.
Definition: FileMetaDataAccessors_v1.cxx:108
SGTest::store
TestStore store
Definition: TestStore.cxx:23
beamspotman.r
def r
Definition: beamspotman.py:676
SG::ConstAuxElement::getAuxIDs
const SG::auxid_set_t & getAuxIDs() const
Return a set of identifiers for existing data items for this object.
Definition: AuxElement.cxx:153
xAOD::FileMetaData_v1::AODCalibVersion
@ AODCalibVersion
Version of AODCalib that was used on the file last [string].
Definition: FileMetaData_v1.h:62
beamspotnt.var
var
Definition: bin/beamspotnt.py:1394
data
char data[hepevt_bytes_allocation_ATLAS]
Definition: HepEvt.cxx:11
xAOD::name
name
Definition: TriggerMenuJson_v1.cxx:29
PowhegControl_ttHplus_NLO.ss
ss
Definition: PowhegControl_ttHplus_NLO.py:83
SG::AuxTypeRegistry::instance
static AuxTypeRegistry & instance()
Return the singleton registry instance.
Definition: AuxTypeRegistry.cxx:639
SG::Accessor< char >
SG::AuxVectorData::getDecorIDs
const SG::auxid_set_t & getDecorIDs() const
Return a set of identifiers for decorations for this object.
Definition: AuxVectorData.cxx:215
SG::AuxTypeRegistry::findAuxID
SG::auxid_t findAuxID(const std::string &name, const std::string &clsname="") const
Look up a name -> auxid_t mapping.
Definition: AuxTypeRegistry.cxx:756
xAOD::uint32_t
setEventNumber uint32_t
Definition: EventInfo_v1.cxx:127
SG::normalizedTypeinfoName
std::string normalizedTypeinfoName(const std::type_info &info)
Convert a type_info to a normalized string representation (matching the names used in the root dictio...
Definition: normalizedTypeinfoName.cxx:120
SG::AuxVectorData::getWritableAuxIDs
const SG::auxid_set_t & getWritableAuxIDs() const
Return a set of identifiers for writable data items in this store.
Definition: AuxVectorData.cxx:231
index
Definition: index.py:1
SG::AuxElement
Base class for elements of a container that can have aux data.
Definition: AuxElement.h:483
SG::AuxTypeRegistry::getName
std::string getName(SG::auxid_t auxid) const
Return the name of an aux data item.
Definition: AuxTypeRegistry.cxx:881
SG::ConstAuxElement::m_container
const SG::AuxVectorData * m_container
The container of which this object is an element.
Definition: AuxElement.h:335
CxxUtils::ConcurrentBitset::end
const_iterator end() const
Return an end iterator.
xAOD::FileMetaData_v1::compareWith
bool compareWith(const FileMetaData_v1 &rhs, const std::set< std::string > &ignore) const
Compare this FMD object with another, optionally ignoring some attributes.
Definition: FileMetaData_v1.cxx:25
SG::AuxVectorData::hasNonConstStore
bool hasNonConstStore() const
Return true if this object has an associated non-const store.
SG::AuxElement::usingStandaloneStore
bool usingStandaloneStore() const
Test to see if this object is currently using a standalone store.
Definition: AuxElement.cxx:290
SG::ConstAuxElement::setIndexPrivate
bool setIndexPrivate(size_t index, const SG::AuxVectorData *container)
Set the index/container for this element.
Definition: AuxElement.cxx:97
SG::ConstAccessor
Helper class to provide constant type-safe access to aux data.
Definition: ConstAccessor.h:55
xAOD::FileMetaData_v1::beamEnergy
@ beamEnergy
Beam energy [float].
Definition: FileMetaData_v1.h:70
SG::ExcConstAuxData
Exception — Non-const operation performed on const aux data.
Definition: Control/AthContainers/AthContainers/exceptions.h:77
SG::IAuxElement::setNoPrivateData
void setNoPrivateData()
Record that this element does not have private data.
SG::AuxVectorData::getAuxIDs
const SG::auxid_set_t & getAuxIDs() const
Return a set of identifiers for existing data items in store associated with this object.
Definition: AuxVectorData.cxx:203
xAOD::FileMetaData_v1::simFlavour
@ simFlavour
Fast or Full sim [string].
Definition: FileMetaData_v1.h:76
SG::AuxTypeRegistry
Handle mappings between names and auxid_t.
Definition: AuxTypeRegistry.h:61
SG::IAuxElement::index
size_t index() const
Return the index of this element within its container.
xAOD::FileMetaData_v1::mcCampaign
@ mcCampaign
MC campaign [string].
Definition: FileMetaData_v1.h:80
SG::IAuxElement::setHadPrivateData
void setHadPrivateData()
Record that this element used to have private data.
DiTauMassTools::ignore
void ignore(T &&)
Definition: PhysicsAnalysis/TauID/DiTauMassTools/DiTauMassTools/HelperFunctions.h:58
SG::auxid_t
size_t auxid_t
Identifier for a particular aux data item.
Definition: AuxTypes.h:27
SG::AuxTypeRegistry::getType
const std::type_info * getType(SG::auxid_t auxid) const
Return the type of an aux data item.
Definition: AuxTypeRegistry.cxx:908
CxxUtils::ConcurrentBitset::size
bit_t size() const
Count the number of 1 bits in the set.
SG::AuxElement::copyAux
void copyAux(const ConstAuxElement &other, bool warnUnlocked=false)
Copy aux data from another object.
Definition: AuxElement.cxx:607
SG::AuxElement::clearAux
void clearAux()
Clear all aux data associated with this element.
Definition: AuxElement.cxx:580
SG::AuxElement::AuxElement
AuxElement()
Default constructor.
SG::IAuxElement::havePrivateData
bool havePrivateData() const
True if this element currently has private data.
ATHCONTAINERS_WARNING
#define ATHCONTAINERS_WARNING(ctx, msg)
Definition: error.h:57
SG::AuxVectorData::getStore
SG::IAuxStore * getStore()
Return the current store, as a non-const interface.
xAOD::metaDataTypeUIntAccessorV1
const SG::AuxElement::Accessor< uint32_t > * metaDataTypeUIntAccessorV1(FileMetaData_v1::MetaDataType type)
Helper function for getting an accessor for a pre-defined property.
Definition: FileMetaDataAccessors_v1.cxx:73
SG::ConstAuxElement::getDecorIDs
const SG::auxid_set_t & getDecorIDs() const
Return a set of identifiers for decorations for this object.
Definition: AuxElement.cxx:172
AthenaPoolTestRead.acc
acc
Definition: AthenaPoolTestRead.py:16
SG::AuxElementPrivateData
Internal data container for private store.
Definition: AuxElement.cxx:46
xAOD::metaDataTypeStringAccessorV1
const SG::AuxElement::Accessor< std::string > * metaDataTypeStringAccessorV1(FileMetaData_v1::MetaDataType type)
Helper function for getting an accessor for a pre-defined property.
Definition: FileMetaDataAccessors_v1.cxx:46
xAOD::FileMetaData_v1::mcProcID
@ mcProcID
Same as mc_channel_number [float].
Definition: FileMetaData_v1.h:74
SG::AuxElement::getAuxIDs
const SG::auxid_set_t & getAuxIDs() const
Return a set of identifiers for existing data items for this object.
Definition: AuxElement.cxx:355
SG::AuxVectorData::hasStore
bool hasStore() const
Return true if this object has an associated store.
CxxUtils::ConcurrentBitset::find
const_iterator find(bit_t bit) const
If bit bit is set, return an iterator pointing to it.
SG::IAuxElement::setHavePrivateData
void setHavePrivateData()
Record that this element currently has private data.
SG::AuxVectorData::clearCache
void clearCache()
Clear the cached aux data pointers.
xAOD::FileMetaData_v1::amiTag
@ amiTag
AMI tag used to process the file the last time [string].
Definition: FileMetaData_v1.h:58
SG::AuxElement::makePrivateStore
void makePrivateStore()
Create a new (empty) private store for this object.
Definition: AuxElement.cxx:192
CxxUtils::to
CONT to(RANGE &&r)
Definition: ranges.h:39
xAOD::FileMetaData_v1::geometryVersion
@ geometryVersion
Geometry version [string].
Definition: FileMetaData_v1.h:66
SG::IAuxElement::setIndex
void setIndex(size_t index)
Set the index of this element within its container.
xAOD::FileMetaData_v1::END
@ END
End marker.
Definition: FileMetaData_v1.h:86
InDetDD::other
@ other
Definition: InDetDD_Defs.h:16
SG::AuxVectorData::clearDecorations
bool clearDecorations() const
Clear all decorations.
Definition: AuxVectorData.cxx:653
SG::ExcBadPrivateStore
Exception — Bad use of private store.
Definition: Control/AthContainers/AthContainers/exceptions.h:113
Pythia8_RapidityOrderMPI.val
val
Definition: Pythia8_RapidityOrderMPI.py:14
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
xAOD::FileMetaData_v1::generatorsInfo
@ generatorsInfo
Generators information [string].
Definition: FileMetaData_v1.h:82
xAOD::FileMetaData_v1::AODFixVersion
@ AODFixVersion
Version of AODFix that was used on the file last [string].
Definition: FileMetaData_v1.h:60
SG::IConstAuxStore::getDecorIDs
virtual const SG::auxid_set_t & getDecorIDs() const =0
Return a set of identifiers for decorations in this store.
xAOD::FileMetaData_v1::beamType
@ beamType
Beam type [string].
Definition: FileMetaData_v1.h:72
SG::auxid_set_t
A set of aux data identifiers.
Definition: AuxTypes.h:47
xAOD::metaDataTypeFloatAccessorV1
const SG::AuxElement::Accessor< float > * metaDataTypeFloatAccessorV1(FileMetaData_v1::MetaDataType type)
Helper function for getting an accessor for a pre-defined property.
Definition: FileMetaDataAccessors_v1.cxx:90
SG::AuxVectorData
Manage lookup of vectors of auxiliary data.
Definition: AuxVectorData.h:168
ATLAS_THREAD_SAFE
#define ATLAS_THREAD_SAFE
Definition: checker_macros.h:211
xAOD::FileMetaData_v1::dataYear
@ dataYear
Data year [uint32_t].
Definition: FileMetaData_v1.h:84
SG::ConstAuxElement::releasePrivateStoreForDtor
void releasePrivateStoreForDtor()
Out-of-line portion of destructor.
Definition: AuxElement.cxx:80
SG::AuxElement::container
const SG::AuxVectorData * container() const
Return the container holding this element.
xAOD::FileMetaData_v1::operator==
bool operator==(const FileMetaData_v1 &rhs) const
Operator testing the equality of two objects.
Definition: FileMetaData_v1.h:44
CxxUtils::ConcurrentBitset::erase
ConcurrentBitset & erase(bit_t bit)
Turn off one bit.
xAOD::FileMetaData_v1::isDataOverlay
@ isDataOverlay
Used data overlay for backgrounds [bool].
Definition: FileMetaData_v1.h:78
xAOD::FileMetaData_v1::conditionsTag
@ conditionsTag
Conditions version used for simulation/reconstruction [string].
Definition: FileMetaData_v1.h:68
SG::IAuxElement::hadPrivateData
bool hadPrivateData() const
True if this element had private data before it was added to its current container.
xAOD::FileMetaData_v1::dataType
@ dataType
Data type that's in the file [string].
Definition: FileMetaData_v1.h:64
SG::IConstAuxStore::getAuxIDs
virtual const SG::auxid_set_t & getAuxIDs() const =0
Return a set of identifiers for existing data items in this store.
SG::AuxElement::setStore1
AuxElementStandaloneData * setStore1(const SG::IConstAuxStore *store)
Set the store associated with this object.
Definition: AuxElement.cxx:461
xAOD::FileMetaData_v1::productionRelease
@ productionRelease
Release that was used to make the file [string].
Definition: FileMetaData_v1.h:56
CxxUtils::ConcurrentBitset::test
bool test(bit_t bit) const
Test to see if a bit is set.