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...

Public Member Functions
	FileMetaData_v1 ()
	Default constructor.
bool	value (MetaDataType type, std::string &val) const
	Get a pre-defined string value out of the object.
bool	value (const std::string &type, std::string &val) const
	Get a generic string value out of the object.
bool	setValue (MetaDataType type, const std::string &val)
	Set a pre-defined string value on the object.
bool	setValue (const std::string &type, const std::string &val)
	Set a generic string value on the object.
bool	value (MetaDataType type, uint32_t &val) const
	Get a pre-defined uint32_t value out of the object.
bool	value (const std::string &type, uint32_t &val) const
	Get a generic uint32_t value out of the object.
bool	setValue (MetaDataType type, uint32_t val)
	Set a pre-defined uint32_t value on the object.
bool	setValue (const std::string &type, uint32_t val)
	Set a generic uint32_t value on the object.
bool	value (MetaDataType type, float &val) const
	Get a pre-defined float value out of the object.
bool	value (const std::string &type, float &val) const
	Get a generic float value out of the object.
bool	setValue (MetaDataType type, float val)
	Set a pre-defined float value on the object.
bool	setValue (const std::string &type, float val)
	Set a generic float value on the object.
bool	value (MetaDataType type, bool &val) const
	Get a pre-defined bool value out of the object.
bool	value (const std::string &type, bool &val) const
	Get a generic bool value out of the object.
bool	setValue (MetaDataType type, bool val)
	Set a pre-defined bool value on the object.
bool	setValue (const std::string &type, bool val)
	Set a generic bool value on the object.
bool	value (const std::string &type, std::vector< uint32_t > &val) const
	Get a generic list value out of the object.
bool	setValue (const std::string &type, const std::vector< uint32_t > &val)
	Set a generic list value on the object.
Comparison operators
bool	operator== (const FileMetaData_v1 &rhs) const
	Operator testing the equality of two objects.
bool	operator!= (const FileMetaData_v1 &rhs) const
	Operator testing the inequality of two objects.
bool	compareWith (const FileMetaData_v1 &rhs, const std::set< std::string > &ignore) const
	Compare this FMD object with another, optionally ignoring some attributes.

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

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

685184

Date

2015-07-23 22:25:43 +0200 (Thu, 23 Jul 2015)

Definition at line 34 of file FileMetaData_v1.h.

Member Enumeration Documentation

MetaDataType

enum xAOD::FileMetaData_v1::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.

                        {
         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
      }; // enum MetaDataType

Constructor & Destructor Documentation

FileMetaData_v1()

xAOD::FileMetaData_v1::FileMetaData_v1

(

)

Default constructor.

Definition at line 21 of file FileMetaData_v1.cxx.

                                     : SG::AuxElement()
   { }

