ACTS
Experiment-independent tracking
Loading...
Searching...
No Matches
Acts::SpacePointContainer< container_t, holder_t > Class Template Reference

Container wrapper providing space point proxy access. More...

#include <Acts/EventData/SpacePointContainer.hpp>

Public Types

using const_iterator
 Const iterator type.
using iterator
 Iterator type.
using ProxyType = SpacePointProxyType
 Proxy type.
using size_type = std::size_t
 Size type.
using SpacePointProxyType
 space point proxy type
using value_type = ProxyType
 Value type.
using ValueType = typename container_t::ValueType
 Value type of the underlying container.

Public Member Functions

template<template< typename > class H = holder_t, typename = std::enable_if_t<Acts::detail::is_same_template< H, Acts::detail::RefHolder>::value>>
 SpacePointContainer (const Acts::SpacePointContainerConfig &config, const Acts::SpacePointContainerOptions &options, const container_t &container)
 Construct from config, options, and container reference.
template<template< typename > class H = holder_t, typename = std::enable_if_t<Acts::detail::is_same_template< H, Acts::detail::ValueHolder>::value>>
 SpacePointContainer (const Acts::SpacePointContainerConfig &config, const Acts::SpacePointContainerOptions &options, container_t &&container)
 Construct from config, options, and container by moving ownership.
 SpacePointContainer (SpacePointContainer &&other) noexcept=default
 Move constructor.
 SpacePointContainer (SpacePointContainer &other)=delete
ProxyTypeat (const std::size_t n)
 Access space point proxy at index n.
const ProxyTypeat (const std::size_t n) const
 Access const space point proxy at index n.
iterator begin ()
 Return an iterator to the beginning.
const_iterator begin () const
 Return a const iterator to the beginning.
const_iterator cbegin () const
 Return a const iterator to the beginning.
const_iterator cend () const
 Return a const iterator to the end.
iterator end ()
 Return an iterator to the end.
const_iterator end () const
 Return a const iterator to the end.
SpacePointContaineroperator= (SpacePointContainer &&other) noexcept=default
 Move assignment operator.
SpacePointContaineroperator= (SpacePointContainer &other)=delete
std::size_t size () const
 Return the number of space points.
const ValueTypesp (const std::size_t n) const
 Access underlying space point value at index n.

Detailed Description

template<typename container_t, template< typename > class holder_t>
class Acts::SpacePointContainer< container_t, holder_t >

Container wrapper providing space point proxy access.

Member Typedef Documentation

◆ const_iterator

template<typename container_t, template< typename > class holder_t>
using Acts::SpacePointContainer< container_t, holder_t >::const_iterator
Initial value:
detail::ContainerIterator<
const SpacePointProxyType&, std::size_t, true>
Container wrapper providing space point proxy access.
Definition SpacePointContainer.hpp:49
Acts::SpacePointProxy< Acts::SpacePointContainer< container_t, holder_t > > SpacePointProxyType
space point proxy type
Definition SpacePointContainer.hpp:56

Const iterator type.

◆ iterator

template<typename container_t, template< typename > class holder_t>
using Acts::SpacePointContainer< container_t, holder_t >::iterator
Initial value:
detail::ContainerIterator<
std::size_t, false>

Iterator type.

◆ SpacePointProxyType

template<typename container_t, template< typename > class holder_t>
using Acts::SpacePointContainer< container_t, holder_t >::SpacePointProxyType
Initial value:
Proxy giving read access to space point data in a container.
Definition SpacePointProxy.hpp:22

space point proxy type

Constructor & Destructor Documentation

◆ SpacePointContainer() [1/3]

template<typename container_t, template< typename > class holder_t>
template<template< typename > class H = holder_t, typename = std::enable_if_t<Acts::detail::is_same_template< H, Acts::detail::RefHolder>::value>>
Acts::SpacePointContainer< container_t, holder_t >::SpacePointContainer ( const Acts::SpacePointContainerConfig & config,
const Acts::SpacePointContainerOptions & options,
const container_t & container )

Construct from config, options, and container reference.

Parameters
configConfiguration for the space point container
optionsOptions for the space point container
containerReference to the underlying space point container

◆ SpacePointContainer() [2/3]

template<typename container_t, template< typename > class holder_t>
template<template< typename > class H = holder_t, typename = std::enable_if_t<Acts::detail::is_same_template< H, Acts::detail::ValueHolder>::value>>
Acts::SpacePointContainer< container_t, holder_t >::SpacePointContainer ( const Acts::SpacePointContainerConfig & config,
const Acts::SpacePointContainerOptions & options,
container_t && container )

Construct from config, options, and container by moving ownership.

Parameters
configConfiguration for the space point container
optionsOptions for the space point container
containerRvalue reference to the underlying space point container

◆ SpacePointContainer() [3/3]

template<typename container_t, template< typename > class holder_t>
Acts::SpacePointContainer< container_t, holder_t >::SpacePointContainer ( SpacePointContainer< container_t, holder_t > && other)
defaultnoexcept

Move constructor.

Parameters
otherspace point container to move from

Member Function Documentation

◆ at() [1/2]

template<typename container_t, template< typename > class holder_t>
ProxyType & Acts::SpacePointContainer< container_t, holder_t >::at ( const std::size_t n)

Access space point proxy at index n.

Parameters
nIndex of the space point
Returns
Reference to the space point proxy

◆ at() [2/2]

template<typename container_t, template< typename > class holder_t>
const ProxyType & Acts::SpacePointContainer< container_t, holder_t >::at ( const std::size_t n) const

Access const space point proxy at index n.

Parameters
nIndex of the space point
Returns
Const reference to the space point proxy

◆ begin() [1/2]

template<typename container_t, template< typename > class holder_t>
iterator Acts::SpacePointContainer< container_t, holder_t >::begin ( )

Return an iterator to the beginning.

Returns
Iterator to the first space point

◆ begin() [2/2]

template<typename container_t, template< typename > class holder_t>
const_iterator Acts::SpacePointContainer< container_t, holder_t >::begin ( ) const

Return a const iterator to the beginning.

Returns
Const iterator to the first space point

◆ cbegin()

template<typename container_t, template< typename > class holder_t>
const_iterator Acts::SpacePointContainer< container_t, holder_t >::cbegin ( ) const

Return a const iterator to the beginning.

Returns
Const iterator to the first space point

◆ cend()

template<typename container_t, template< typename > class holder_t>
const_iterator Acts::SpacePointContainer< container_t, holder_t >::cend ( ) const

Return a const iterator to the end.

Returns
Const iterator to one past the last space point

◆ end() [1/2]

template<typename container_t, template< typename > class holder_t>
iterator Acts::SpacePointContainer< container_t, holder_t >::end ( )

Return an iterator to the end.

Returns
Iterator to one past the last space point

◆ end() [2/2]

template<typename container_t, template< typename > class holder_t>
const_iterator Acts::SpacePointContainer< container_t, holder_t >::end ( ) const

Return a const iterator to the end.

Returns
Const iterator to one past the last space point

◆ operator=()

template<typename container_t, template< typename > class holder_t>
SpacePointContainer & Acts::SpacePointContainer< container_t, holder_t >::operator= ( SpacePointContainer< container_t, holder_t > && other)
defaultnoexcept

Move assignment operator.

Parameters
otherspace point container to move from
Returns
Reference to this container

◆ size()

template<typename container_t, template< typename > class holder_t>
std::size_t Acts::SpacePointContainer< container_t, holder_t >::size ( ) const

Return the number of space points.

Returns
Number of space points

◆ sp()

template<typename container_t, template< typename > class holder_t>
const ValueType & Acts::SpacePointContainer< container_t, holder_t >::sp ( const std::size_t n) const

Access underlying space point value at index n.

Parameters
nIndex of the space point
Returns
Const reference to the underlying space point value