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

#include <TrackCollection.h>

Inheritance diagram for edm4eic::TrackCollection:

Public Types

using value_type = Track
 
using mutable_type = MutableTrack
 
using const_iterator = TrackCollectionIterator
 
using iterator = TrackMutableCollectionIterator
 
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

 TrackCollection ()
 
 TrackCollection (TrackCollectionData &&data, bool isSubsetColl)
 
 TrackCollection (const TrackCollection &)=delete
 
TrackCollection & operator= (const TrackCollection &)=delete
 
 TrackCollection (TrackCollection &&)=default
 
TrackCollection & operator= (TrackCollection &&)=default
 
 ~TrackCollection () override
 
void clear () final
 
void print (std::ostream &os=std::cout, bool flush=true) const final
 Print this collection to the passed stream.
 
TrackCollection * operator-> ()
 operator to allow pointer like calling of members a la LCIO
 
MutableTrack create ()
 Append a new object to the collection, and return this object.
 
template<typename... Args>
MutableTrack 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
 
Track operator[] (std::size_t index) const
 Returns the const object of given index.
 
MutableTrack operator[] (std::size_t index)
 Returns the object of a given index.
 
Track at (std::size_t index) const
 Returns the const object of given index.
 
MutableTrack at (std::size_t index)
 Returns the object of given index.
 
void push_back (const MutableTrack &object)
 Append object to the collection.
 
void push_back (const Track &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< edm4hep::Vector3f > position (const size_t nElem=0) const
 
std::vector< edm4hep::Vector3f > momentum (const size_t nElem=0) const
 
std::vector< edm4eic::Cov6f > positionMomentumCovariance (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< float > charge (const size_t nElem=0) const
 
std::vector< float > chi2 (const size_t nElem=0) const
 
std::vector< std::uint32_t > ndf (const size_t nElem=0) const
 
std::vector< std::int32_t > pdg (const size_t nElem=0) const
 

Static Public Attributes

static constexpr std::string_view typeName = "edm4eic::TrackCollection"
 
static constexpr std::string_view valueTypeName = "edm4eic::Track"
 
static constexpr std::string_view dataTypeName = "edm4eic::TrackData"
 

Friends

class TrackCollectionData
 

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

using edm4eic::TrackCollection::const_iterator = TrackCollectionIterator

◆ const_reverse_iterator

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

◆ difference_type

using edm4eic::TrackCollection::difference_type = ptrdiff_t

◆ iterator

using edm4eic::TrackCollection::iterator = TrackMutableCollectionIterator

◆ mutable_type

using edm4eic::TrackCollection::mutable_type = MutableTrack

◆ reverse_iterator

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

◆ size_type

using edm4eic::TrackCollection::size_type = size_t

◆ value_type

using edm4eic::TrackCollection::value_type = Track

Constructor & Destructor Documentation

◆ TrackCollection() [1/4]

edm4eic::TrackCollection::TrackCollection ( )

◆ TrackCollection() [2/4]

edm4eic::TrackCollection::TrackCollection ( TrackCollectionData && data,
bool isSubsetColl )

◆ TrackCollection() [3/4]

edm4eic::TrackCollection::TrackCollection ( const TrackCollection & )
delete

◆ TrackCollection() [4/4]

edm4eic::TrackCollection::TrackCollection ( TrackCollection && )
default

◆ ~TrackCollection()

edm4eic::TrackCollection::~TrackCollection ( )
override

Member Function Documentation

◆ at() [1/2]

MutableTrack edm4eic::TrackCollection::at ( std::size_t index)

Returns the object of given index.

◆ at() [2/2]

Track edm4eic::TrackCollection::at ( std::size_t index) const

Returns the const object of given index.

◆ begin() [1/2]

iterator edm4eic::TrackCollection::begin ( )
inline

◆ begin() [2/2]

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

◆ cbegin()

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

◆ cend()

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

◆ charge()

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

◆ chi2()

std::vector< float > edm4eic::TrackCollection::chi2 ( const size_t nElem = 0) const

◆ clear()

void edm4eic::TrackCollection::clear ( )
final

◆ crbegin()

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

◆ create() [1/2]

MutableTrack edm4eic::TrackCollection::create ( )

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

◆ create() [2/2]

template<typename... Args>
MutableTrack edm4eic::TrackCollection::create ( Args &&... args)

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

◆ crend()

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

◆ empty()

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

Is the collection empty.

◆ end() [1/2]

iterator edm4eic::TrackCollection::end ( )
inline

◆ end() [2/2]

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

◆ getBuffers()

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

Get the collection buffers for this collection.

◆ getDatamodelRegistryIndex()

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

◆ getDataTypeName()

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

fully qualified type name of stored POD elements - with namespace

◆ getID()

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

◆ getSchemaVersion()

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

schema version

◆ getTypeName()

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

fully qualified type name

◆ getValueTypeName()

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

fully qualified type name of elements - with namespace

◆ isSubsetCollection()

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

◆ isValid()

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

◆ max_size()

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

maximal number of elements in the collection

◆ momentum()

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

◆ ndf()

std::vector< std::uint32_t > edm4eic::TrackCollection::ndf ( const size_t nElem = 0) const

◆ operator->()

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

operator to allow pointer like calling of members a la LCIO

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator[]() [1/2]

MutableTrack edm4eic::TrackCollection::operator[] ( std::size_t index)

Returns the object of a given index.

◆ operator[]() [2/2]

Track edm4eic::TrackCollection::operator[] ( std::size_t index) const

Returns the const object of given index.

◆ pdg()

std::vector< std::int32_t > edm4eic::TrackCollection::pdg ( const size_t nElem = 0) const

◆ position()

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

◆ positionMomentumCovariance()

std::vector< edm4eic::Cov6f > edm4eic::TrackCollection::positionMomentumCovariance ( const size_t nElem = 0) const

◆ prepareAfterRead()

void edm4eic::TrackCollection::prepareAfterRead ( )
final

◆ prepareForWrite()

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

◆ print()

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

Print this collection to the passed stream.

◆ push_back() [1/2]

void edm4eic::TrackCollection::push_back ( const MutableTrack & object)

Append object to the collection.

◆ push_back() [2/2]

void edm4eic::TrackCollection::push_back ( const Track & object)

Append an object to the (subset) collection.

◆ rbegin() [1/2]

reverse_iterator edm4eic::TrackCollection::rbegin ( )
inline

◆ rbegin() [2/2]

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

◆ rend() [1/2]

reverse_iterator edm4eic::TrackCollection::rend ( )
inline

◆ rend() [2/2]

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

◆ setID()

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

◆ setReferences()

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

◆ setSubsetCollection()

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

◆ size()

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

number of elements in the collection

◆ time()

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

◆ timeError()

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

◆ type()

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

Friends And Related Symbol Documentation

◆ TrackCollectionData

friend class TrackCollectionData
friend

Member Data Documentation

◆ dataTypeName

std::string_view edm4eic::TrackCollection::dataTypeName = "edm4eic::TrackData"
staticconstexpr

◆ typeName

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

◆ valueTypeName

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