DataObjectHandleBase.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 <mutex>
 
#include <GaudiKernel/DataHandle.h>
#include <GaudiKernel/IDataProviderSvc.h>
#include <GaudiKernel/IMessageSvc.h>
#include <GaudiKernel/IProperty.h>
#include <GaudiKernel/SmartIF.h>
 
//---------------------------------------------------------------------------

 
//---------------------------------------------------------------------------
 
class DataObjectHandleBase : public Gaudi::DataHandle {
 
public:
  DataObjectHandleBase( DataObjID k, Gaudi::DataHandle::Mode a, IDataHandleHolder* owner );
  DataObjectHandleBase( std::string k, Gaudi::DataHandle::Mode a, IDataHandleHolder* owner );
 
  ~DataObjectHandleBase() override;
  DataObjectHandleBase( const DataObjectHandleBase& ) = delete;
  DataObjectHandleBase( DataObjectHandleBase&& );
  DataObjectHandleBase& operator=( const DataObjectHandleBase& );

  template <std::derived_from<IProperty> OWNER, class K>
  inline DataObjectHandleBase( OWNER* owner, Gaudi::DataHandle::Mode m, std::string name, K key = {},
                               std::string doc = "" )
      : DataObjectHandleBase( std::move( key ), m, owner ) {
    auto p = owner->declareProperty( std::move( name ), *this, std::move( doc ) );
    p->template setOwnerType<OWNER>();
  }
 
  friend std::ostream& operator<<( std::ostream& str, const DataObjectHandleBase& d );

  bool isOptional() const { return m_optional; }
  void setOptional( bool optional = true ) { m_optional = optional; }
 
  bool isValid() const;
 
protected:
  bool init() override;
 
  DataObject* fetch() const;
 
protected:
  SmartIF<IDataProviderSvc> m_EDS;
  SmartIF<IMessageSvc>      m_MS;
 
  bool m_init     = false;
  bool m_optional = false;
};