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

#include <ClusterCollection.h>

Inheritance diagram for eicd::ClusterCollection:

Public Types

using const_iterator = ClusterCollectionIterator
 
using iterator = ClusterMutableCollectionIterator
 

Public Member Functions

 ClusterCollection ()
 
 ClusterCollection (const ClusterCollection &)=delete
 
ClusterCollection & operator= (const ClusterCollection &)=delete
 
 ClusterCollection (ClusterCollection &&)=default
 
ClusterCollection & operator= (ClusterCollection &&)=default
 
 ~ClusterCollection ()
 
void clear () final
 
ClusterCollection * operator-> ()
 operator to allow pointer like calling of members a la LCIO More...
 
MutableCluster create ()
 Append a new object to the collection, and return this object. More...
 
template<typename... Args>
MutableCluster 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
 
Cluster operator[] (unsigned int index) const
 Returns the const object of given index. More...
 
MutableCluster operator[] (unsigned int index)
 Returns the object of a given index. More...
 
Cluster at (unsigned int index) const
 Returns the const object of given index. More...
 
MutableCluster at (unsigned int index)
 Returns the object of given index. More...
 
void push_back (Cluster 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::int32_t, arraysize > type () 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< std::uint32_t, arraysize > nhits () const
 
template<size_t arraysize>
const std::array< edm4hep::Vector3f, arraysize > position () const
 
template<size_t arraysize>
const std::array< eicd::Cov3f, arraysize > positionError () const
 
template<size_t arraysize>
const std::array< float, arraysize > intrinsicTheta () const
 
template<size_t arraysize>
const std::array< float, arraysize > intrinsicPhi () const
 
template<size_t arraysize>
const std::array< eicd::Cov2f, arraysize > intrinsicDirectionError () const
 

Friends

class ClusterCollectionData
 

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

using eicd::ClusterCollection::const_iterator = ClusterCollectionIterator

◆ iterator

using eicd::ClusterCollection::iterator = ClusterMutableCollectionIterator

Constructor & Destructor Documentation

◆ ClusterCollection() [1/3]

eicd::ClusterCollection::ClusterCollection ( )

◆ ClusterCollection() [2/3]

eicd::ClusterCollection::ClusterCollection ( const ClusterCollection &  )
delete

◆ ClusterCollection() [3/3]

eicd::ClusterCollection::ClusterCollection ( ClusterCollection &&  )
default

◆ ~ClusterCollection()

eicd::ClusterCollection::~ClusterCollection ( )

Member Function Documentation

◆ at() [1/2]

MutableCluster eicd::ClusterCollection::at ( unsigned int  index)

Returns the object of given index.

◆ at() [2/2]

Cluster eicd::ClusterCollection::at ( unsigned int  index) const

Returns the const object of given index.

◆ begin() [1/2]

iterator eicd::ClusterCollection::begin ( )
inline

◆ begin() [2/2]

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

◆ clear()

void eicd::ClusterCollection::clear ( )
final

◆ create() [1/2]

MutableCluster eicd::ClusterCollection::create ( )

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

◆ create() [2/2]

template<typename... Args>
MutableCluster eicd::ClusterCollection::create ( Args &&...  args)

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

◆ end() [1/2]

iterator eicd::ClusterCollection::end ( )
inline

◆ end() [2/2]

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

◆ energy()

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

◆ energyError()

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

◆ getBuffers()

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

Get the collection buffers for this collection.

◆ getDataTypeName()

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

fully qualified type name of stored POD elements - with namespace

◆ getID()

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

◆ getTypeName()

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

fully qualified type name

◆ getValueTypeName()

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

fully qualified type name of elements - with namespace

◆ intrinsicDirectionError()

template<size_t arraysize>
const std::array< eicd::Cov2f, arraysize > eicd::ClusterCollection::intrinsicDirectionError

◆ intrinsicPhi()

template<size_t arraysize>
const std::array< float, arraysize > eicd::ClusterCollection::intrinsicPhi

◆ intrinsicTheta()

template<size_t arraysize>
const std::array< float, arraysize > eicd::ClusterCollection::intrinsicTheta

◆ isSubsetCollection()

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

◆ isValid()

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

◆ nhits()

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

◆ operator->()

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

operator to allow pointer like calling of members a la LCIO

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator[]() [1/2]

MutableCluster eicd::ClusterCollection::operator[] ( unsigned int  index)

Returns the object of a given index.

◆ operator[]() [2/2]

Cluster eicd::ClusterCollection::operator[] ( unsigned int  index) const

Returns the const object of given index.

◆ position()

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

◆ positionError()

template<size_t arraysize>
const std::array< eicd::Cov3f, arraysize > eicd::ClusterCollection::positionError

◆ prepareAfterRead()

void eicd::ClusterCollection::prepareAfterRead ( )
final

◆ prepareForWrite()

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

◆ push_back()

void eicd::ClusterCollection::push_back ( Cluster  object)

Append object to the collection.

◆ setID()

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

◆ setReferences()

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

◆ setSubsetCollection()

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

◆ size()

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

number of elements in the collection

◆ time()

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

◆ timeError()

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

◆ type()

template<size_t arraysize>
const std::array< std::int32_t, arraysize > eicd::ClusterCollection::type

Friends And Related Function Documentation

◆ ClusterCollectionData

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