EDM4eic
EIC data model
Loading...
Searching...
No Matches
edm4eic::CalorimeterHitCollection Class Reference

#include <CalorimeterHitCollection.h>

Inheritance diagram for edm4eic::CalorimeterHitCollection:

Public Types

using value_type = CalorimeterHit
 
using const_iterator = CalorimeterHitCollectionIterator
 
using iterator = CalorimeterHitMutableCollectionIterator
 

Public Member Functions

 CalorimeterHitCollection ()
 
 CalorimeterHitCollection (CalorimeterHitCollectionData &&data, bool isSubsetColl)
 
 CalorimeterHitCollection (const CalorimeterHitCollection &)=delete
 
CalorimeterHitCollectionoperator= (const CalorimeterHitCollection &)=delete
 
 CalorimeterHitCollection (CalorimeterHitCollection &&)=default
 
CalorimeterHitCollectionoperator= (CalorimeterHitCollection &&)=default
 
 ~CalorimeterHitCollection ()
 
void clear () final
 
void print (std::ostream &os=std::cout, bool flush=true) const final
 Print this collection to the passed stream.
 
CalorimeterHitCollectionoperator-> ()
 operator to allow pointer like calling of members a la LCIO
 
MutableCalorimeterHit create ()
 Append a new object to the collection, and return this object.
 
template<typename... Args>
MutableCalorimeterHit create (Args &&... args)
 
std::size_t size () const final
 number of elements in the collection
 
bool empty () const final
 Is the collection empty.
 
const std::string_view getTypeName () const final
 fully qualified type name
 
const std::string_view getValueTypeName () const final
 fully qualified type name of elements - with namespace
 
const std::string_view getDataTypeName () const final
 fully qualified type name of stored POD elements - with namespace
 
podio::SchemaVersionT getSchemaVersion () const final
 schema version
 
bool isSubsetCollection () const final
 
void setSubsetCollection (bool setSubset=true) final
 
CalorimeterHit operator[] (std::size_t index) const
 Returns the const object of given index.
 
MutableCalorimeterHit operator[] (std::size_t index)
 Returns the object of a given index.
 
CalorimeterHit at (std::size_t index) const
 Returns the const object of given index.
 
MutableCalorimeterHit at (std::size_t index)
 Returns the object of given index.
 
void push_back (MutableCalorimeterHit object)
 Append object to the collection.
 
void push_back (CalorimeterHit object)
 Append an object to the (subset) collection.
 
void prepareForWrite () const final
 
void prepareAfterRead () final
 
bool setReferences (const podio::ICollectionProvider *collectionProvider) final
 
podio::CollectionWriteBuffers getBuffers () final
 Get the collection buffers for this collection.
 
void setID (uint32_t ID) final
 
uint32_t getID () const final
 
bool isValid () const final
 
size_t getDatamodelRegistryIndex () const final
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
std::vector< std::uint64_t > cellID (const size_t nElem=0) const
 
std::vector< float > energy (const size_t nElem=0) const
 
std::vector< float > energyError (const size_t nElem=0) const
 
std::vector< float > time (const size_t nElem=0) const
 
std::vector< float > timeError (const size_t nElem=0) const
 
std::vector< edm4hep::Vector3f > position (const size_t nElem=0) const
 
std::vector< edm4hep::Vector3f > dimension (const size_t nElem=0) const
 
std::vector< std::int32_t > sector (const size_t nElem=0) const
 
std::vector< std::int32_t > layer (const size_t nElem=0) const
 
std::vector< edm4hep::Vector3f > local (const size_t nElem=0) const
 

Static Public Attributes

static constexpr auto typeName = "edm4eic::CalorimeterHitCollection"
 
static constexpr auto valueTypeName = "edm4eic::CalorimeterHit"
 
static constexpr auto dataTypeName = "edm4eic::CalorimeterHitData"
 

Friends

class CalorimeterHitCollectionData
 

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ value_type

Constructor & Destructor Documentation

◆ CalorimeterHitCollection() [1/4]

edm4eic::CalorimeterHitCollection::CalorimeterHitCollection ( )

◆ CalorimeterHitCollection() [2/4]

edm4eic::CalorimeterHitCollection::CalorimeterHitCollection ( CalorimeterHitCollectionData && data,
bool isSubsetColl )

◆ CalorimeterHitCollection() [3/4]

edm4eic::CalorimeterHitCollection::CalorimeterHitCollection ( const CalorimeterHitCollection & )
delete

◆ CalorimeterHitCollection() [4/4]

edm4eic::CalorimeterHitCollection::CalorimeterHitCollection ( CalorimeterHitCollection && )
default

◆ ~CalorimeterHitCollection()

edm4eic::CalorimeterHitCollection::~CalorimeterHitCollection ( )

Member Function Documentation

◆ at() [1/2]

MutableCalorimeterHit edm4eic::CalorimeterHitCollection::at ( std::size_t index)

Returns the object of given index.

◆ at() [2/2]

CalorimeterHit edm4eic::CalorimeterHitCollection::at ( std::size_t index) const

Returns the const object of given index.

◆ begin() [1/2]

iterator edm4eic::CalorimeterHitCollection::begin ( )
inline

◆ begin() [2/2]

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

◆ cellID()

std::vector< std::uint64_t > edm4eic::CalorimeterHitCollection::cellID ( const size_t nElem = 0) const

◆ clear()

void edm4eic::CalorimeterHitCollection::clear ( )
final

◆ create() [1/2]

MutableCalorimeterHit edm4eic::CalorimeterHitCollection::create ( )

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

◆ create() [2/2]

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

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

◆ dimension()

std::vector< edm4hep::Vector3f > edm4eic::CalorimeterHitCollection::dimension ( const size_t nElem = 0) const

◆ empty()

bool edm4eic::CalorimeterHitCollection::empty ( ) const
final

Is the collection empty.

◆ end() [1/2]

iterator edm4eic::CalorimeterHitCollection::end ( )
inline

◆ end() [2/2]

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

◆ energy()

std::vector< float > edm4eic::CalorimeterHitCollection::energy ( const size_t nElem = 0) const

◆ energyError()

std::vector< float > edm4eic::CalorimeterHitCollection::energyError ( const size_t nElem = 0) const

◆ getBuffers()

podio::CollectionWriteBuffers edm4eic::CalorimeterHitCollection::getBuffers ( )
final

Get the collection buffers for this collection.

◆ getDatamodelRegistryIndex()

size_t edm4eic::CalorimeterHitCollection::getDatamodelRegistryIndex ( ) const
final

◆ getDataTypeName()

const std::string_view edm4eic::CalorimeterHitCollection::getDataTypeName ( ) const
inlinefinal

fully qualified type name of stored POD elements - with namespace

◆ getID()

uint32_t edm4eic::CalorimeterHitCollection::getID ( ) const
inlinefinal

◆ getSchemaVersion()

podio::SchemaVersionT edm4eic::CalorimeterHitCollection::getSchemaVersion ( ) const
final

schema version

◆ getTypeName()

const std::string_view edm4eic::CalorimeterHitCollection::getTypeName ( ) const
inlinefinal

fully qualified type name

◆ getValueTypeName()

const std::string_view edm4eic::CalorimeterHitCollection::getValueTypeName ( ) const
inlinefinal

fully qualified type name of elements - with namespace

◆ isSubsetCollection()

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

◆ isValid()

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

◆ layer()

std::vector< std::int32_t > edm4eic::CalorimeterHitCollection::layer ( const size_t nElem = 0) const

◆ local()

std::vector< edm4hep::Vector3f > edm4eic::CalorimeterHitCollection::local ( const size_t nElem = 0) const

◆ operator->()

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

operator to allow pointer like calling of members a la LCIO

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator[]() [1/2]

MutableCalorimeterHit edm4eic::CalorimeterHitCollection::operator[] ( std::size_t index)

Returns the object of a given index.

◆ operator[]() [2/2]

CalorimeterHit edm4eic::CalorimeterHitCollection::operator[] ( std::size_t index) const

Returns the const object of given index.

◆ position()

std::vector< edm4hep::Vector3f > edm4eic::CalorimeterHitCollection::position ( const size_t nElem = 0) const

◆ prepareAfterRead()

void edm4eic::CalorimeterHitCollection::prepareAfterRead ( )
final

◆ prepareForWrite()

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

◆ print()

void edm4eic::CalorimeterHitCollection::print ( std::ostream & os = std::cout,
bool flush = true ) const
final

Print this collection to the passed stream.

◆ push_back() [1/2]

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

Append an object to the (subset) collection.

◆ push_back() [2/2]

void edm4eic::CalorimeterHitCollection::push_back ( MutableCalorimeterHit object)

Append object to the collection.

◆ sector()

std::vector< std::int32_t > edm4eic::CalorimeterHitCollection::sector ( const size_t nElem = 0) const

◆ setID()

void edm4eic::CalorimeterHitCollection::setID ( uint32_t ID)
inlinefinal

◆ setReferences()

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

◆ setSubsetCollection()

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

◆ size()

std::size_t edm4eic::CalorimeterHitCollection::size ( ) const
final

number of elements in the collection

◆ time()

std::vector< float > edm4eic::CalorimeterHitCollection::time ( const size_t nElem = 0) const

◆ timeError()

std::vector< float > edm4eic::CalorimeterHitCollection::timeError ( const size_t nElem = 0) const

Friends And Related Symbol Documentation

◆ CalorimeterHitCollectionData

friend class CalorimeterHitCollectionData
friend

Member Data Documentation

◆ dataTypeName

auto edm4eic::CalorimeterHitCollection::dataTypeName = "edm4eic::CalorimeterHitData"
staticconstexpr

◆ typeName

auto edm4eic::CalorimeterHitCollection::typeName = "edm4eic::CalorimeterHitCollection"
staticconstexpr

◆ valueTypeName

auto edm4eic::CalorimeterHitCollection::valueTypeName = "edm4eic::CalorimeterHit"
staticconstexpr

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