art::detail::ServiceCacheEntry Class Reference

#include "ServiceCacheEntry.h"

Public Member Functions
	ServiceCacheEntry (fhicl::ParameterSet const &pset, std::unique_ptr< detail::ServiceHelperBase > &&helper)
	ServiceCacheEntry (fhicl::ParameterSet const &pset, std::unique_ptr< detail::ServiceHelperBase > &&helper, ServiceCacheEntry const &impl)
	ServiceCacheEntry (WrapperBase_ptr premade_service, std::unique_ptr< detail::ServiceHelperBase > &&helper)
WrapperBase_ptr	getService (ActivityRegistry &reg, detail::ServiceStack &creationOrder) const
void	forceCreation (ActivityRegistry &reg) const
fhicl::ParameterSet const &	getParameterSet () const
template<typename T , typename = std::enable_if_t<detail::ServiceHelper<T>::scope_val != ServiceScope::PER_SCHEDULE>>
T &	get (ActivityRegistry &reg, detail::ServiceStack &creationOrder) const
template<typename T , typename = std::enable_if_t<detail::ServiceHelper<T>::scope_val == ServiceScope::PER_SCHEDULE>>
T &	get (ActivityRegistry &reg, detail::ServiceStack &creationOrder, ScheduleID sID) const
void	registerProducts (MasterProductRegistry &mpr, ProductDescriptions &productsToProduce, ProducingServiceSignals &signals, ModuleDescription const &md)
bool	is_impl () const
bool	is_interface () const
ServiceScope	serviceScope () const

Static Public Member Functions
static void	setNSchedules (size_t nSched)

Private Member Functions
void	makeAndCacheService (ActivityRegistry &reg) const
void	createService (ActivityRegistry &reg, detail::ServiceStack &creationOrder) const
void	convertService (WrapperBase_ptr &swb) const

Static Private Member Functions
static size_t &	nSchedules ()

Private Attributes
fhicl::ParameterSet	config_ {}
std::unique_ptr< detail::ServiceHelperBase >	helper_
WrapperBase_ptr	service_ {}
ServiceCacheEntry const *const	interface_impl_ {nullptr}

Detailed Description

Definition at line 31 of file ServiceCacheEntry.h.

Constructor & Destructor Documentation

art::detail::ServiceCacheEntry::ServiceCacheEntry	(	fhicl::ParameterSet const &	pset,
		std::unique_ptr< detail::ServiceHelperBase > &&	helper
	)

Definition at line 24 of file ServiceCacheEntry.cc.

References helper_.

  : config_{pset}, helper_{std::move(helper)}
{}

art::detail::ServiceCacheEntry::ServiceCacheEntry	(	fhicl::ParameterSet const &	pset,
		std::unique_ptr< detail::ServiceHelperBase > &&	helper,
		ServiceCacheEntry const &	impl
	)

Definition at line 31 of file ServiceCacheEntry.cc.

References helper_, and interface_impl_.

  : config_{pset}, helper_{std::move(helper)}, interface_impl_{&impl}
{}

art::detail::ServiceCacheEntry::ServiceCacheEntry	(	WrapperBase_ptr	premade_service,
		std::unique_ptr< detail::ServiceHelperBase > &&	helper
	)

Definition at line 39 of file ServiceCacheEntry.cc.

References service_.

  : helper_{std::move(helper)}, service_{premade_service}
{}

Member Function Documentation

void art::detail::ServiceCacheEntry::convertService ( WrapperBase_ptr &  swb ) const

inlineprivate

Definition at line 125 of file ServiceCacheEntry.h.

References art::detail::ServiceInterfaceImplHelper::convert(), is_impl(), and service_.

Referenced by getService().

{
  assert(is_impl() &&
         "ServiceCacheEntry::convertService called on a service interface!");
  swb = dynamic_cast<detail::ServiceInterfaceImplHelper&>(*helper_).convert(
    service_);
}

void art::detail::ServiceCacheEntry::createService ( ActivityRegistry &  reg, detail::ServiceStack &  creationOrder  ) const

inlineprivate

Definition at line 112 of file ServiceCacheEntry.h.

References is_impl(), makeAndCacheService(), and service_.

Referenced by getService().

