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

#include <ProtoClusterCollection.h>

Inheritance diagram for eic::ProtoClusterCollection:

Public Types

using const_iterator = ProtoClusterConstCollectionIterator
 
using iterator = ProtoClusterCollectionIterator
 

Public Member Functions

 ProtoClusterCollection ()
 
 ProtoClusterCollection (const ProtoClusterCollection &)=delete
 
ProtoClusterCollection & operator= (const ProtoClusterCollection &)=delete
 
 ~ProtoClusterCollection ()
 
void clear () override final
 
ProtoClusterCollection * operator-> ()
 operator to allow pointer like calling of members a la LCIO More...
 
ProtoCluster create ()
 Append a new object to the collection, and return this object. More...
 
template<typename... Args>
ProtoCluster 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...
 
ConstProtoCluster operator[] (unsigned int index) const
 Returns the const object of given index. More...
 
ProtoCluster operator[] (unsigned int index)
 Returns the object of a given index. More...
 
ConstProtoCluster at (unsigned int index) const
 Returns the const object of given index. More...
 
ProtoCluster at (unsigned int index)
 Returns the object of given index. More...
 
void push_back (ConstProtoCluster 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< ProtoClusterData > * _getBuffer ()
 Returns the pointer to the data buffer. More...
 
template<size_t arraysize>
const std::array< eic::Index, arraysize > hitID () const
 
template<size_t arraysize>
const std::array< eic::Index, arraysize > clusterID () const
 
template<size_t arraysize>
const std::array< eic::Weight, arraysize > weight () const
 

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

using eic::ProtoClusterCollection::const_iterator = ProtoClusterConstCollectionIterator

◆ iterator

using eic::ProtoClusterCollection::iterator = ProtoClusterCollectionIterator

Constructor & Destructor Documentation

◆ ProtoClusterCollection() [1/2]

eic::ProtoClusterCollection::ProtoClusterCollection ( )

◆ ProtoClusterCollection() [2/2]

eic::ProtoClusterCollection::ProtoClusterCollection ( const ProtoClusterCollection &  )
delete

◆ ~ProtoClusterCollection()

eic::ProtoClusterCollection::~ProtoClusterCollection ( )

Member Function Documentation

◆ _getBuffer()

std::vector<ProtoClusterData>* eic::ProtoClusterCollection::_getBuffer ( )
inline

Returns the pointer to the data buffer.

◆ at() [1/2]

ProtoCluster eic::ProtoClusterCollection::at ( unsigned int  index)

Returns the object of given index.

◆ at() [2/2]

ConstProtoCluster eic::ProtoClusterCollection::at ( unsigned int  index) const

Returns the const object of given index.

◆ begin() [1/2]

iterator eic::ProtoClusterCollection::begin ( )
inline

◆ begin() [2/2]

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

◆ clear()

void eic::ProtoClusterCollection::clear ( )
finaloverride

◆ clusterID()

template<size_t arraysize>
const std::array< eic::Index, arraysize > eic::ProtoClusterCollection::clusterID

◆ create() [1/2]

ProtoCluster eic::ProtoClusterCollection::create ( )

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

◆ create() [2/2]

template<typename... Args>
ProtoCluster eic::ProtoClusterCollection::create ( Args &&...  args)

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

◆ end() [1/2]

iterator eic::ProtoClusterCollection::end ( )
inline

◆ end() [2/2]

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

◆ getBufferAddress()

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

returns the address of the pointer to the data buffer

◆ getID()

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

◆ getValueTypeName()

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

fully qualified type name of elements - with namespace

◆ hitID()

template<size_t arraysize>
const std::array< eic::Index, arraysize > eic::ProtoClusterCollection::hitID

◆ isValid()

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

◆ operator->()

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

operator to allow pointer like calling of members a la LCIO

◆ operator=()

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

◆ operator[]() [1/2]

ProtoCluster eic::ProtoClusterCollection::operator[] ( unsigned int  index)

Returns the object of a given index.

◆ operator[]() [2/2]

ConstProtoCluster eic::ProtoClusterCollection::operator[] ( unsigned int  index) const

Returns the const object of given index.

◆ prepareAfterRead()

void eic::ProtoClusterCollection::prepareAfterRead ( )
finaloverride

◆ prepareForWrite()

void eic::ProtoClusterCollection::prepareForWrite ( )
finaloverride

◆ push_back()

void eic::ProtoClusterCollection::push_back ( ConstProtoCluster  object)

Append object to the collection.

◆ referenceCollections()

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

◆ setBuffer()

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

◆ setID()

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

◆ setReferences()

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

◆ size()

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

number of elements in the collection

◆ vectorMembers()

podio::VectorMembersInfo* eic::ProtoClusterCollection::vectorMembers ( )
inlineoverride

◆ weight()

template<size_t arraysize>
const std::array< eic::Weight, arraysize > eic::ProtoClusterCollection::weight
The documentation for this class was generated from the following files: