DataObject.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiKernel/ClassID.h>
#include <GaudiKernel/StatusCode.h>
#include <atomic>
#include <memory>
#include <ostream>
#include <string>
 
// Forward declarations
class IOpaqueAddress;
class StreamBuffer;
class LinkManager;
class IRegistry;
 
// Definition of the CLID for this class
static const CLID CLID_DataObject = 1;

class GAUDI_API DataObject {
private:
  std::atomic<unsigned long> m_refCount = 0;
  unsigned char m_version = 0;
  IRegistry* m_pRegistry = nullptr;
  std::unique_ptr<LinkManager> m_pLinkMgr;
 
public:
  DataObject();
  DataObject( const DataObject& rhs );
  DataObject& operator=( const DataObject& rhs );
  DataObject( DataObject&& rhs );
  DataObject& operator=( DataObject&& rhs );
  virtual ~DataObject();
  virtual unsigned long addRef();
  virtual unsigned long release();
  virtual const CLID& clID() const;
  static const CLID& classID();
  const std::string& name() const;

  virtual StatusCode update();

  void setRegistry( IRegistry* pRegistry ) { m_pRegistry = pRegistry; }
  IRegistry* registry() const { return m_pRegistry; }
  LinkManager*       linkMgr() { return m_pLinkMgr.get(); }
  const LinkManager* linkMgr() const { return m_pLinkMgr.get(); }
  unsigned char version() const { return m_version; }
  void setVersion( unsigned char vsn ) { m_version = vsn; }
  unsigned long refCount() const { return m_refCount; }
  virtual std::ostream& fillStream( std::ostream& s ) const;
  friend std::ostream& operator<<( std::ostream& s, const DataObject& obj ) { return obj.fillStream( s ); }
};
 
// Additional functions to support the Serialization of objects in the transient store
 
namespace Gaudi {
  GAUDI_API void        pushCurrentDataObject( DataObject** pobjAddr );
  GAUDI_API void        popCurrentDataObject();
  GAUDI_API DataObject* getCurrentDataObject();
} // namespace Gaudi