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

#include <ReconstructedParticleCollection.h>

Inheritance diagram for edm4eic::ReconstructedParticleCollection:

Public Types

using value_type = ReconstructedParticle
 
using const_iterator = ReconstructedParticleCollectionIterator
 
using iterator = ReconstructedParticleMutableCollectionIterator
 

Public Member Functions

 ReconstructedParticleCollection ()
 
 ReconstructedParticleCollection (ReconstructedParticleCollectionData &&data, bool isSubsetColl)
 
 ReconstructedParticleCollection (const ReconstructedParticleCollection &)=delete
 
ReconstructedParticleCollectionoperator= (const ReconstructedParticleCollection &)=delete
 
 ReconstructedParticleCollection (ReconstructedParticleCollection &&)=default
 
ReconstructedParticleCollectionoperator= (ReconstructedParticleCollection &&)=default
 
 ~ReconstructedParticleCollection ()
 
void clear () final
 
void print (std::ostream &os=std::cout, bool flush=true) const final
 Print this collection to the passed stream.
 
ReconstructedParticleCollectionoperator-> ()
 operator to allow pointer like calling of members a la LCIO
 
MutableReconstructedParticle create ()
 Append a new object to the collection, and return this object.
 
template<typename... Args>
MutableReconstructedParticle 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
 
ReconstructedParticle operator[] (std::size_t index) const
 Returns the const object of given index.
 
MutableReconstructedParticle operator[] (std::size_t index)
 Returns the object of a given index.
 
ReconstructedParticle at (std::size_t index) const
 Returns the const object of given index.
 
MutableReconstructedParticle at (std::size_t index)
 Returns the object of given index.
 
void push_back (MutableReconstructedParticle object)
 Append object to the collection.
 
void push_back (ReconstructedParticle 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::int32_t > type (const size_t nElem=0) const
 
std::vector< float > energy (const size_t nElem=0) const
 
std::vector< edm4hep::Vector3f > momentum (const size_t nElem=0) const
 
std::vector< edm4hep::Vector3f > referencePoint (const size_t nElem=0) const
 
std::vector< float > charge (const size_t nElem=0) const
 
std::vector< float > mass (const size_t nElem=0) const
 
std::vector< float > goodnessOfPID (const size_t nElem=0) const
 
std::vector< edm4eic::Cov4fcovMatrix (const size_t nElem=0) const
 
std::vector< std::int32_t > PDG (const size_t nElem=0) const
 

Static Public Attributes

static constexpr auto typeName = "edm4eic::ReconstructedParticleCollection"
 
static constexpr auto valueTypeName = "edm4eic::ReconstructedParticle"
 
static constexpr auto dataTypeName = "edm4eic::ReconstructedParticleData"
 

Friends

class ReconstructedParticleCollectionData
 

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ value_type

Constructor & Destructor Documentation

◆ ReconstructedParticleCollection() [1/4]

edm4eic::ReconstructedParticleCollection::ReconstructedParticleCollection ( )

◆ ReconstructedParticleCollection() [2/4]

edm4eic::ReconstructedParticleCollection::ReconstructedParticleCollection ( ReconstructedParticleCollectionData && data,
bool isSubsetColl )

◆ ReconstructedParticleCollection() [3/4]

edm4eic::ReconstructedParticleCollection::ReconstructedParticleCollection ( const ReconstructedParticleCollection & )
delete

◆ ReconstructedParticleCollection() [4/4]

edm4eic::ReconstructedParticleCollection::ReconstructedParticleCollection ( ReconstructedParticleCollection && )
default

◆ ~ReconstructedParticleCollection()

edm4eic::ReconstructedParticleCollection::~ReconstructedParticleCollection ( )

Member Function Documentation

◆ at() [1/2]

MutableReconstructedParticle edm4eic::ReconstructedParticleCollection::at ( std::size_t index)

Returns the object of given index.

◆ at() [2/2]

ReconstructedParticle edm4eic::ReconstructedParticleCollection::at ( std::size_t index) const

Returns the const object of given index.

◆ begin() [1/2]

iterator edm4eic::ReconstructedParticleCollection::begin ( )
inline

◆ begin() [2/2]

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

◆ charge()

std::vector< float > edm4eic::ReconstructedParticleCollection::charge ( const size_t nElem = 0) const

◆ clear()

void edm4eic::ReconstructedParticleCollection::clear ( )
final

◆ covMatrix()

std::vector< edm4eic::Cov4f > edm4eic::ReconstructedParticleCollection::covMatrix ( const size_t nElem = 0) const

◆ create() [1/2]

MutableReconstructedParticle edm4eic::ReconstructedParticleCollection::create ( )

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

◆ create() [2/2]

template<typename... Args>
MutableReconstructedParticle edm4eic::ReconstructedParticleCollection::create ( Args &&... args)

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

◆ empty()

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

Is the collection empty.

◆ end() [1/2]

iterator edm4eic::ReconstructedParticleCollection::end ( )
inline

◆ end() [2/2]

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

◆ energy()

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

◆ getBuffers()

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

Get the collection buffers for this collection.

◆ getDatamodelRegistryIndex()

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

◆ getDataTypeName()

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

fully qualified type name of stored POD elements - with namespace

◆ getID()

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

◆ getSchemaVersion()

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

schema version

◆ getTypeName()

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

fully qualified type name

◆ getValueTypeName()

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

fully qualified type name of elements - with namespace

◆ goodnessOfPID()

std::vector< float > edm4eic::ReconstructedParticleCollection::goodnessOfPID ( const size_t nElem = 0) const

◆ isSubsetCollection()

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

◆ isValid()

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

◆ mass()

std::vector< float > edm4eic::ReconstructedParticleCollection::mass ( const size_t nElem = 0) const

◆ momentum()

std::vector< edm4hep::Vector3f > edm4eic::ReconstructedParticleCollection::momentum ( const size_t nElem = 0) const

◆ operator->()

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

operator to allow pointer like calling of members a la LCIO

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator[]() [1/2]

MutableReconstructedParticle edm4eic::ReconstructedParticleCollection::operator[] ( std::size_t index)

Returns the object of a given index.

◆ operator[]() [2/2]

ReconstructedParticle edm4eic::ReconstructedParticleCollection::operator[] ( std::size_t index) const

Returns the const object of given index.

◆ PDG()

std::vector< std::int32_t > edm4eic::ReconstructedParticleCollection::PDG ( const size_t nElem = 0) const

◆ prepareAfterRead()

void edm4eic::ReconstructedParticleCollection::prepareAfterRead ( )
final

◆ prepareForWrite()

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

◆ print()

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

Print this collection to the passed stream.

◆ push_back() [1/2]

void edm4eic::ReconstructedParticleCollection::push_back ( MutableReconstructedParticle object)

Append object to the collection.

◆ push_back() [2/2]

void edm4eic::ReconstructedParticleCollection::push_back ( ReconstructedParticle object)

Append an object to the (subset) collection.

◆ referencePoint()

std::vector< edm4hep::Vector3f > edm4eic::ReconstructedParticleCollection::referencePoint ( const size_t nElem = 0) const

◆ setID()

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

◆ setReferences()

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

◆ setSubsetCollection()

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

◆ size()

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

number of elements in the collection

◆ type()

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

Friends And Related Symbol Documentation

◆ ReconstructedParticleCollectionData

Member Data Documentation

◆ dataTypeName

auto edm4eic::ReconstructedParticleCollection::dataTypeName = "edm4eic::ReconstructedParticleData"
staticconstexpr

◆ typeName

auto edm4eic::ReconstructedParticleCollection::typeName = "edm4eic::ReconstructedParticleCollection"
staticconstexpr

◆ valueTypeName

auto edm4eic::ReconstructedParticleCollection::valueTypeName = "edm4eic::ReconstructedParticle"
staticconstexpr

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