| The Gaudi Framework v29r1 (5cd95fa2)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

MergingTransformer.h
Go to the documentation of this file.
1 #ifndef MERGING_TRANSFORMER_H
2 #define MERGING_TRANSFORMER_H
3
4 #include <functional>
5 #include <string>
6 #include <vector>
7
8 #include "GaudiAlg/FunctionalDetails.h"
9 #include "GaudiAlg/FunctionalUtilities.h"
10
11 namespace Gaudi
12 {
13 namespace Functional
14 {
15
16 template <typename Signature, typename Traits_ = Traits::useDefaults>
17 class MergingTransformer;
18
19 using details::vector_of_const_;
20
22 template <typename Out, typename In, typename Traits_>
23 class MergingTransformer<Out( const vector_of_const_<In>& ), Traits_>
24 : public details::DataHandleMixin<std::tuple<Out>, void, Traits_>
25 {
26 using base_class = details::DataHandleMixin<std::tuple<Out>, void, Traits_>;
27
28 public:
29 using KeyValue = std::pair<std::string, std::string>;
30 using KeyValues = std::pair<std::string, std::vector<std::string>>;
31
32 MergingTransformer( const std::string& name, ISvcLocator* locator, const KeyValues& inputs,
33 const KeyValue& output );
34
35 // derived classes can NOT implement execute
36 StatusCode execute() override final;
37
38 virtual Out operator()( const vector_of_const_<In>& inputs ) const = 0;
39
40 private:
41 // if In is a pointer, it signals optional (as opposed to mandatory) input
42 template <typename T>
43 using InputHandle_t = details::InputHandle_t<Traits_, typename std::remove_pointer<T>::type>;
44 std::vector<std::string> m_inputLocations; // TODO/FIXME: remove this duplication...
45 std::vector<InputHandle_t<In>> m_inputs; // and make the handles properties instead...
46 };
47
48 template <typename Out, typename In, typename Traits_>
49 MergingTransformer<Out( const vector_of_const_<In>& ), Traits_>::MergingTransformer( const std::string& name,
50 ISvcLocator* pSvcLocator,
51 const KeyValues& inputs,
52 const KeyValue& output )
53 : base_class( name, pSvcLocator, output ), m_inputLocations( inputs.second )
54 {
55 // TODO/FIXME: replace vector of string property + call-back with a
56 // vector<handle> property ... as soon as declareProperty can deal with that.
57 auto p = this->declareProperty( inputs.first, m_inputLocations );
58 p->declareUpdateHandler( [=]( Gaudi::Details::PropertyBase& ) {
59 this->m_inputs = details::make_vector_of_handles<decltype( this->m_inputs )>( this, m_inputLocations,
60 Gaudi::DataHandle::Reader );
61 if ( std::is_pointer<In>::value ) { // handle constructor does not (yet) allow to set optional flag... so do it
62 // explicitly here...
63 std::for_each( this->m_inputs.begin(), this->m_inputs.end(), []( auto& h ) { h.setOptional( true ); } );
64 }
65 } );
66 p->useUpdateHandler(); // invoke call-back now, to be sure the input handles are synced with the property...
67 }
68
69 template <typename Out, typename In, typename Traits_>
70 StatusCode MergingTransformer<Out( const vector_of_const_<In>& ), Traits_>::execute()
71 {
72 vector_of_const_<In> ins;
73 ins.reserve( m_inputs.size() );
74 std::transform( m_inputs.begin(), m_inputs.end(), std::back_inserter( ins ),
75 details::details2::get_from_handle<In>{} );
76 try {
77 using details::as_const;
78 details::put( std::get<0>( this->m_outputs ), as_const( *this )( as_const( ins ) ) );
79 } catch ( GaudiException& e ) {
80 ( e.code() ? this->warning() : this->error() ) << e.message() << endmsg;
81 return e.code();
82 }
83 return StatusCode::SUCCESS;
84 }
85 }
86 }
87
88 #endif
GaudiException::message
virtual const std::string & message() const
error message to be printed
Definition: GaudiException.h:99
StatusCode::SUCCESS
Definition: StatusCode.h:31
Gaudi::Functional::details::as_const
constexpr std::add_const< T >::type & as_const(T &t) noexcept
Definition: FunctionalDetails.h:104
GaudiException
Define general base for Gaudi exception.
Definition: GaudiException.h:22
ISvcLocator
The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to loc...
Definition: ISvcLocator.h:25
Gaudi::Functional::details::make_vector_of_handles
Handles make_vector_of_handles(IDataHandleHolder *owner, const std::vector< std::string > &init, Gaudi::DataHandle::Mode mode)
Definition: FunctionalDetails.h:423
gaudiComponentHelp.name
name
Definition: gaudiComponentHelp.py:32
std::is_pointer
gaudirun.output
output
Definition: gaudirun.py:404
Gaudi::Functional::execute
StatusCode execute() override final
Containers::vector
struct GAUDI_API vector
Parametrisation class for vector-like implementation.
Definition: KeyedObjectManager.h:30
std
STL namespace.
Gaudi::Functional::void
class MergingTransformer< Out(const vector_of_const_< In > void
Definition: MergingTransformer.h:23
Gaudi::Functional::InputHandle_t
details::InputHandle_t< Traits_, typename std::remove_pointer< T >::type > InputHandle_t
Definition: MergingTransformer.h:43
Gaudi::Functional::details::details2::get_from_handle
Definition: FunctionalDetails.h:228
Gaudi::DataHandle::Reader
Definition: DataHandle.h:31
Gaudi::Functional::details::vector_of_const_
Definition: FunctionalDetails.h:256
GaudiException::code
virtual const StatusCode & code() const
StatusCode for Exception.
Definition: GaudiException.h:119
Gaudi::Units::second
constexpr double second
Definition: SystemOfUnits.h:123
std::string
STL class.
BrunelScenarioForwardScheduler.inputs
inputs
Definition: BrunelScenarioForwardScheduler.py:133
Gaudi::Functional::details::DataHandleMixin
Definition: FunctionalDetails.h:438
Gaudi::Functional::MergingTransformer
Definition: MergingTransformer.h:17
HiveAlgSequencer.h
h
Definition: HiveAlgSequencer.py:24
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:28
declareProperty
Gaudi::Details::PropertyBase * declareProperty(const std::string &name, TYPE &value, const std::string &doc="none")
Declare a property (templated)
gaudirun.type
type
Definition: gaudirun.py:133
FunctionalUtilities.h
Gaudi::Details::PropertyBase
PropertyBase base class allowing PropertyBase* collections to be "homogeneous".
Definition: Property.h:32
Gaudi::Functional::m_inputLocations
std::vector< std::string > m_inputLocations
Definition: MergingTransformer.h:44
std::tuple
std::pair< std::string, std::string >
Gaudi::Functional::m_inputs
std::vector< InputHandle_t< In > > m_inputs
Definition: MergingTransformer.h:45
std::back_inserter
T back_inserter(T...args)
Gaudi::Functional::MergingTransformer
MergingTransformer(const std::string &name, ISvcLocator *locator, const KeyValues &inputs, const KeyValue &output)
Definition: MergingTransformer.h:49
Gaudi::Functional::Traits_
struct[[deprecated("use MergingTransformer instead")]] Traits_
Definition: ListTransformer.h:14
std::transform
T transform(T...args)
std::for_each
T for_each(T...args)
Gaudi
Helper functions to set/get the application return code.
Definition: __init__.py:1
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
Gaudi::Functional::details::put
Out1 * put(DataObjectHandle< Out1 > &out_handle, Out2 &&out)
Definition: FunctionalDetails.h:116
FunctionalDetails.h