| The Gaudi Framework v28r2p1 (f1a77ff4)

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

- File List
- File Members

SplittingTransformer.h
Go to the documentation of this file.
1 #ifndef SPLITTING_TRANSFORMER_H
2 #define SPLITTING_TRANSFORMER_H
3
4 #include <vector>
5 #include <string>
6 #include <functional>
7
8 #include "GaudiAlg/FunctionalDetails.h"
9 #include "GaudiAlg/FunctionalUtilities.h"
10
11 namespace Gaudi { namespace Functional {
12
13 template <typename Signature, typename Traits_=Traits::useDefaults> class SplittingTransformer;
14
15 template <typename Container> using vector_of_ = std::vector<Container>;
16 template <typename Container> using vector_of_optional_ = std::vector<boost::optional<Container>>;
17
19 template <typename Out, typename... In, typename Traits_>
20 class SplittingTransformer<vector_of_<Out>(const In&...),Traits_>
21 : public details::DataHandleMixin<void,std::tuple<In...>,Traits_>
22 {
23 using base_class = details::DataHandleMixin<void,std::tuple<In...>,Traits_>;
24 public:
25 constexpr static std::size_t N = sizeof...(In);
26 using KeyValue = std::pair<std::string, std::string>;
27 using KeyValues = std::pair<std::string, std::vector<std::string>>;
28
29 SplittingTransformer(const std::string& name, ISvcLocator* locator,
30 const std::array<KeyValue,N>& inputs,
31 const KeyValues& output);
32
33 SplittingTransformer(const std::string& name, ISvcLocator* locator,
34 const KeyValue& input,
35 const KeyValues& output)
36 : SplittingTransformer( name, locator, std::array<KeyValue,1>{ input }, output )
37 {
38 static_assert(N==1,"single input argument requires single input signature");
39 }
40
41 // accessor to output Locations
42 const std::string& outputLocation(unsigned int n) const { return m_outputLocations[n]; }
43 unsigned int outputLocationSize() const { return m_outputLocations.size(); }
44
45 // derived classes can NOT implement execute
46 StatusCode execute() override final
47 { return invoke(std::index_sequence_for<In...>{}); }
48
49 // TODO/FIXME: how does the callee know in which order to produce the outputs?
50 // (note: 'missing' items can be specified by making Out an boost::optional<Out>,
51 // and only those entries which contain an Out are stored)
52 virtual vector_of_<Out> operator()(const In&... ) const = 0;
53
54 private:
55 template <std::size_t... I> StatusCode invoke(std::index_sequence<I...>)
56 {
57 try {
58 //TODO:FIXME: how does operator() know the number and order of expected outputs?
59 using details::as_const;
60 auto out = as_const(*this)( as_const(*std::get<I>(this->m_inputs).get())... );
61 if (out.size()!=m_outputs.size()) {
62 throw GaudiException( "Error during transform: expected " + std::to_string(m_outputs.size())
63 + " containers, got " + std::to_string(out.size()) + " instead",
64 this->name(),
65 StatusCode::FAILURE );
66 }
67 for (unsigned i=0;i!=out.size();++i) details::put( m_outputs[i], std::move(out[i]) );
68 } catch ( GaudiException& e ) {
69 (e.code() ? this->warning() : this->error() ) << e.message() << endmsg;
70 return e.code();
71 }
72 return StatusCode::SUCCESS;
73 }
74 template <typename T> using OutputHandle = details::OutputHandle_t<Traits_,details::remove_optional_t<T>>;
75 std::vector<std::string> m_outputLocations; //TODO/FIXME for now: use a call-back to update the actual handles!
76 std::vector<OutputHandle<Out>> m_outputs;
77 };
78
79
80 template <typename Out, typename... In, typename Traits_>
81 SplittingTransformer<vector_of_<Out>(const In&...),Traits_>
82 ::SplittingTransformer( const std::string& name, ISvcLocator* pSvcLocator,
83 const std::array<KeyValue,N>& inputs, const KeyValues& outputs )
84 : base_class ( name , pSvcLocator, inputs )
85 , m_outputLocations( outputs.second )
86 {
87 auto p = this->declareProperty( outputs.first, m_outputLocations );
88 p->declareUpdateHandler( [=](Gaudi::Details::PropertyBase&) {
89 this->m_outputs = details::make_vector_of_handles<decltype(this->m_outputs)>(this, m_outputLocations, Gaudi::DataHandle::Writer);
90 if (details::is_optional<Out>::value) { // handle constructor does not (yet) allow to set optional flag... so do it explicitly here...
91 std::for_each( this->m_outputs.begin(), this->m_outputs.end(), [](auto& h) { h.setOptional(true); } );
92 }
93 } );
94 p->useUpdateHandler(); // invoke now, to be sure the input handles are synced with the property...
95 }
96
97
98 }}
99
100 #endif
Gaudi::Functional::SplittingTransformer
Definition: SplittingTransformer.h:13
GaudiException::message
virtual const std::string & message() const
error message to be printed
Definition: GaudiException.h:111
Gaudi::Functional::details::is_optional
Definition: FunctionalDetails.h:146
StatusCode::SUCCESS
Definition: StatusCode.h:30
Gaudi::Functional::details::as_const
constexpr std::add_const< T >::type & as_const(T &t) noexcept
Definition: FunctionalDetails.h:77
Gaudi::Functional::details::DataHandleMixin< void, std::tuple< In... >, Traits_ >
Definition: FunctionalDetails.h:376
GaudiException
Define general base for Gaudi exception.
Definition: GaudiException.h:23
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:306
gaudiComponentHelp.name
name
Definition: gaudiComponentHelp.py:28
StatusCode::FAILURE
Definition: StatusCode.h:29
gaudirun.output
output
Definition: gaudirun.py:388
std::to_string
T to_string(T...args)
std
STL namespace.
Gaudi::Functional::void
class MergingTransformer< Out(const vector_of_const_< In > void
Definition: MergingTransformer.h:19
std::size_t
GaudiException::code
virtual const StatusCode & code() const
StatusCode for Exception.
Definition: GaudiException.h:127
Gaudi::Units::second
constexpr double second
Definition: SystemOfUnits.h:122
std::string
STL class.
GaudiPluginService.cpluginsvc.n
n
Definition: cpluginsvc.py:217
IOTest.N
int N
Definition: IOTest.py:90
BrunelScenarioForwardScheduler.inputs
inputs
Definition: BrunelScenarioForwardScheduler.py:123
Gaudi::Functional::details::DataHandleMixin
Definition: FunctionalDetails.h:317
Gaudi::Functional::SplittingTransformer< vector_of_< Out >(const In &...), Traits_ >::outputLocation
const std::string & outputLocation(unsigned int n) const
Definition: SplittingTransformer.h:42
Gaudi::Functional::SplittingTransformer< vector_of_< Out >(const In &...), Traits_ >::outputLocationSize
unsigned int outputLocationSize() const
Definition: SplittingTransformer.h:43
HiveAlgSequencer.h
h
Definition: HiveAlgSequencer.py:24
Gaudi::Functional::SplittingTransformer< vector_of_< Out >(const In &...), Traits_ >::OutputHandle
details::OutputHandle_t< Traits_, details::remove_optional_t< T >> OutputHandle
Definition: SplittingTransformer.h:74
Gaudi::Functional::Traits_
class MergingTransformer< Out(const vector_of_const_< In > Traits_
Definition: MergingTransformer.h:19
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
declareProperty
Gaudi::Details::PropertyBase * declareProperty(const std::string &name, TYPE &value, const std::string &doc="none")
Declare a property (templated)
Gaudi::Functional::SplittingTransformer< vector_of_< Out >(const In &...), Traits_ >::m_outputs
std::vector< OutputHandle< Out > > m_outputs
Definition: SplittingTransformer.h:76
FunctionalUtilities.h
Gaudi::Functional::SplittingTransformer< vector_of_< Out >(const In &...), Traits_ >::SplittingTransformer
SplittingTransformer(const std::string &name, ISvcLocator *locator, const KeyValue &input, const KeyValues &output)
Definition: SplittingTransformer.h:33
Gaudi::Functional::vector_of_
details::template vector_of_const_< Container > vector_of_
Definition: ListTransformer.h:7
Gaudi::Details::PropertyBase
PropertyBase base class allowing PropertyBase* collections to be "homogeneous".
Definition: Property.h:32
Gaudi::Functional::SplittingTransformer< vector_of_< Out >(const In &...), Traits_ >::m_outputLocations
std::vector< std::string > m_outputLocations
Definition: SplittingTransformer.h:75
std::move
T move(T...args)
std::tuple
std::pair< std::string, std::string >
Gaudi::Functional::SplittingTransformer< vector_of_< Out >(const In &...), Traits_ >::execute
StatusCode execute() override final
Definition: SplittingTransformer.h:46
Gaudi::Functional::details::OutputHandle_t
detected_or_t_< detail2::defaultHandle_, detail2::OutputHandle_, Tr, T > OutputHandle_t
Definition: FunctionalDetails.h:268
Gaudi::Functional::m_inputs
std::vector< InputHandle_t< In > > m_inputs
Definition: MergingTransformer.h:39
Containers::array
struct GAUDI_API array
Parametrisation class for redirection array - like implementation.
Definition: KeyedObjectManager.h:27
std::vector
STL class.
Gaudi::Functional::operator()
virtual Out operator()(const vector_of_const_< In > &inputs) const =0
std::array
STL class.
Gaudi::DataHandle::Writer
Definition: DataHandle.h:32
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:244
Gaudi::Functional::details::put
Out1 * put(DataObjectHandle< Out1 > &out_handle, Out2 &&out)
Definition: FunctionalDetails.h:87
Gaudi::Functional::SplittingTransformer< vector_of_< Out >(const In &...), Traits_ >::invoke
StatusCode invoke(std::index_sequence< I... >)
Definition: SplittingTransformer.h:55
FunctionalDetails.h