Gaudi::PluginService::v2::DeclareFactory< T, F > Struct Template Reference

Helper to declare the factory implementation for a user defined type T. More...

#include </builds/gaudi/Gaudi/GaudiPluginService/include/Gaudi/PluginServiceV2.h>

Public Types
using	DefaultFactory = Details::DefaultFactory< T, F >

Public Member Functions
	DeclareFactory (typename F::FactoryType f=DefaultFactory{}, Details::Registry::Properties props={}, source_location src_loc=source_location::current())
	DeclareFactory (const std::string &id, typename F::FactoryType f=DefaultFactory{}, Details::Registry::Properties props={}, [[maybe_unused]] source_location src_loc=source_location::current())
	DeclareFactory (Details::Registry::Properties props, source_location src_loc=source_location::current())

Static Private Member Functions
static std::string	libraryName ()
	Helper to record the name of the library that declare the factory. More...

Detailed Description

template<typename T, typename F = typename T::Factory>
struct Gaudi::PluginService::v2::DeclareFactory< T, F >

Helper to declare the factory implementation for a user defined type T.

The basic use is:

namespace {
  Gaudi::PluginService::DeclareFactory<MyComponent> __some_random_name;
}

which is the equivalent of DECLARE_COMPONENT( MyComponent ).

It's possible to specify a custom factory type (instead of the default type alias MyComponent::Factory):

namespace {
  using namespace Gaudi::PluginService;
  DeclareFactory<MyComponent, Factory<MyBase*( int, int )>> __some_random_name;
}

We can pass arguments to the constructor to use a custom factory function, or a special id, or properties:

namespace {
  using namespace Gaudi::PluginService;
  DeclareFactory<MyComponent> __some_random_name( "special-id",
                                                  []() -> MyComponent::Factory::ReturnType {
                                                    return std::make_unique<MyComponent>( "special-id" );
                                                  },
                                                  {{"MyProperty", "special"}} );
}

Definition at line 136 of file PluginServiceV2.h.

Member Typedef Documentation

DefaultFactory

template<typename T , typename F = typename T::Factory>

using Gaudi::PluginService::v2::DeclareFactory< T, F >::DefaultFactory = Details::DefaultFactory<T, F>

Definition at line 137 of file PluginServiceV2.h.

Constructor & Destructor Documentation

DeclareFactory() [1/3]

template<typename T , typename F = typename T::Factory>

Gaudi::PluginService::v2::DeclareFactory< T, F >::DeclareFactory ( typename F::FactoryType  f = DefaultFactory{}, Details::Registry::Properties  props = {}, source_location  src_loc = source_location::current()  )

inline

Definition at line 139 of file PluginServiceV2.h.

                                                                {}, Details::Registry::Properties props = {},
                        source_location src_loc = source_location::current() )
            : DeclareFactory( Details::demangle<T>(), std::move( f ), std::move( props ), src_loc ) {}

DeclareFactory() [2/3]

template<typename T , typename F = typename T::Factory>

Gaudi::PluginService::v2::DeclareFactory< T, F >::DeclareFactory ( const std::string &  id, typename F::FactoryType  f = DefaultFactory{}, Details::Registry::Properties  props = {}, [[maybe_unused] ] source_location  src_loc = source_location::current()  )

inline

Definition at line 143 of file PluginServiceV2.h.

                                                                                     {},
                        Details::Registry::Properties    props   = {},
                        [[maybe_unused]] source_location src_loc = source_location::current() ) {
          using Details::Registry;
 
          if ( props.find( "ClassName" ) == end( props ) ) props.emplace( "ClassName", Details::demangle<T>() );
          // keep only the file name
          std::string_view fn  = src_loc.file_name();
          auto             pos = fn.rfind( '/' );
          if ( pos != std::string_view::npos ) { fn.remove_prefix( pos + 1 ); }
          std::stringstream s;
          s << fn << ':' << src_loc.line();
          props["declaration_location"] = s.str();
          Registry::instance().add( id, { libraryName(), std::move( f ), std::move( props ) } );
        }

DeclareFactory() [3/3]

template<typename T , typename F = typename T::Factory>

Gaudi::PluginService::v2::DeclareFactory< T, F >::DeclareFactory ( Details::Registry::Properties  props, source_location  src_loc = source_location::current()  )

inline

Definition at line 159 of file PluginServiceV2.h.

            : DeclareFactory( DefaultFactory{}, std::move( props ), src_loc ) {}

Member Function Documentation

libraryName()

template<typename T , typename F = typename T::Factory>

static std::string Gaudi::PluginService::v2::DeclareFactory< T, F >::libraryName ( )

inlinestaticprivate

Helper to record the name of the library that declare the factory.

Definition at line 164 of file PluginServiceV2.h.

{ return Details::getDSONameFor( reinterpret_cast<void*>( libraryName ) ); }

---

The documentation for this struct was generated from the following file:

• GaudiPluginService/include/Gaudi/PluginServiceV2.h