proxy::SpacePointWithCharge< CollProxy > Struct Template Reference

Proxy class for charged space point proxy elements. More...

#include "ChargedSpacePoints.h"

Inheritance diagram for proxy::SpacePointWithCharge< CollProxy >:

Public Types
using	base_t = CollectionProxyElement< CollProxy >
	Base type. More...
using	collection_proxy_t = CollProxy
using	main_element_t = typename collection_proxy_t::main_element_t
using	aux_elements_t = typename details::SubstituteWithAuxList< typename collection_proxy_t::aux_collections_t >::type
	Tuple of elements (expected to be tagged types). More...

Public Member Functions
recob::PointCharge const &	chargeInfo () const
main_element_t const *	operator-> () const
	Returns a pointer to the main element. More...
main_element_t const &	operator* () const
	Returns a reference to the main element. More...
std::size_t	index () const
	Returns the index of this element in the collection. More...
template<typename Tag >
auto	get () const -> decltype(auto)
	Returns the auxiliary data specified by type (Tag). More...
template<typename Tag , typename T = Tag const&>
auto	getIf () const -> decltype(auto)
	Returns the auxiliary data specified by type (Tag). More...
Full data object access
recob::SpacePoint const &	point () const
	Returns the original space point. More...
Direct space point interface
auto	ID () const
	Returns the ID of the space point. More...
geo::Point_t	position () const
	Returns the position of the space point. More...
Direct charge interface
recob::PointCharge::Charge_t	charge () const
bool	hasCharge () const

Static Public Member Functions
template<typename Tag >
static constexpr bool	has ()
	Returns whether this class knowns about the specified type (Tag). More...

Detailed Description

template<typename CollProxy>
struct proxy::SpacePointWithCharge< CollProxy >

Proxy class for charged space point proxy elements.

Template Parameters

CollProxy

type of point proxy collection to get data from

See also

proxy::CollectionProxyElement, proxy::ChargedSpacePointsCollectionProxy

For details on the space point interface see proxy::ChargedSpacePoints.

Definition at line 240 of file ChargedSpacePoints.h.

Member Typedef Documentation

template<typename CollProxy >

using proxy::CollectionProxyElement< CollProxy >::aux_elements_t = typename details::SubstituteWithAuxList<typename collection_proxy_t::aux_collections_t>::type

inherited

Tuple of elements (expected to be tagged types).

Definition at line 166 of file CollectionProxyElement.h.

template<typename CollProxy >

using proxy::SpacePointWithCharge< CollProxy >::base_t = CollectionProxyElement<CollProxy>

Base type.

Definition at line 242 of file ChargedSpacePoints.h.

template<typename CollProxy >

using proxy::CollectionProxyElement< CollProxy >::collection_proxy_t = CollProxy

inherited

Definition at line 161 of file CollectionProxyElement.h.

template<typename CollProxy >

using proxy::CollectionProxyElement< CollProxy >::main_element_t = typename collection_proxy_t::main_element_t

inherited

Definition at line 162 of file CollectionProxyElement.h.

Member Function Documentation

template<typename CollProxy >

recob::PointCharge::Charge_t proxy::SpacePointWithCharge< CollProxy >::charge ( ) const

inline

Returns the charge associated to this point

See also

recob::PointCharge::charge()

Definition at line 282 of file ChargedSpacePoints.h.

{ return chargeInfo().charge(); }

template<typename CollProxy >

recob::PointCharge const& proxy::SpacePointWithCharge< CollProxy >::chargeInfo ( ) const

inline

Returns the recob::PointCharge object with the complete charge information.

Definition at line 258 of file ChargedSpacePoints.h.

    {
      return base_t::template get<ChargedSpacePoints::ChargeTag>();
    }

template<typename CollProxy >

template<typename Tag >

auto proxy::CollectionProxyElement< CollProxy >::get ( ) const -> decltype(auto)

inlineinherited

Returns the auxiliary data specified by type (Tag).

Definition at line 185 of file CollectionProxyElement.h.

    {
      return std::get<util::index_of_tag_v<Tag, aux_elements_t>>(fAuxData);
    }

template<typename CollProxy >

template<typename Tag , typename T >

auto proxy::CollectionProxyElement< CollProxy >::getIf ( ) const -> decltype(auto)

inherited

Returns the auxiliary data specified by type (Tag).

Template Parameters

Tag	tag of the data to fetch (usually, its type)
T	type to return (by default, a constant reference to Tag)

Returns

the auxiliary data specified by type (Tag).