Member Function Documentation

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.

   {
      // Get the variable types from both objects:
      SG::auxid_set_t auxids1 = this->getAuxIDs();
      SG::auxid_set_t auxids2 = rhs.getAuxIDs();
      SG::AuxTypeRegistry& reg = SG::AuxTypeRegistry::instance();
      for( const std::string& var : ignore ) {
         SG::auxid_t varid = reg.findAuxID(var);
         auxids1.erase(varid);
         auxids2.erase(varid);
      }
 
      // They need to be the same. If the two objects have different variables,
      // that's bad. Unfortunately there's no equivalency operator for
      // auxid_set_t, so this check needs to be spelled out. :-(
      if( auxids1.size() != auxids2.size() ) {
         return false;
      }
      for( SG::auxid_t auxid : auxids1 ) {
         if( auxids2.find( auxid ) == auxids2.end() ) {
            return false;
         }
      }
 
      // Now, compare all elements:
      for( SG::auxid_t auxid : auxids1 ) {
 
         // Check the type of the variable:
         const std::type_info* ti = reg.getType( auxid );
         if( ! ti ) {
            // This is weird, but there's not much that we can do about it
            // here...
            continue;
         }
         if( ( *ti != typeid( std::string ) ) &&
             ( *ti != typeid( uint32_t ) ) &&
             ( *ti != typeid( float ) ) &&
             ( *ti != typeid( char ) ) &&
             ( *ti != typeid( std::vector< uint32_t > ) ) ) {
            // We just ignore every other type. Still, this is strange, let's
            // warn the user about it.
            std::cerr << "xAOD::FileMetaData::operator==  WARNING  Unsupported "
                      << "variable (\"" << reg.getName( auxid ) << "\"/"
                      << SG::normalizedTypeinfoName( *ti )
                      << ") encountered" << std::endl;
            continue;
         }
 
         // The variable name:
         const std::string name = reg.getName( auxid );
 
         // Treat different types separately:
         if( *ti == typeid( std::string ) ) {
 
            // Retrieve the values:
            SG::ConstAccessor< std::string >acc( name );
            const std::string& value1 = acc( *this );
            const std::string& value2 = acc( rhs );
            // And simply compare them:
            if( value1 != value2 ) {
               return false;
            }
 
         } else if( *ti == typeid( uint32_t ) ) {
 
            // Retrieve the values:
            SG::ConstAccessor< uint32_t >acc( name );
            const uint32_t& value1 = acc( *this );
            const uint32_t& value2 = acc( rhs );
            // And simply compare them:
            if( value1 != value2 ) {
               return false;
            }
 
         } else if( *ti == typeid( float ) ) {
 
            // Retrieve the values:
            SG::ConstAccessor< float >acc( name );
            const float& value1 = acc( *this );
            const float& value2 = acc( rhs );
            // And (not so simply) compare them:
            if( std::abs( value1 - value2 ) > 0.001 ) {
               return false;
            }
 
         } else if( *ti == typeid( char ) ) {
 
            // Retrieve the values:
            SG::ConstAccessor< char >acc( name );
            const char& value1 = acc( *this );
            const char& value2 = acc( rhs );
            // And (not so simply) compare them:
            if( value1 != value2 ) {
               return false;
            }
         } else if ( *ti == typeid( std::vector<uint32_t> ) ) {
            // One code to retrieve them
            SG::ConstAccessor< std::vector<uint32_t> >acc( name );
            const std::vector<uint32_t>& value1 = acc( *this );
            const std::vector<uint32_t>& value2 = acc( rhs );
            // and in simplicity compare them
            if( value1 != value2 ) {
               return false;
            }
         } else {
            // We should really never end up here unless a coding mistake was
            // made upstream.
            std::abort();
         }
      }
 
      /*
      // Compare the string properties:
      std::array< MetaDataType, 8 > stringTypes{ { productionRelease, amiTag,
         AODFixVersion, AODCalibVersion, dataType, geometryVersion,
         conditionsTag, beamType } };
      for( MetaDataType type : stringTypes ) {
         // (Try to) Retrieve the properties:
         std::string val1, val2;
         const bool found1 = this->value( type, val1 );
         const bool found2 = rhs.value( type, val2 );
         // If both of them failed, then let's continue. If both of them are
         // missing this variable, that's fine.
         if( ( ! found1 ) && ( ! found2 ) ) {
            continue;
         }
         // If the variable is only available on one of them, then we already
         // have a difference. Although this point could be fine-tuned later on.
         if( ( found1 && ( ! found2 ) ) || ( ( ! found1 ) && found2 ) ) {
            return false;
         }
         // If both values were found, then let's compare them:
         if( val1 != val2 ) {
            return false;
         }
      }
 
      // Compare the float propery/properties:
      std::array< MetaDataType, 1 > floatTypes{ { beamEnergy } };
      for( MetaDataType type : floatTypes ) {
         // (Try to) Retrieve the properties:
         float val1 = 0.0, val2 = 0.0;
         const bool found1 = this->value( type, val1 );
         const bool found2 = rhs.value( type, val2 );
         // If both of them failed, then let's continue. If both of them are
         // missing this variable, that's fine.
         if( ( ! found1 ) && ( ! found2 ) ) {
            continue;
         }
         // If the variable is only available on one of them, then we already
         // have a difference. Although this point could be fine-tuned later on.
         if( ( found1 && ( ! found2 ) ) || ( ( ! found1 ) && found2 ) ) {
            return false;
         }
         // If both values were found, then let's compare them:
         if( std::abs( val1 - val2 ) > 0.001 ) {
            return false;
         }
      }
      */
 
      // The two objects were found to be equivalent:
      return true;
   }

operator!=()

bool xAOD::FileMetaData_v1::operator!=

(

const FileMetaData_v1 &

rhs

)

const

Operator testing the inequality of two objects.

Definition at line 190 of file FileMetaData_v1.cxx.

                                                                    {
 
      return !( this->operator==( rhs ) );
   }

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.

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

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.

                                                                   {
 
      // Create the accessor object:
      const Accessor< char > acc( type );
 
      // Set the value:
      acc( *this ) = val;
 
      // We were successful:
      return true;
   }

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.

                                                          {
 
      // Create the accessor object:
      const Accessor< std::string > acc( type );
 
      // Set the value:
      acc( *this ) = val;
 
      // We were successful:
      return true;
   }

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.

                                                                    {
     // Create the accessor object:
     const Accessor<std::vector<uint32_t> > acc(type);
 
     // Set the value:
     acc(*this) = val;
 
     // We were successful:
     return true;
   }

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.

                                                                    {
 
      // Create the accessor object:
      const Accessor< float > acc( type );
 
      // Set the value:
      acc( *this ) = val;
 
      // We were successful:
      return true;
   }

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.

                                                                       {
 
      // Create the accessor object:
      const Accessor< uint32_t > acc( type );
 
      // Set the value:
      acc( *this ) = val;
 
      // We were successful:
      return true;
   }

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.

                                                               {
 
      // Get the accessor for this type:
      const Accessor< char >* acc = metaDataTypeCharAccessorV1( type );
      if( ! acc ) {
         return false;
      }
 
      // Set the value:
      ( *acc )( *this ) = val;
 
      // We were successful:
      return true;
   }

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.

                                                                           {
 
      // Get the accessor for this type:
      const Accessor< std::string >* acc = metaDataTypeStringAccessorV1( type );
      if( ! acc ) {
         return false;
      }
 
      // Set the value:
      ( *acc )( *this ) = val;
 
      // We were successful:
      return true;
   }

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.

                                                                {
 
      // Get the accessor for this type:
      const Accessor< float >* acc = metaDataTypeFloatAccessorV1( type );
      if( ! acc ) {
         return false;
      }
 
      // Set the value:
      ( *acc )( *this ) = val;
 
      // We were successful:
      return true;
   }

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.

                                                                   {
 
      // Get the accessor for this type:
      const Accessor< uint32_t >* acc = metaDataTypeUIntAccessorV1( type );
      if( ! acc ) {
         return false;
      }
 
      // Set the value:
      ( *acc )( *this ) = val;
 
      // We were successful:
      return true;
   }

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.

                                                  {
 
      // Create an accessor object:
      const Accessor< char > acc( type );
 
      // Check if this variable is available:
      if( ! acc.isAvailable( *this ) ) {
         return false;
      }
 
      // Read the value:
      val = acc( *this );
 
      // We were successful:
      return true;
   }

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.

                                                   {
 
      // Create an accessor object:
      const Accessor< float > acc( type );
 
      // Check if this variable is available:
      if( ! acc.isAvailable( *this ) ) {
         return false;
      }
 
      // Read the value:
      val = acc( *this );
 
      // We were successful:
      return true;
   }

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.

                                                       {
 
      // Create an accessor object:
      const Accessor< std::string > acc( type );
 
      // Check if this variable is available:
      if( ! acc.isAvailable( *this ) ) {
         return false;
      }
 
      // Read the value:
      val = acc( *this );
 
      // We were successful:
      return true;
   }

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.

                                                                 {
     // Create an accessor object:
     const Accessor<std::vector<uint32_t> > acc(type);
 
     // Check if this variable is available:
     if (!acc.isAvailable(*this)) {
       return false;
     }
 
     // Read the value:
     val = acc(*this);
 
     // We were successful:
     return true;
   }

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.

                                                      {
 
      // Create an accessor object:
      const Accessor< uint32_t > acc( type );
 
      // Check if this variable is available:
      if( ! acc.isAvailable( *this ) ) {
         return false;
      }
 
      // Read the value:
      val = acc( *this );
 
      // We were successful:
      return true;
   }

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.

                                                                   {
 
      // Get the accessor for this type:
      const Accessor< char >* acc = metaDataTypeCharAccessorV1( type );
      if( ! acc ) {
         return false;
      }
 
      // Check if the variable is available:
      if( ! acc->isAvailable( *this ) ) {
         return false;
      }
 
      // Read the value:
      val = ( *acc )( *this );
 
      // We were successful:
      return true;
   }

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.

                                                                    {
 
      // Get the accessor for this type:
      const Accessor< float >* acc = metaDataTypeFloatAccessorV1( type );
      if( ! acc ) {
         return false;
      }
 
      // Check if the variable is available:
      if( ! acc->isAvailable( *this ) ) {
         return false;
      }
 
      // Read the value:
      val = ( *acc )( *this );
 
      // We were successful:
      return true;
   }

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.

                                                                        {
 
      // Get the accessor for this type:
      const Accessor< std::string >* acc = metaDataTypeStringAccessorV1( type );
      if( ! acc ) {
         return false;
      }
 
      // Check if the variable is available:
      if( ! acc->isAvailable( *this ) ) {
         return false;
      }
 
      // Read the value:
      val = ( *acc )( *this );
 
      // We were successful:
      return true;
   }

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.

                                                                       {
 
      // Get the accessor for this type:
      const Accessor< uint32_t >* acc = metaDataTypeUIntAccessorV1( type );
      if( ! acc ) {
         return false;
      }
 
      // Check if the variable is available:
      if( ! acc->isAvailable( *this ) ) {
         return false;
      }
 
      // Read the value:
      val = ( *acc )( *this );
 
      // We were successful:
      return true;
   }

---

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

• FileMetaData_v1.h
• FileMetaData_v1.cxx