proxy::AssociatedDataProxyMaker< Main, Aux, Metadata, CollProxy, Tag > Class Template Reference

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

#include "AssociatedDataProxyMaker.h"

Inheritance diagram for proxy::AssociatedDataProxyMaker< Main, Aux, Metadata, CollProxy, Tag >:

Public Types
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...
using	data_tag = Tag
	Tag labelling the associated data we are going to produce. More...

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

Private Types
using	base_t = AssociatedDataProxyMakerBase< Main, Aux, Metadata, Tag >

Detailed Description

template<typename Main, typename Aux, typename Metadata, typename CollProxy, typename Tag = Aux>
class proxy::AssociatedDataProxyMaker< Main, Aux, Metadata, CollProxy, Tag >

Creates an associated data wrapper for the specified types.

Template Parameters

Main	type of main datum (element) to associate from ("left")
Aux	type of datum (element) to associate to ("right")
CollProxy	type of proxy this associated data works for
Tag	tag for the association proxy to be created

See also

withAssociated() This class is (indirectly) called when using proxy::withAssociated() in getCollection(). Its task is to supervise the creation of the proxy to the data association between the main data type and an auxiliary one. The interface required by withAssociated() includes:

• a static make() method creating and returning the associated data proxy with arguments an event, the main data product handle, a template argument representing the main collection information, and all the arguments required for the creation of the associated proxy (coming from withAssociated()); equivalent to the signature:

  template <typename Event, typename Handle, typename MainArg, typename... Args>
  auto make(Event const&, Handle&&, MainArg const&, Args&&...);

This class can be specialized (see withAssociated() for an example). The default implementation just wraps a one-to-many art::Assns<Main, Aux> data product fulfilling "one-to-many sequential association" requirement (see the "Definitions" section in ProxyBase.h documentation).

The last template argument is designed for specialization of associations in the context of a specific proxy type.

Definition at line 180 of file AssociatedDataProxyMaker.h.

Member Typedef Documentation

template<typename Main , typename Aux , typename Metadata , typename CollProxy , typename Tag = 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 CollProxy , typename Tag = 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 CollProxy , typename Tag = 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 CollProxy , typename Tag = Aux>

using proxy::AssociatedDataProxyMaker< Main, Aux, Metadata, CollProxy, Tag >::base_t = AssociatedDataProxyMakerBase<Main, Aux, Metadata, Tag>

private

Definition at line 186 of file AssociatedDataProxyMaker.h.

using proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, Tag >::data_tag = Tag

inherited

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 CollProxy , typename Tag = 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 CollProxy , typename Tag = 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

static auto proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, Tag >::make ( Event const &  event, Handle &&  mainHandle, MainArgs const &  mainArgs  )

inlinestaticinherited

Create a association proxy collection using main collection tag.

Template Parameters

Event	type of the event to read associations from
Handle	type of handle to the main data product
MainArgs	any type convertible to art::InputTag

Parameters

event	the event to read associations from
mainHandle	handle to the main collection data product
mainArgs	an 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.

References proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::createFromTag().

    {
      return createFromTag(event, std::forward<Handle>(mainHandle), art::InputTag(mainArgs));
    }

static auto proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, Tag >::make ( Event const &  event, Handle &&  mainHandle, MainArgs const &  , art::InputTag const &  auxInputTag  )

inlinestaticinherited

Create a association proxy collection using the specified tag.

Template Parameters

Event	type of the event to read associations from
Handle	type of handle to the main data product
MainArgs	any type convertible to art::InputTag (unused)

Parameters

event	the event to read associations from
mainHandle	handle to the main collection data product
auxInputTag	the 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.

References proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, AuxTag >::createFromTag().

    {
      return createFromTag(event, std::forward<Handle>(mainHandle), auxInputTag);
    }

static auto proxy::AssociatedDataProxyMakerBase< Main, Aux, Metadata, Tag >::make ( Event const &  , Handle &&  , MainArgs const &  , Assns const &  assns  )

inlinestaticinherited

Create a association proxy collection using the specified tag.

Template Parameters

Event	type of the event to read associations from (unused)
Handle	type of handle to the main data product (unused)
MainArgs	any type convertible to art::InputTag (unused)

Parameters

assns

the 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.

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

template<typename Main , typename Aux , typename Metadata , typename CollProxy , typename Tag = Aux>

template<typename Event , typename Handle , typename MainArgs , typename... Args>

static auto proxy::AssociatedDataProxyMaker< Main, Aux, Metadata, CollProxy, Tag >::make ( Event const &  event, Handle &&  mainHandle, MainArgs const &  margs, Args &&...  args  )

inlinestatic

Create a association proxy collection using main collection tag.

Template Parameters

Event	type of the event to read associations from
Handle	type of data product handle
MainArgs	any type convertible to art::InputTag
Args	optional single type (art::InputTag required)

Parameters

event	the event to read associations from
mainHandle	handle of the main collection data product
margs	an object describing the main data product
args	input tag for associated data, if different from main

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.

This implementation requires margs object to be convertible by explicit type cast into a art::InputTag; that input tag will be used to fetch the association.

Definition at line 225 of file AssociatedDataProxyMaker.h.

References art::InputSourceFactory::make().

    {
      return base_t::make(
        event, std::forward<Handle>(mainHandle), margs, std::forward<Args>(args)...);
    }

---

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

• lardata/v09_16_03/source/lardata/RecoBaseProxy/ProxyBase/AssociatedDataProxyMaker.h