{
  assert(is_impl() &&
         "ServiceCacheEntry::createService called on a service interface!");
  // When we actually create the Service object, we have to
  // remember the order of creation.
  makeAndCacheService(reg);
  creationOrder.push(service_);
}

void art::detail::ServiceCacheEntry::forceCreation ( ActivityRegistry &  reg ) const

inline

Definition at line 96 of file ServiceCacheEntry.h.

References is_impl(), makeAndCacheService(), and service_.

{
  assert(is_impl() &&
         "ServiceCacheEntry::forceCreation called on a service interface!");
  if (!service_) {
    makeAndCacheService(reg);
  }
}

template<typename T , typename >

T & art::detail::ServiceCacheEntry::get ( ActivityRegistry &  reg, detail::ServiceStack &  creationOrder  ) const

inline

Definition at line 141 of file ServiceCacheEntry.h.

References getService(), art::PER_SCHEDULE, art::detail::ServiceLGRHelper::retrieve(), and serviceScope().

{
  assert(serviceScope() != ServiceScope::PER_SCHEDULE &&
         "Called wrong service get() function: need ScheduleID");
  WrapperBase_ptr swb = getService(reg, creationOrder);
  return *reinterpret_cast<T*>(
    dynamic_cast<detail::ServiceLGRHelper&>(*helper_).retrieve(swb));
}

template<typename T , typename >

T & art::detail::ServiceCacheEntry::get ( ActivityRegistry &  reg, detail::ServiceStack &  creationOrder, ScheduleID  sID  ) const

inline

Definition at line 153 of file ServiceCacheEntry.h.

References getService(), art::PER_SCHEDULE, art::detail::ServicePSRHelper::retrieve(), and serviceScope().

{
  assert(serviceScope() == ServiceScope::PER_SCHEDULE &&
         "Called wrong service get() function!");
  WrapperBase_ptr swb = getService(reg, creationOrder);
  return *reinterpret_cast<T*>(
    dynamic_cast<detail::ServicePSRHelper&>(*helper_).retrieve(swb, sID));
}

fhicl::ParameterSet const & art::detail::ServiceCacheEntry::getParameterSet ( ) const

inline

Definition at line 106 of file ServiceCacheEntry.h.

References config_.

{
  return config_;
}

art::detail::WrapperBase_ptr art::detail::ServiceCacheEntry::getService	(	ActivityRegistry &	reg,
		detail::ServiceStack &	creationOrder
	)		const

Definition at line 48 of file ServiceCacheEntry.cc.

References convertService(), createService(), interface_impl_, is_interface(), and service_.

Referenced by get().

{
  if (is_interface()) { // Service interface
    if (!service_) {
      // No cached instance, we need to make it.
      if (!interface_impl_->service_) {
        // The service provider has no cached instance, have it make one.
        interface_impl_->createService(reg, creationOrder);
      }
      // Convert the service provider wrapper to a service interface wrapper,
      // and use that as our cached instance.
      interface_impl_->convertService(service_);
    }
  } else { // Concrete service.
    if (!service_) {
      // No cached instance, we need to make it.
      createService(reg, creationOrder);
    }
  }
  return service_;
}

bool art::detail::ServiceCacheEntry::is_impl ( ) const

inline

Definition at line 178 of file ServiceCacheEntry.h.

References is_interface().

Referenced by convertService(), createService(), forceCreation(), and makeAndCacheService().

{
  return !is_interface();
}

bool art::detail::ServiceCacheEntry::is_interface ( ) const

inline

Definition at line 184 of file ServiceCacheEntry.h.

References helper_.

Referenced by getService(), and is_impl().

{
  return helper_->is_interface();
}

void art::detail::ServiceCacheEntry::makeAndCacheService ( ActivityRegistry &  reg ) const

private

Definition at line 73 of file ServiceCacheEntry.cc.

References art::errors::BadExceptionType, art::detail::bold_fontify(), config_, art::errors::Configuration, e, fhicl::ParameterSet::get(), helper_, is_impl(), art::detail::ServicePSMHelper::make(), art::detail::ServiceLGMHelper::make(), nSchedules(), art::errors::OtherArt, art::PER_SCHEDULE, s, service_, serviceScope(), art::errors::StdException, art::errors::Unknown, and fhicl::detail::validationException::what().

Referenced by createService(), and forceCreation().

