DataHeader.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef PERSISTENTDATAMODEL_DATAHEADER_H
#define PERSISTENTDATAMODEL_DATAHEADER_H

 
#include "GaudiKernel/ClassID.h"
#include "GaudiKernel/DataObject.h"
 
#include "PersistentDataModel/Token.h"
#include "SGCore/sgkey_t.h"
 
#include <string>
#include <set>
#include <vector>
 
// Forward declarations
class IOpaqueAddress;
namespace SG {
   class TransientAddress;
   class DataProxy;
}
namespace coral {
   class AttributeList;
}
class IStringPool;

class DataHeaderElement {
public: // Constructor and Destructor
   using sgkey_t = SG::sgkey_t;

   DataHeaderElement();
   DataHeaderElement(const DataHeaderElement& rhs);

   DataHeaderElement(const SG::TransientAddress* sgAddress, IOpaqueAddress* tokAddress, const std::string& pTag);

   DataHeaderElement(const SG::DataProxy* proxy, IOpaqueAddress* tokAddress, const std::string& pTag);

   DataHeaderElement(const CLID classID, const std::string& key, Token&& token);
   virtual ~DataHeaderElement();
 
public: // Non-static members
   DataHeaderElement& operator=(const DataHeaderElement& rhs);

   CLID getPrimaryClassID() const;
   const std::set<CLID> getClassIDs() const;
   const std::string& getKey() const;
   const std::vector<std::string>& getAlias() const;
   const Token* getToken() const;
   const std::vector<sgkey_t>& getHashes() const;
   SG::TransientAddress* getAddress( long storageType ) const;
   SG::TransientAddress* getAddress( long storageType, const std::string& key ) const;
   void addHash(IStringPool* pool);
 
   void dump(std::ostream& ostr) const;
 
private:
   friend class DataHeaderElementCnv_p3;
   friend class DataHeaderElementCnv_p4;
   friend class DataHeaderElementCnv_p5;
   friend class DataHeaderCnv_p6;

   DataHeaderElement(CLID clid,
                     const std::string& name,
                     const std::vector<CLID>& tClids,
                     std::vector<std::string>&& alias,
                     IOpaqueAddress* tadAddress,
                     IOpaqueAddress* tokAddress, const std::string& pTag);

   CLID m_pClid;
   std::vector<CLID> m_clids;
   std::string m_key;
   std::vector<std::string> m_alias;
   Token m_token;
   std::vector<sgkey_t> m_hashes;
};

class  DataHeader
  : public DataObject // Derive from DataObject so that it can be recyclable.
{
public:
   enum statusFlag { Output, Input, Other };
 
public: // Constructor and Destructor
   DataHeader();
   DataHeader(const DataHeader& rhs);
   virtual ~DataHeader();
 
public: // Non-static members
   DataHeader& operator=(const DataHeader& rhs);

   void setStatus(statusFlag status);
   bool isInput() const;

   void setProcessTag(const std::string& processTag);
   const std::string& getProcessTag() const;

   int size() const;
   std::vector<DataHeaderElement>::const_iterator begin() const;
   std::vector<DataHeaderElement>::const_iterator end() const;
   const std::vector<DataHeaderElement>& elements() const;

   void insert(const SG::TransientAddress* sgAddress, IOpaqueAddress* tokAddress = 0, const std::string& pTag = "");
   void insert(const SG::DataProxy* proxy, IOpaqueAddress* tokAddress = 0, const std::string& pTag = "");
   void insert(const DataHeaderElement& dhe);

   int sizeProvenance() const;
   std::vector<DataHeaderElement>::const_iterator beginProvenance() const;
   std::vector<DataHeaderElement>::const_iterator endProvenance() const;

   void insertProvenance(const DataHeaderElement& dhe);

   void addHash(IStringPool* pool);

   const std::string& dhFormToken() const;
   void setDhFormToken(const std::string& formToken);
 
   void setAttributeList(const coral::AttributeList* attrList);
   const coral::AttributeList* getAttributeList();
   void setEvtRefTokenStr(const std::string& tokenStr);
   const std::string& getEvtRefTokenStr();
 
   void dump(std::ostream& ostr) const;
 
protected:
  virtual void recycle();
 
 
private:
   friend class DataHeaderCnv_p3;
   friend class DataHeaderCnv_p4;
   friend class DataHeaderCnv_p5;
   friend class DataHeaderCnv_p6;
   friend class DataHeaderCnv;

   std::vector<DataHeaderElement> m_dataHeader;
   std::vector<DataHeaderElement> m_inputDataHeader;
   statusFlag m_status;
   std::string m_processTag;
   const coral::AttributeList* m_attrList;
   std::string m_evtRefTokenStr;
   std::string m_dhFormToken;
};
 
#include "AthenaKernel/CLASS_DEF.h"
CLASS_DEF(DataHeader, 222376821, 1)
#endif