EICd
EIC data model
Public Types | Public Member Functions | List of all members
eic::ClusterCollection Class Reference

#include <ClusterCollection.h>

Inheritance diagram for eic::ClusterCollection:

Public Types

using const_iterator = ClusterConstCollectionIterator
 
using iterator = ClusterCollectionIterator
 

Public Member Functions

 ClusterCollection ()
 
 ClusterCollection (const ClusterCollection &)=delete
 
ClusterCollection & operator= (const ClusterCollection &)=delete
 
 ~ClusterCollection ()
 
void clear () override final
 
ClusterCollection * operator-> ()
 operator to allow pointer like calling of members a la LCIO More...
 
Cluster create ()
 Append a new object to the collection, and return this object. More...
 
template<typename... Args>
Cluster create (Args &&... args)
 
size_t size () const override final
 number of elements in the collection More...
 
std::string getValueTypeName () const override
 fully qualified type name of elements - with namespace More...
 
ConstCluster operator[] (unsigned int index) const
 Returns the const object of given index. More...
 
Cluster operator[] (unsigned int index)
 Returns the object of a given index. More...
 
ConstCluster at (unsigned int index) const
 Returns the const object of given index. More...
 
Cluster at (unsigned int index)
 Returns the object of given index. More...
 
void push_back (ConstCluster object)
 Append object to the collection. More...
 
void prepareForWrite () override final
 
void prepareAfterRead () override final
 
void setBuffer (void *address) override final
 
bool setReferences (const podio::ICollectionProvider *collectionProvider) override final
 
podio::CollRefCollection * referenceCollections () override final
 
podio::VectorMembersInfo * vectorMembers () override
 
void setID (unsigned ID) override final
 
unsigned getID () const override final
 
bool isValid () const override final
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
void * getBufferAddress () override final
 returns the address of the pointer to the data buffer More...
 
std::vector< ClusterData > * _getBuffer ()
 Returns the pointer to the data buffer. More...
 
template<size_t arraysize>
const std::array< eic::Index, arraysize > ID () 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< std::uint32_t, arraysize > nhits () const
 
template<size_t arraysize>
const std::array< eic::VectorXYZ, arraysize > position () const
 
template<size_t arraysize>
const std::array< eic::CovXYZ, arraysize > positionError () const
 
template<size_t arraysize>
const std::array< float, arraysize > radius () const
 
template<size_t arraysize>
const std::array< float, arraysize > skewness () const
 

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

using eic::ClusterCollection::const_iterator = ClusterConstCollectionIterator

◆ iterator

using eic::ClusterCollection::iterator = ClusterCollectionIterator

Constructor & Destructor Documentation

◆ ClusterCollection() [1/2]

eic::ClusterCollection::ClusterCollection ( )

◆ ClusterCollection() [2/2]

eic::ClusterCollection::ClusterCollection ( const ClusterCollection &  )
delete

◆ ~ClusterCollection()

eic::ClusterCollection::~ClusterCollection ( )

Member Function Documentation

◆ _getBuffer()

std::vector<ClusterData>* eic::ClusterCollection::_getBuffer ( )
inline

Returns the pointer to the data buffer.

◆ at() [1/2]

Cluster eic::ClusterCollection::at ( unsigned int  index)

Returns the object of given index.

◆ at() [2/2]

ConstCluster eic::ClusterCollection::at ( unsigned int  index) const

Returns the const object of given index.

◆ begin() [1/2]

iterator eic::ClusterCollection::begin ( )
inline

◆ begin() [2/2]

const_iterator eic::ClusterCollection::begin ( ) const
inline

◆ clear()

void eic::ClusterCollection::clear ( )
finaloverride

◆ create() [1/2]

Cluster eic::ClusterCollection::create ( )

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

◆ create() [2/2]

template<typename... Args>
Cluster eic::ClusterCollection::create ( Args &&...  args)

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

◆ end() [1/2]

iterator eic::ClusterCollection::end ( )
inline

◆ end() [2/2]

const_iterator eic::ClusterCollection::end ( ) const
inline

◆ energy()

template<size_t arraysize>
const std::array< float, arraysize > eic::ClusterCollection::energy

◆ energyError()

template<size_t arraysize>
const std::array< float, arraysize > eic::ClusterCollection::energyError

◆ getBufferAddress()

void* eic::ClusterCollection::getBufferAddress ( )
inlinefinaloverride

returns the address of the pointer to the data buffer

◆ getID()

unsigned eic::ClusterCollection::getID ( ) const
inlinefinaloverride

◆ getValueTypeName()

std::string eic::ClusterCollection::getValueTypeName ( ) const
inlineoverride

fully qualified type name of elements - with namespace

◆ ID()

template<size_t arraysize>
const std::array< eic::Index, arraysize > eic::ClusterCollection::ID

◆ isValid()

bool eic::ClusterCollection::isValid ( ) const
inlinefinaloverride

◆ nhits()

template<size_t arraysize>
const std::array< std::uint32_t, arraysize > eic::ClusterCollection::nhits

◆ operator->()

ClusterCollection* eic::ClusterCollection::operator-> ( )
inline

operator to allow pointer like calling of members a la LCIO

◆ operator=()

ClusterCollection& eic::ClusterCollection::operator= ( const ClusterCollection &  )
delete

◆ operator[]() [1/2]

Cluster eic::ClusterCollection::operator[] ( unsigned int  index)

Returns the object of a given index.

◆ operator[]() [2/2]

ConstCluster eic::ClusterCollection::operator[] ( unsigned int  index) const

Returns the const object of given index.

◆ position()

template<size_t arraysize>
const std::array< eic::VectorXYZ, arraysize > eic::ClusterCollection::position

◆ positionError()

template<size_t arraysize>
const std::array< eic::CovXYZ, arraysize > eic::ClusterCollection::positionError

◆ prepareAfterRead()

void eic::ClusterCollection::prepareAfterRead ( )
finaloverride

◆ prepareForWrite()

void eic::ClusterCollection::prepareForWrite ( )
finaloverride

◆ push_back()

void eic::ClusterCollection::push_back ( ConstCluster  object)

Append object to the collection.

◆ radius()

template<size_t arraysize>
const std::array< float, arraysize > eic::ClusterCollection::radius

◆ referenceCollections()

podio::CollRefCollection* eic::ClusterCollection::referenceCollections ( )
inlinefinaloverride

◆ setBuffer()

void eic::ClusterCollection::setBuffer ( void *  address)
finaloverride

◆ setID()

void eic::ClusterCollection::setID ( unsigned  ID)
inlinefinaloverride

◆ setReferences()

bool eic::ClusterCollection::setReferences ( const podio::ICollectionProvider *  collectionProvider)
finaloverride

◆ size()

size_t eic::ClusterCollection::size ( ) const
finaloverride

number of elements in the collection

◆ skewness()

template<size_t arraysize>
const std::array< float, arraysize > eic::ClusterCollection::skewness

◆ time()

template<size_t arraysize>
const std::array< float, arraysize > eic::ClusterCollection::time

◆ vectorMembers()

podio::VectorMembersInfo* eic::ClusterCollection::vectorMembers ( )
inlineoverride
The documentation for this class was generated from the following files: