EICd
EIC data model
Public Types | Public Member Functions | Friends | List of all members
eicd::TrackerHitCollection Class Reference

#include <TrackerHitCollection.h>

Inheritance diagram for eicd::TrackerHitCollection:

Public Types

using const_iterator = TrackerHitCollectionIterator
 
using iterator = TrackerHitMutableCollectionIterator
 

Public Member Functions

 TrackerHitCollection ()
 
 TrackerHitCollection (const TrackerHitCollection &)=delete
 
TrackerHitCollection & operator= (const TrackerHitCollection &)=delete
 
 TrackerHitCollection (TrackerHitCollection &&)=default
 
TrackerHitCollection & operator= (TrackerHitCollection &&)=default
 
 ~TrackerHitCollection ()
 
void clear () final
 
TrackerHitCollection * operator-> ()
 operator to allow pointer like calling of members a la LCIO More...
 
MutableTrackerHit create ()
 Append a new object to the collection, and return this object. More...
 
template<typename... Args>
MutableTrackerHit create (Args &&... args)
 
size_t size () const final
 number of elements in the collection More...
 
std::string getTypeName () const final
 fully qualified type name More...
 
std::string getValueTypeName () const final
 fully qualified type name of elements - with namespace More...
 
std::string getDataTypeName () const final
 fully qualified type name of stored POD elements - with namespace More...
 
bool isSubsetCollection () const final
 
void setSubsetCollection (bool setSubset=true) final
 
TrackerHit operator[] (unsigned int index) const
 Returns the const object of given index. More...
 
MutableTrackerHit operator[] (unsigned int index)
 Returns the object of a given index. More...
 
TrackerHit at (unsigned int index) const
 Returns the const object of given index. More...
 
MutableTrackerHit at (unsigned int index)
 Returns the object of given index. More...
 
void push_back (TrackerHit object)
 Append object to the collection. More...
 
void prepareForWrite () const final
 
void prepareAfterRead () final
 
bool setReferences (const podio::ICollectionProvider *collectionProvider) final
 
podio::CollectionBuffers getBuffers () final
 Get the collection buffers for this collection. More...
 
void setID (unsigned ID) final
 
unsigned getID () const final
 
bool isValid () const final
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
template<size_t arraysize>
const std::array< std::uint64_t, arraysize > cellID () const
 
template<size_t arraysize>
const std::array< edm4hep::Vector3f, arraysize > position () const
 
template<size_t arraysize>
const std::array< eicd::CovDiag3f, arraysize > positionError () const
 
template<size_t arraysize>
const std::array< float, arraysize > time () const
 
template<size_t arraysize>
const std::array< float, arraysize > timeError () const
 
template<size_t arraysize>
const std::array< float, arraysize > edep () const
 
template<size_t arraysize>
const std::array< float, arraysize > edepError () const
 

Friends

class TrackerHitCollectionData
 

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

using eicd::TrackerHitCollection::const_iterator = TrackerHitCollectionIterator

◆ iterator

using eicd::TrackerHitCollection::iterator = TrackerHitMutableCollectionIterator

Constructor & Destructor Documentation

◆ TrackerHitCollection() [1/3]

eicd::TrackerHitCollection::TrackerHitCollection ( )

◆ TrackerHitCollection() [2/3]

eicd::TrackerHitCollection::TrackerHitCollection ( const TrackerHitCollection &  )
delete

◆ TrackerHitCollection() [3/3]

eicd::TrackerHitCollection::TrackerHitCollection ( TrackerHitCollection &&  )
default

◆ ~TrackerHitCollection()

eicd::TrackerHitCollection::~TrackerHitCollection ( )

Member Function Documentation

◆ at() [1/2]

MutableTrackerHit eicd::TrackerHitCollection::at ( unsigned int  index)

Returns the object of given index.

◆ at() [2/2]

TrackerHit eicd::TrackerHitCollection::at ( unsigned int  index) const

Returns the const object of given index.

◆ begin() [1/2]

iterator eicd::TrackerHitCollection::begin ( )
inline

◆ begin() [2/2]

const_iterator eicd::TrackerHitCollection::begin ( ) const
inline

◆ cellID()

template<size_t arraysize>
const std::array< std::uint64_t, arraysize > eicd::TrackerHitCollection::cellID

◆ clear()

void eicd::TrackerHitCollection::clear ( )
final

◆ create() [1/2]

MutableTrackerHit eicd::TrackerHitCollection::create ( )

Append a new object to the collection, and return this object.

◆ create() [2/2]

template<typename... Args>
MutableTrackerHit eicd::TrackerHitCollection::create ( Args &&...  args)

Append a new object to the collection, and return this object. Initialized with the parameters given

◆ edep()

template<size_t arraysize>
const std::array< float, arraysize > eicd::TrackerHitCollection::edep

◆ edepError()

template<size_t arraysize>
const std::array< float, arraysize > eicd::TrackerHitCollection::edepError

◆ end() [1/2]

iterator eicd::TrackerHitCollection::end ( )
inline

◆ end() [2/2]

const_iterator eicd::TrackerHitCollection::end ( ) const
inline

◆ getBuffers()

podio::CollectionBuffers eicd::TrackerHitCollection::getBuffers ( )
final

Get the collection buffers for this collection.

◆ getDataTypeName()

std::string eicd::TrackerHitCollection::getDataTypeName ( ) const
inlinefinal

fully qualified type name of stored POD elements - with namespace

◆ getID()

unsigned eicd::TrackerHitCollection::getID ( ) const
inlinefinal

◆ getTypeName()

std::string eicd::TrackerHitCollection::getTypeName ( ) const
inlinefinal

fully qualified type name

◆ getValueTypeName()

std::string eicd::TrackerHitCollection::getValueTypeName ( ) const
inlinefinal

fully qualified type name of elements - with namespace

◆ isSubsetCollection()

bool eicd::TrackerHitCollection::isSubsetCollection ( ) const
inlinefinal

◆ isValid()

bool eicd::TrackerHitCollection::isValid ( ) const
inlinefinal

◆ operator->()

TrackerHitCollection * eicd::TrackerHitCollection::operator-> ( )
inline

operator to allow pointer like calling of members a la LCIO

◆ operator=() [1/2]

TrackerHitCollection & eicd::TrackerHitCollection::operator= ( const TrackerHitCollection &  )
delete

◆ operator=() [2/2]

TrackerHitCollection & eicd::TrackerHitCollection::operator= ( TrackerHitCollection &&  )
default

◆ operator[]() [1/2]

MutableTrackerHit eicd::TrackerHitCollection::operator[] ( unsigned int  index)

Returns the object of a given index.

◆ operator[]() [2/2]

TrackerHit eicd::TrackerHitCollection::operator[] ( unsigned int  index) const

Returns the const object of given index.

◆ position()

template<size_t arraysize>
const std::array< edm4hep::Vector3f, arraysize > eicd::TrackerHitCollection::position

◆ positionError()

template<size_t arraysize>
const std::array< eicd::CovDiag3f, arraysize > eicd::TrackerHitCollection::positionError

◆ prepareAfterRead()

void eicd::TrackerHitCollection::prepareAfterRead ( )
final

◆ prepareForWrite()

void eicd::TrackerHitCollection::prepareForWrite ( ) const
final

◆ push_back()

void eicd::TrackerHitCollection::push_back ( TrackerHit  object)

Append object to the collection.

◆ setID()

void eicd::TrackerHitCollection::setID ( unsigned  ID)
inlinefinal

◆ setReferences()

bool eicd::TrackerHitCollection::setReferences ( const podio::ICollectionProvider *  collectionProvider)
final

◆ setSubsetCollection()

void eicd::TrackerHitCollection::setSubsetCollection ( bool  setSubset = true)
final

◆ size()

size_t eicd::TrackerHitCollection::size ( ) const
final

number of elements in the collection

◆ time()

template<size_t arraysize>
const std::array< float, arraysize > eicd::TrackerHitCollection::time

◆ timeError()

template<size_t arraysize>
const std::array< float, arraysize > eicd::TrackerHitCollection::timeError

Friends And Related Function Documentation

◆ TrackerHitCollectionData

friend class TrackerHitCollectionData
friend
The documentation for this class was generated from the following files: