LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag > Struct Template Reference

Creates an associated data wrapper for the specified types. More...

#include "AssociatedDataProxyMaker.h"

Public Types

using data_tag = AuxTag
 Tag labelling the associated data we are going to produce. More...
 
using main_element_t = Main
 Type of the main datum ("left"). More...
 
using aux_element_t = Aux
 Type of the auxiliary associated datum ("right"). More...
 
using metadata_t = Metadata
 Type of metadata in the association. More...
 
using aux_collection_proxy_t = details::AssociatedData< main_element_t, aux_element_t, metadata_t, data_tag >
 Type of associated data proxy being created. More...
 
using assns_t = typename aux_collection_proxy_t::assns_t
 Type of art association being used as input. More...
 

Static Public Member Functions

template<typename Event , typename Handle , typename MainArgs >
static auto make (Event const &event, Handle &&mainHandle, MainArgs const &mainArgs)
 Create a association proxy collection using main collection tag. More...
 
template<typename Event , typename Handle , typename MainArgs >
static auto make (Event const &event, Handle &&mainHandle, MainArgs const &, art::InputTag const &auxInputTag)
 Create a association proxy collection using the specified tag. More...
 
template<typename Event , typename Handle , typename MainArgs , typename Assns >
static auto make (Event const &, Handle &&, MainArgs const &, Assns const &assns)
 Create a association proxy collection using the specified tag. More...
 

Static Private Member Functions

template<typename Event , typename Handle >
static auto createFromTag (Event const &event, Handle &&mainHandle, art::InputTag const &auxInputTag)
 

Detailed Description

template<typename Main, typename Aux, typename Metadata, typename AuxTag = Aux>
struct proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >

Creates an associated data wrapper for the specified types.

Template Parameters
Maintype of main datum (element) to associate from ("left")
Auxtype of datum (element) to associate to ("right")
AuxTagtag labelling this association

Usually, AuxTag is also the type of datum (element) to associate to ("right").

This class works as a base class for AssociatedDataProxyMaker so that the specializations of the latter can still inherit from this one if they its facilities.

Definition at line 47 of file AssociatedDataProxyMaker.h.

Member Typedef Documentation

template<typename Main, typename Aux, typename Metadata, typename AuxTag = Aux>
using proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::assns_t = typename aux_collection_proxy_t::assns_t

Type of art association being used as input.

Definition at line 66 of file AssociatedDataProxyMaker.h.

template<typename Main, typename Aux, typename Metadata, typename AuxTag = Aux>
using proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::aux_collection_proxy_t = details::AssociatedData<main_element_t, aux_element_t, metadata_t, data_tag>

Type of associated data proxy being created.

Definition at line 63 of file AssociatedDataProxyMaker.h.

template<typename Main, typename Aux, typename Metadata, typename AuxTag = Aux>
using proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::aux_element_t = Aux

Type of the auxiliary associated datum ("right").

Definition at line 56 of file AssociatedDataProxyMaker.h.

template<typename Main, typename Aux, typename Metadata, typename AuxTag = Aux>
using proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::data_tag = AuxTag

Tag labelling the associated data we are going to produce.

Definition at line 50 of file AssociatedDataProxyMaker.h.

template<typename Main, typename Aux, typename Metadata, typename AuxTag = Aux>
using proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::main_element_t = Main

Type of the main datum ("left").

Definition at line 53 of file AssociatedDataProxyMaker.h.

template<typename Main, typename Aux, typename Metadata, typename AuxTag = Aux>
using proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::metadata_t = Metadata

Type of metadata in the association.

Definition at line 59 of file AssociatedDataProxyMaker.h.

Member Function Documentation

template<typename Main, typename Aux, typename Metadata, typename AuxTag = Aux>
template<typename Event , typename Handle >
static auto proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::createFromTag ( Event const &  event,
Handle &&  mainHandle,
art::InputTag const &  auxInputTag 
)
inlinestaticprivate

Definition at line 137 of file AssociatedDataProxyMaker.h.

Referenced by proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, Tag >::make().

140  {
141  return makeAssociatedDataFrom<main_element_t, aux_element_t, metadata_t, data_tag>(
142  event, auxInputTag, mainHandle->size());
143  }
Event finding and building.
template<typename Main, typename Aux, typename Metadata, typename AuxTag = Aux>
template<typename Event , typename Handle , typename MainArgs >
static auto proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::make ( Event const &  event,
Handle &&  mainHandle,
MainArgs const &  mainArgs 
)
inlinestatic

Create a association proxy collection using main collection tag.

Template Parameters
Eventtype of the event to read associations from
Handletype of handle to the main data product
MainArgsany type convertible to art::InputTag
Parameters
eventthe event to read associations from
mainHandlehandle to the main collection data product
mainArgsan object describing the main data product
Returns
an auxiliary data proxy object

The returned object exposes a random access container interface, with data indexed by the index of the corresponding object in the main collection.

The mainArgs object is of an arbitrary type that must be convertible by explicit type cast into a art::InputTag; that input tag will be used to fetch the association.

Definition at line 87 of file AssociatedDataProxyMaker.h.

88  {
89  return createFromTag(event, std::forward<Handle>(mainHandle), art::InputTag(mainArgs));
90  }
static auto createFromTag(Event const &event, Handle &&mainHandle, art::InputTag const &auxInputTag)
Event finding and building.
template<typename Main, typename Aux, typename Metadata, typename AuxTag = Aux>
template<typename Event , typename Handle , typename MainArgs >
static auto proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::make ( Event const &  event,
Handle &&  mainHandle,
MainArgs const &  ,
art::InputTag const &  auxInputTag 
)
inlinestatic

Create a association proxy collection using the specified tag.

Template Parameters
Eventtype of the event to read associations from
Handletype of handle to the main data product
MainArgsany type convertible to art::InputTag (unused)
Parameters
eventthe event to read associations from
mainHandlehandle to the main collection data product
auxInputTagthe tag of the association to be read
Returns
a auxiliary data proxy object

The returned object exposes a random access container interface, with data indexed by the index of the corresponding object in the main collection.

Definition at line 107 of file AssociatedDataProxyMaker.h.

111  {
112  return createFromTag(event, std::forward<Handle>(mainHandle), auxInputTag);
113  }
static auto createFromTag(Event const &event, Handle &&mainHandle, art::InputTag const &auxInputTag)
Event finding and building.
template<typename Main, typename Aux, typename Metadata, typename AuxTag = Aux>
template<typename Event , typename Handle , typename MainArgs , typename Assns >
static auto proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::make ( Event const &  ,
Handle &&  ,
MainArgs const &  ,
Assns const &  assns 
)
inlinestatic

Create a association proxy collection using the specified tag.

Template Parameters
Eventtype of the event to read associations from (unused)
Handletype of handle to the main data product (unused)
MainArgsany type convertible to art::InputTag (unused)
Parameters
assnsthe associations to be wrapped
Returns
a auxiliary data proxy object

The returned object exposes a random access container interface, with data indexed by the index of the corresponding object in the main collection.

Definition at line 128 of file AssociatedDataProxyMaker.h.

129  {
130  static_assert(std::is_convertible<typename Assns::right_t, aux_element_t>(),
131  "Improper right type for association.");
132  return makeAssociatedDataFrom<data_tag>(assns);
133  }

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