Exceptions

std::logic_error

if the tag is not available.

See also

get(), has()

Deprecated:

C++17 if constexpr should be used instead (see the example below)

This method is a get() which forgives when the requested type is not available (because this proxy was configured not to hold it).

The difference with get() is the following:

decltype(auto) elem = tracks[0];
if (elem.has<recob::Hit>()) {
  auto hits = elem.get<recob::Hit>();
  // ...
}
if (elem.has<recob::SpacePoint>()) {
  auto spacepoints = elem.getIf<recob::SpacePoint>();
  // ...
}

If the proxy tracks has not been coded with recob::Hit data, the code snippet will not compile, because get() will not compile for tags that were not coded in. On the other end, if recob::Hit is coded in tracks but recob::SpacePoint is not, the snippet will compile. In that case, if the has() check had been omitted, getIt() would throw a std::logic_error exception when executed. With C++17, this will not be necessary any more by using "constexpr if":

decltype(auto) elem = tracks[0];
if constexpr (elem.has<recob::Hit>()) {
  auto hits = elem.get<recob::Hit>();
  // ...
}
if constexpr (elem.has<recob::SpacePoint>()) {
  auto spacepoints = elem.get<recob::SpacePoint>();
  // ...
}

Note

The second template argument contains the exact type returned by the function. That information is needed because this method needs to return the same type (or compatible types) whether the required tag is present or not, in order for user code like

if (elem.has<recob::SpacePoint>()) {
  recob::SpacePoint const* spacepoints
    = elem.getIf<recob::SpacePoint>(); // won't do
  // ...
}

to work; it becomes:

if (elem.has<recob::SpacePoint>()) {
  recob::SpacePoint const* spacepoints
    = elem.getIf<recob::SpacePoint, recob::SpacePoint const*>();
  // ...
}

This is necessary because when the tag (in the example, recob::SpacePoint) is not registered in the proxy, getIf() has no clue of what the return value should be ("which is the type of the data that does not exist?").

Definition at line 351 of file CollectionProxyElement.h.

  {
    return getIfHas<Tag, T>(std::bool_constant<has<Tag>()>{});
  }

template<typename CollProxy >

template<typename Tag >

static constexpr bool proxy::CollectionProxyElement< CollProxy >::has ( )

inlinestaticinherited

Returns whether this class knowns about the specified type (Tag).

Definition at line 266 of file CollectionProxyElement.h.

    {
      return util::has_tag_v<Tag, aux_elements_t>;
    }

template<typename CollProxy >

bool proxy::SpacePointWithCharge< CollProxy >::hasCharge ( ) const

inline

Returns whether the charge associated to the space point is valid.

See also

recob::PointCharge::hasCharge()

Definition at line 286 of file ChargedSpacePoints.h.

{ return chargeInfo().hasCharge(); }

template<typename CollProxy >

auto proxy::SpacePointWithCharge< CollProxy >::ID ( ) const

inline

Returns the ID of the space point.

Definition at line 268 of file ChargedSpacePoints.h.

{ return point().ID(); }

template<typename CollProxy >

std::size_t proxy::CollectionProxyElement< CollProxy >::index ( ) const

inlineinherited

Returns the index of this element in the collection.

Definition at line 181 of file CollectionProxyElement.h.

{ return fIndex; };

template<typename CollProxy >

main_element_t const& proxy::CollectionProxyElement< CollProxy >::operator* ( ) const

inlineinherited

Returns a reference to the main element.

Definition at line 178 of file CollectionProxyElement.h.

{ return *fMain; }

template<typename CollProxy >

main_element_t const* proxy::CollectionProxyElement< CollProxy >::operator-> ( ) const

inlineinherited

Returns a pointer to the main element.

Definition at line 175 of file CollectionProxyElement.h.

{ return fMain; }

template<typename CollProxy >

recob::SpacePoint const& proxy::SpacePointWithCharge< CollProxy >::point ( ) const

inline

Returns the original space point.

Definition at line 251 of file ChargedSpacePoints.h.

References operator*().

{ return base_t::operator*(); }

template<typename CollProxy >

geo::Point_t proxy::SpacePointWithCharge< CollProxy >::position ( ) const

inline

Returns the position of the space point.

Definition at line 271 of file ChargedSpacePoints.h.

References geo::vect::makePointFromCoords().

{ return geo::vect::makePointFromCoords(point().XYZ()); }

---

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

• lardata/v09_16_03/source/lardata/RecoBaseProxy/ChargedSpacePoints.h