Converter.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
 
// generic experiment headers
#include <GaudiKernel/ConversionSvc.h>
#include <GaudiKernel/IConverter.h>
#include <GaudiKernel/IDataManagerSvc.h>
#include <GaudiKernel/IDataProviderSvc.h>
#include <GaudiKernel/IService.h>
#include <GaudiKernel/ISvcLocator.h>
 
// Forward declarations
class IMessageSvc;
class IRegistry;

class GAUDI_API Converter : public implements<IConverter> {
public:
  using Factory = Gaudi::PluginService::Factory<IConverter*( ISvcLocator* )>;

  StatusCode initialize() override;

  StatusCode finalize() override;

  StatusCode setDataProvider( IDataProviderSvc* svc ) override;

  SmartIF<IDataProviderSvc>& dataProvider() const override;

  StatusCode setConversionSvc( IConversionSvc* svc ) override;

  SmartIF<IConversionSvc>& conversionSvc() const override;

  StatusCode setAddressCreator( IAddressCreator* creator ) override;

  SmartIF<IAddressCreator>& addressCreator() const override;

  const CLID& objType() const override;

  // MSF: Masked to generate compiler error due to interface change
  virtual long i_repSvcType() const;

  StatusCode createObj( IOpaqueAddress* pAddress, DataObject*& refpObject ) override;

  StatusCode fillObjRefs( IOpaqueAddress* pAddress, DataObject* pObject ) override;

  StatusCode updateObj( IOpaqueAddress* pAddress, DataObject* refpObject ) override;

  StatusCode updateObjRefs( IOpaqueAddress* pAddress, DataObject* pObject ) override;

  StatusCode createRep( DataObject* pObject, IOpaqueAddress*& refpAddress ) override;

  StatusCode fillRepRefs( IOpaqueAddress* pAddress, DataObject* pObject ) override;

  StatusCode updateRep( IOpaqueAddress* pAddress, DataObject* pObject ) override;

  StatusCode updateRepRefs( IOpaqueAddress* pAddress, DataObject* pObject ) override;

  Converter( long storage_type, const CLID& class_type, ISvcLocator* svc = 0 );

  SmartIF<IService> service( const std::string& name, const bool createIf = true ) const;
 
protected:
  SmartIF<ISvcLocator>& serviceLocator() const;
  SmartIF<IMessageSvc>& msgSvc() const;
  SmartIF<IDataManagerSvc>& dataManager() const;
 
private:
  long m_storageType;
  const CLID m_classType;
  mutable SmartIF<IAddressCreator> m_addressCreator;
  mutable SmartIF<IDataProviderSvc> m_dataProvider;
  mutable SmartIF<IDataManagerSvc> m_dataManager;
  mutable SmartIF<IConversionSvc> m_conversionSvc;
  mutable SmartIF<ISvcLocator> m_svcLocator;
  mutable SmartIF<IMessageSvc> m_messageSvc;
};
 
// Identified class for converters' factories
class GAUDI_API ConverterID final {
public:
  ConverterID( long stype, CLID clid ) : m_stype( stype ), m_clid( clid ) {}
  inline bool operator==( const ConverterID& id ) const { return m_stype == id.m_stype && m_clid == id.m_clid; }
 
private:
  friend std::ostream& operator<<( std::ostream&, const ConverterID& );
  long                 m_stype;
  CLID                 m_clid;
};
 
inline std::ostream& operator<<( std::ostream& s, const ConverterID& id ) {
  return s << "CNV_" << id.m_stype << "_" << id.m_clid;
}
 
// Macro to declare component factories
#define DECLARE_CONVERTER( x ) DECLARE_COMPONENT_WITH_ID( x, ConverterID( x::storageType(), x::classID() ) )