ObjectMetadata.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
 
/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef D3PDMAKERUTILS_OBJECTMETADATA_H
#define D3PDMAKERUTILS_OBJECTMETADATA_H
 
// STL include(s):
#include <atomic>
#include <string>
#include <set>
#include <unordered_map>
 
// D3PD include(s):
#include "D3PDMakerInterfaces/IAddVariable.h"
 
// Gaudi/Athena include(s):
#include "CxxUtils/checker_macros.h"
 
namespace D3PD {

   class ObjectMetadata : public IAddVariable {
 
   public:
      ObjectMetadata();
      ObjectMetadata( const ObjectMetadata& parent );

      ObjectMetadata& operator= ( const ObjectMetadata& parent );
      bool operator== ( const ObjectMetadata& rhs ) const;
      bool operator<  ( const ObjectMetadata& rhs ) const;

      using IAddVariable::addVariable;
      using IAddVariable::addDimensionedVariable;

      //
      //               Functions inherited from IAddVariable
 
      virtual StatusCode addVariable( const std::string& name,
                                      const std::type_info& ti,
                                      void*& ptr,
                                      const std::string& docstring = "",
                                      const void* defval = 0 );
 
      virtual StatusCode addDimensionedVariable( const std::string& name,
                                                 const std::type_info& ti,
                                                 void*& ptr,
                                                 const std::string& dim,
                                                 const std::string& docstring = "",
                                                 const void* defval = 0 );
 
      //

      const std::string& name() const;
      void setName( const std::string& name );

      std::string metadataName ATLAS_NOT_THREAD_SAFE () const;
      static std::string objectName( const std::string& metaName );

      const std::string& prefix() const;
      void setPrefix( const std::string& prefix );

      bool container() const;
      void setContainer( bool container );

      std::string toString() const;
      StatusCode read( const std::string& data );

      void clear();

      ObjectMetadata& operator+= ( const ObjectMetadata& obj );
      ObjectMetadata& merge( const ObjectMetadata& obj );

      static const size_t RANDOM_NAME_POSTFIX_LENGTH;
      static const char* const STRING_SEPARATOR;

      static const unsigned int SERIALIZER_VERSION;

      class Variable {
      public:
         Variable();
         const std::string& type() const;
         const std::string& name() const;
         const std::string& doc() const;
         bool primitive() const;
         void setType( const std::string& type );
         void setName( const std::string& name );
         void setDoc( const std::string& doc );
         void setPrimitive( bool primitive );
         std::string toString() const;
         StatusCode read( const std::string& data );
         bool operator== ( const Variable& var ) const;
         bool operator< ( const Variable& var ) const;
         static const char* const STRING_SEPARATOR;
      private:
         std::string m_type; 
         std::string m_name; 
         std::string m_doc; 
         bool m_primitive; 
      }; // class Variable

      const std::set< Variable >& variables() const;
 
   protected:
      std::set< Variable > m_variables; 
      std::string m_name; 
      std::string m_prefix; 
      bool m_container; 
 
   private:
     static std::string genSuffix ATLAS_NOT_THREAD_SAFE (const std::string& name, size_t length);
 
   }; // class ObjectMetadata

   ObjectMetadata operator+ ( const ObjectMetadata& obj1,
                              const ObjectMetadata& obj2 );
 
} // namespace D3PD
 
#endif // D3PDMAKERUTILS_OBJECTMETADATA_H