EDM4eic
EIC data model
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
edm4eic::ClusterCollection Class Reference

#include <ClusterCollection.h>

Inheritance diagram for edm4eic::ClusterCollection:

Public Types

using value_type = Cluster
 
using mutable_type = MutableCluster
 
using const_iterator = ClusterCollectionIterator
 
using iterator = ClusterMutableCollectionIterator
 
using difference_type = ptrdiff_t
 
using size_type = size_t
 
using const_reverse_iterator = std::reverse_iterator<const_iterator>
 
using reverse_iterator = std::reverse_iterator<iterator>
 

Public Member Functions

 ClusterCollection ()
 
 ClusterCollection (ClusterCollectionData &&data, bool isSubsetColl)
 
 ClusterCollection (const ClusterCollection &)=delete
 
ClusterCollection & operator= (const ClusterCollection &)=delete
 
 ClusterCollection (ClusterCollection &&)=default
 
ClusterCollection & operator= (ClusterCollection &&)=default
 
 ~ClusterCollection () override
 
void clear () final
 
void print (std::ostream &os=std::cout, bool flush=true) const final
 Print this collection to the passed stream.
 
ClusterCollection * operator-> ()
 operator to allow pointer like calling of members a la LCIO
 
MutableCluster create ()
 Append a new object to the collection, and return this object.
 
template<typename... Args>
MutableCluster create (Args &&... args)
 
std::size_t size () const final
 number of elements in the collection
 
std::size_t max_size () const final
 maximal 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
 
Cluster operator[] (std::size_t index) const
 Returns the const object of given index.
 
MutableCluster operator[] (std::size_t index)
 Returns the object of a given index.
 
Cluster at (std::size_t index) const
 Returns the const object of given index.
 
MutableCluster at (std::size_t index)
 Returns the object of given index.
 
void push_back (const MutableCluster &object)
 Append object to the collection.
 
