SHiP::trout::IndexSourceLink Class Reference

A source link that stores just an index. More...

#include <IndexSourceLink.hpp>

Public Types
using	SurfaceAccessor = IndexSourceLinkSurfaceAccessor

Public Member Functions
constexpr	IndexSourceLink (Acts::GeometryIdentifier gid, ActsExamples::Index idx)
	Construct from geometry identifier and index.
	IndexSourceLink ()=default
	satisfy SourceLinkConcept.
	IndexSourceLink (const IndexSourceLink &)=default
	IndexSourceLink (IndexSourceLink &&)=default
IndexSourceLink &	operator= (const IndexSourceLink &)=default
IndexSourceLink &	operator= (IndexSourceLink &&)=default
constexpr ActsExamples::Index	index () const
	Access the index.
Acts::GeometryIdentifier	geometryId () const

Friends
bool	operator== (const IndexSourceLink &lhs, const IndexSourceLink &rhs)

Detailed Description

A source link that stores just an index.

This is intentionally kept as barebones as possible. The source link is just a reference and will be copied, moved around, etc. often. Keeping it small and separate from the actual, potentially large, measurement data should result in better overall performance. Using an index instead of e.g. a pointer, means source link and measurement are decoupled and the measurement representation can be easily changed without having to also change the source link.

Member Typedef Documentation

SurfaceAccessor

using SHiP::trout::IndexSourceLink::SurfaceAccessor = IndexSourceLinkSurfaceAccessor

Constructor & Destructor Documentation

IndexSourceLink() [1/4]

SHiP::trout::IndexSourceLink::IndexSourceLink ( Acts::GeometryIdentifier gid, ActsExamples::Index idx )

inlineconstexpr

Construct from geometry identifier and index.

IndexSourceLink() [2/4]

SHiP::trout::IndexSourceLink::IndexSourceLink ( )

default

satisfy SourceLinkConcept.

IndexSourceLink() [3/4]

SHiP::trout::IndexSourceLink::IndexSourceLink ( const IndexSourceLink & )

default

IndexSourceLink() [4/4]

SHiP::trout::IndexSourceLink::IndexSourceLink ( IndexSourceLink && )

default

Member Function Documentation

geometryId()

Acts::GeometryIdentifier SHiP::trout::IndexSourceLink::geometryId ( ) const

inline

index()

ActsExamples::Index SHiP::trout::IndexSourceLink::index ( ) const

inlineconstexpr

Access the index.

operator=() [1/2]

IndexSourceLink & SHiP::trout::IndexSourceLink::operator= ( const IndexSourceLink & )

default

operator=() [2/2]

IndexSourceLink & SHiP::trout::IndexSourceLink::operator= ( IndexSourceLink && )

default

Friends And Related Symbol Documentation

operator==

bool operator== ( const IndexSourceLink & lhs, const IndexSourceLink & rhs )

friend

---

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

• include/IndexSourceLink.hpp