{
  assert(
    is_impl() &&
    "ServiceCacheEntry::makeAndCacheService called on a service interface!");
  try {
    if (serviceScope() == ServiceScope::PER_SCHEDULE) {
      service_ = dynamic_cast<detail::ServicePSMHelper&>(*helper_).make(
        config_, reg, nSchedules());
    } else {
      service_ =
        dynamic_cast<detail::ServiceLGMHelper&>(*helper_).make(config_, reg);
    }
  }
  catch (fhicl::detail::validationException const& e) {
    std::ostringstream err_stream;
    constexpr cet::HorizontalRule rule{100};
    err_stream << "\n"
               << rule('=') << "\n\n"
               << "!! The following service has been misconfigured: !!"
               << "\n\n"
               << rule('-') << "\n\nservice_type: "
               << art::detail::bold_fontify(
                    config_.get<std::string>("service_type"))
               << "\n\n"
               << e.what() << "\n"
               << rule('=') << "\n\n";
    throw art::Exception(art::errors::Configuration) << err_stream.str();
  }
  catch (cet::exception& e) {
    throw Exception(errors::OtherArt, "ServiceCreation", e)
      << "cet::exception caught during construction of service type "
      << cet::demangle_symbol(helper_->get_typeid().name()) << ":\n";
  }
  catch (std::exception& e) {
    throw Exception(errors::StdException, "ServiceCreation")
      << "std::exception caught during construction of service type "
      << cet::demangle_symbol(helper_->get_typeid().name()) << ": " << e.what();
  }
  catch (std::string const& s) {
    throw Exception(errors::BadExceptionType)
      << "String exception during construction of service type "
      << cet::demangle_symbol(helper_->get_typeid().name()) << ": " << s;
  }
  catch (...) {
    throw Exception(errors::Unknown)
      << "String exception during construction of service type "
      << cet::demangle_symbol(helper_->get_typeid().name()) << ":\n";
  }
}

size_t & art::detail::ServiceCacheEntry::nSchedules ( )

inlinestaticprivate

Definition at line 171 of file ServiceCacheEntry.h.

Referenced by makeAndCacheService(), and setNSchedules().

{
  static size_t s_ns{1};
  return s_ns;
}

void art::detail::ServiceCacheEntry::registerProducts	(	MasterProductRegistry &	mpr,
		ProductDescriptions &	productsToProduce,
		ProducingServiceSignals &	signals,
		ModuleDescription const &	md
	)

Definition at line 125 of file ServiceCacheEntry.cc.

References service_.

{
  service_->registerProducts(mpr, productsToProduce, signals, md);
}

art::ServiceScope art::detail::ServiceCacheEntry::serviceScope ( ) const

inline

Definition at line 134 of file ServiceCacheEntry.h.

References helper_.

Referenced by get(), and makeAndCacheService().

{
  return helper_->scope();
}

void art::detail::ServiceCacheEntry::setNSchedules ( size_t  nSched )

inlinestatic

Definition at line 165 of file ServiceCacheEntry.h.

References nSchedules().

Referenced by art::ServicesManager::fillCache_().

{
  nSchedules() = nSched;
}

Member Data Documentation

fhicl::ParameterSet art::detail::ServiceCacheEntry::config_ {}

private

Definition at line 89 of file ServiceCacheEntry.h.

Referenced by getParameterSet(), and makeAndCacheService().

std::unique_ptr<detail::ServiceHelperBase> art::detail::ServiceCacheEntry::helper_

private

Definition at line 90 of file ServiceCacheEntry.h.

Referenced by is_interface(), makeAndCacheService(), ServiceCacheEntry(), and serviceScope().

ServiceCacheEntry const* const art::detail::ServiceCacheEntry::interface_impl_ {nullptr}

private

Definition at line 92 of file ServiceCacheEntry.h.

Referenced by getService(), and ServiceCacheEntry().

WrapperBase_ptr art::detail::ServiceCacheEntry::service_ {}

mutableprivate

Definition at line 91 of file ServiceCacheEntry.h.

Referenced by convertService(), createService(), forceCreation(), getService(), makeAndCacheService(), registerProducts(), and ServiceCacheEntry().

---

The documentation for this class was generated from the following files:

• art/Framework/Services/Registry/detail/ServiceCacheEntry.h
• art/Framework/Services/Registry/detail/ServiceCacheEntry.cc