void push_back (const Cluster &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
 
const_iterator cbegin () const
 
iterator end ()
 
const_iterator end () const
 
const_iterator cend () const
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
const_reverse_iterator crbegin () const
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
const_reverse_iterator crend () const
 
std::vector< std::int32_t > type (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< std::uint32_t > nhits (const size_t nElem=0) const
 
std::vector< edm4hep::Vector3f > position (const size_t nElem=0) const
 
std::vector< edm4eic::Cov3f > positionError (const size_t nElem=0) const
 
std::vector< float > intrinsicTheta (const size_t nElem=0) const
 
std::vector< float > intrinsicPhi (const size_t nElem=0) const
 
std::vector< edm4eic::Cov2f > intrinsicDirectionError (const size_t nElem=0) const
 

Static Public Attributes

static constexpr std::string_view typeName = "edm4eic::ClusterCollection"
 
static constexpr std::string_view valueTypeName = "edm4eic::Cluster"
 
static constexpr std::string_view dataTypeName = "edm4eic::ClusterData"
 

Friends

class ClusterCollectionData
 

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

using edm4eic::ClusterCollection::const_iterator = ClusterCollectionIterator

◆ const_reverse_iterator

using edm4eic::ClusterCollection::const_reverse_iterator = std::reverse_iterator<const_iterator>

◆ difference_type

using edm4eic::ClusterCollection::difference_type = ptrdiff_t

◆ iterator

using edm4eic::ClusterCollection::iterator = ClusterMutableCollectionIterator

◆ mutable_type

using edm4eic::ClusterCollection::mutable_type = MutableCluster

◆ reverse_iterator

using edm4eic::ClusterCollection::reverse_iterator = std::reverse_iterator<iterator>

◆ size_type

using edm4eic::ClusterCollection::size_type = size_t

◆ value_type

using edm4eic::ClusterCollection::value_type = Cluster

Constructor & Destructor Documentation

◆ ClusterCollection() [1/4]

edm4eic::ClusterCollection::ClusterCollection ( )

◆ ClusterCollection() [2/4]

edm4eic::ClusterCollection::ClusterCollection ( ClusterCollectionData && data,
bool isSubsetColl )

◆ ClusterCollection() [3/4]

edm4eic::ClusterCollection::ClusterCollection ( const ClusterCollection & )
delete

◆ ClusterCollection() [4/4]

edm4eic::ClusterCollection::ClusterCollection ( ClusterCollection && )
default

◆ ~ClusterCollection()

edm4eic::ClusterCollection::~ClusterCollection ( )
override

Member Function Documentation

◆ at() [1/2]

MutableCluster edm4eic::ClusterCollection::at ( std::size_t index)

Returns the object of given index.

◆ at() [2/2]

Cluster edm4eic::ClusterCollection::at ( std::size_t index) const

Returns the const object of given index.

◆ begin() [1/2]

iterator edm4eic::ClusterCollection::begin ( )
inline

◆ begin() [2/2]

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

◆ cbegin()

const_iterator edm4eic::ClusterCollection::cbegin ( ) const
inline

◆ cend()

const_iterator edm4eic::ClusterCollection::cend ( ) const
inline

◆ clear()

void edm4eic::ClusterCollection::clear ( )
final

◆ crbegin()

const_reverse_iterator edm4eic::ClusterCollection::crbegin ( ) const
inline

◆ create() [1/2]

MutableCluster edm4eic::ClusterCollection::create ( )

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

◆ create() [2/2]

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

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

◆ crend()

const_reverse_iterator edm4eic::ClusterCollection::crend ( ) const
inline

◆ empty()

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

Is the collection empty.

◆ end() [1/2]

iterator edm4eic::ClusterCollection::end ( )
inline

◆ end() [2/2]

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

◆ energy()

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

◆ energyError()

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

◆ getBuffers()

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

Get the collection buffers for this collection.

◆ getDatamodelRegistryIndex()

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

◆ getDataTypeName()

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

fully qualified type name of stored POD elements - with namespace

◆ getID()

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

◆ getSchemaVersion()

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

schema version

◆ getTypeName()

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

fully qualified type name

◆ getValueTypeName()

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

fully qualified type name of elements - with namespace

◆ intrinsicDirectionError()

std::vector< edm4eic::Cov2f > edm4eic::ClusterCollection::intrinsicDirectionError ( const size_t nElem = 0) const

◆ intrinsicPhi()

std::vector< float > edm4eic::ClusterCollection::intrinsicPhi ( const size_t nElem = 0) const

◆ intrinsicTheta()

std::vector< float > edm4eic::ClusterCollection::intrinsicTheta ( const size_t nElem = 0) const

◆ isSubsetCollection()

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

◆ isValid()

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

◆ max_size()

std::size_t edm4eic::ClusterCollection::max_size ( ) const
final

maximal number of elements in the collection

◆ nhits()

std::vector< std::uint32_t > edm4eic::ClusterCollection::nhits ( const size_t nElem = 0) const

◆ operator->()

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

operator to allow pointer like calling of members a la LCIO

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator[]() [1/2]

MutableCluster edm4eic::ClusterCollection::operator[] ( std::size_t index)

Returns the object of a given index.

◆ operator[]() [2/2]

Cluster edm4eic::ClusterCollection::operator[] ( std::size_t index) const

Returns the const object of given index.

◆ position()

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

◆ positionError()

std::vector< edm4eic::Cov3f > edm4eic::ClusterCollection::positionError ( const size_t nElem = 0) const

◆ prepareAfterRead()

void edm4eic::ClusterCollection::prepareAfterRead ( )
final

◆ prepareForWrite()

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

◆ print()

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

Print this collection to the passed stream.

◆ push_back() [1/2]

void edm4eic::ClusterCollection::push_back ( const Cluster & object)

Append an object to the (subset) collection.

◆ push_back() [2/2]

void edm4eic::ClusterCollection::push_back ( const MutableCluster & object)

Append object to the collection.

◆ rbegin() [1/2]

reverse_iterator edm4eic::ClusterCollection::rbegin ( )
inline

◆ rbegin() [2/2]

const_reverse_iterator edm4eic::ClusterCollection::rbegin ( ) const
inline

◆ rend() [1/2]

reverse_iterator edm4eic::ClusterCollection::rend ( )
inline

◆ rend() [2/2]

const_reverse_iterator edm4eic::ClusterCollection::rend ( ) const
inline

◆ setID()

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

◆ setReferences()

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

◆ setSubsetCollection()

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

◆ size()

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

number of elements in the collection

◆ time()

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

◆ timeError()

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

◆ type()

std::vector< std::int32_t > edm4eic::ClusterCollection::type ( const size_t nElem = 0) const

Friends And Related Symbol Documentation

◆ ClusterCollectionData

friend class ClusterCollectionData
friend

Member Data Documentation

◆ dataTypeName

std::string_view edm4eic::ClusterCollection::dataTypeName = "edm4eic::ClusterData"
staticconstexpr

◆ typeName

std::string_view edm4eic::ClusterCollection::typeName = "edm4eic::ClusterCollection"
staticconstexpr

◆ valueTypeName

std::string_view edm4eic::ClusterCollection::valueTypeName = "edm4eic::Cluster"
staticconstexpr
The documentation for this class was generated from the following files: