EICd
EIC data model
eicd::CalorimeterHitCollection Class Reference

#include <CalorimeterHitCollection.h>

Inheritance diagram for eicd::CalorimeterHitCollection:

Public Types

using const_iterator = CalorimeterHitCollectionIterator
 
using iterator = CalorimeterHitMutableCollectionIterator
 

Public Member Functions

 CalorimeterHitCollection ()
 
 CalorimeterHitCollection (const CalorimeterHitCollection &)=delete
 
CalorimeterHitCollectionoperator= (const CalorimeterHitCollection &)=delete
 
 CalorimeterHitCollection (CalorimeterHitCollection &&)=default
 
CalorimeterHitCollectionoperator= (CalorimeterHitCollection &&)=default
 
 ~CalorimeterHitCollection ()
 
void clear () final
 
CalorimeterHitCollectionoperator-> ()
 operator to allow pointer like calling of members a la LCIO More...
 
MutableCalorimeterHit create ()
 Append a new object to the collection, and return this object. More...
 
template<typename... Args>
MutableCalorimeterHit 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
 
CalorimeterHit operator[] (unsigned int index) const
 Returns the const object of given index. More...
 
MutableCalorimeterHit operator[] (unsigned int index)
 Returns the object of a given index. More...
 
CalorimeterHit at (unsigned int index) const
 Returns the const object of given index. More...
 
MutableCalorimeterHit at (unsigned int index)
 Returns the object of given index. More...
 
void push_back (CalorimeterHit 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< float, arraysize > energy () const
 
template<size_t arraysize>
const std::array< float, arraysize > energyError () 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< edm4hep::Vector3f, arraysize > position () const
 
template<size_t arraysize>
const std::array< edm4hep::Vector3f, arraysize > dimension () const
 
template<size_t arraysize>
const std::array< std::int32_t, arraysize > sector () const
 
template<size_t arraysize>
const std::array< std::int32_t, arraysize > layer () const
 
template<size_t arraysize>
const std::array< edm4hep::Vector3f, arraysize > local () const
 

Friends

class CalorimeterHitCollectionData
 

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ CalorimeterHitCollection() [1/3]

eicd::CalorimeterHitCollection::CalorimeterHitCollection ( )

◆ CalorimeterHitCollection() [2/3]

eicd::CalorimeterHitCollection::CalorimeterHitCollection ( const CalorimeterHitCollection )
delete

◆ CalorimeterHitCollection() [3/3]

eicd::CalorimeterHitCollection::CalorimeterHitCollection ( CalorimeterHitCollection &&  )
default

◆ ~CalorimeterHitCollection()

eicd::CalorimeterHitCollection::~CalorimeterHitCollection ( )

Member Function Documentation

◆ at() [1/2]

MutableCalorimeterHit eicd::CalorimeterHitCollection::at ( unsigned int  index)

Returns the object of given index.

◆ at() [2/2]

CalorimeterHit eicd::CalorimeterHitCollection::at ( unsigned int  index) const

Returns the const object of given index.

◆ begin() [1/2]

iterator eicd::CalorimeterHitCollection::begin ( )
inline

◆ begin() [2/2]

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

◆ cellID()

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

◆ clear()

void eicd::CalorimeterHitCollection::clear ( )
final

◆ create() [1/2]

MutableCalorimeterHit eicd::CalorimeterHitCollection::create ( )

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

◆ create() [2/2]

template<typename... Args>
MutableCalorimeterHit eicd::CalorimeterHitCollection::create ( Args &&...  args)

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

◆ dimension()

template<size_t arraysize>
const std::array< edm4hep::Vector3f, arraysize > eicd::CalorimeterHitCollection::dimension

◆ end() [1/2]

iterator eicd::CalorimeterHitCollection::end ( )
inline

◆ end() [2/2]

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

◆ energy()

template<size_t arraysize>
const std::array< float, arraysize > eicd::CalorimeterHitCollection::energy

◆ energyError()

template<size_t arraysize>
const std::array< float, arraysize > eicd::CalorimeterHitCollection::energyError

◆ getBuffers()

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

Get the collection buffers for this collection.

◆ getDataTypeName()

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

fully qualified type name of stored POD elements - with namespace

◆ getID()

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

◆ getTypeName()

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

fully qualified type name

◆ getValueTypeName()

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

fully qualified type name of elements - with namespace

◆ isSubsetCollection()

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

◆ isValid()

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

◆ layer()

template<size_t arraysize>
const std::array< std::int32_t, arraysize > eicd::CalorimeterHitCollection::layer

◆ local()

template<size_t arraysize>
const std::array< edm4hep::Vector3f, arraysize > eicd::CalorimeterHitCollection::local

◆ operator->()

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

operator to allow pointer like calling of members a la LCIO

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator[]() [1/2]

MutableCalorimeterHit eicd::CalorimeterHitCollection::operator[] ( unsigned int  index)

Returns the object of a given index.

◆ operator[]() [2/2]

CalorimeterHit eicd::CalorimeterHitCollection::operator[] ( unsigned int  index) const

Returns the const object of given index.

◆ position()

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

◆ prepareAfterRead()

void eicd::CalorimeterHitCollection::prepareAfterRead ( )
final

◆ prepareForWrite()

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

◆ push_back()

void eicd::CalorimeterHitCollection::push_back ( CalorimeterHit  object)

Append object to the collection.

◆ sector()

template<size_t arraysize>
const std::array< std::int32_t, arraysize > eicd::CalorimeterHitCollection::sector

◆ setID()

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

◆ setReferences()

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

◆ setSubsetCollection()

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

◆ size()

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

number of elements in the collection

◆ time()

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

◆ timeError()

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

Friends And Related Function Documentation

◆ CalorimeterHitCollectionData

friend class CalorimeterHitCollectionData
friend

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