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

#include <JetCollection.h>

Inheritance diagram for edm4eic::JetCollection:

Public Types

using value_type = Jet
 
using mutable_type = MutableJet
 
using const_iterator = JetCollectionIterator
 
using iterator = JetMutableCollectionIterator
 
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

 JetCollection ()=default
 
 JetCollection (JetCollectionData &&data, bool isSubsetColl)
 
 JetCollection (const JetCollection &)=delete
 
JetCollection & operator= (const JetCollection &)=delete
 
 JetCollection (JetCollection &&)=default
 
JetCollection & operator= (JetCollection &&)=default
 
 ~JetCollection () override
 
void clear () final
 
void print (std::ostream &os=std::cout, bool flush=true) const final
 Print this collection to the passed stream.
 
MutableJet create ()
 Append a new object to the collection, and return this object.
 
template<typename... Args>
MutableJet 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
 
Jet operator[] (std::size_t index) const
 Returns the const object of given index.
 
MutableJet operator[] (std::size_t index)
 Returns the object of a given index.
 
Jet at (std::size_t index) const
 Returns the const object of given index.
 
MutableJet at (std::size_t index)
 Returns the object of given index.
 
void push_back (const MutableJet &object)
 Append object to the collection.
 
void push_back (const Jet &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 hasID () const final
 check if the collection has a valid ID
 
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::uint32_t > type (const size_t nElem=0) const
 
std::vector< float > area (const size_t nElem=0) const
 
std::vector< float > energy (const size_t nElem=0) const
 
std::vector< float > backgroundEnergyDensity (const size_t nElem=0) const
 
std::vector< edm4hep::Vector3f > momentum (const size_t nElem=0) const
 

Static Public Member Functions

static void __cppyy_pythonize__ (PyObject *klass, const std::string &name)
 Cppyy protocol to setup the pythonizations for this class. Not to be called directly.
 

Static Public Attributes

static constexpr std::string_view typeName = "edm4eic::JetCollection"
 
static constexpr std::string_view valueTypeName = "edm4eic::Jet"
 
static constexpr std::string_view dataTypeName = "edm4eic::JetData"
 

Friends

class JetCollectionData
 

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

using edm4eic::JetCollection::const_iterator = JetCollectionIterator

◆ const_reverse_iterator

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

◆ difference_type

using edm4eic::JetCollection::difference_type = ptrdiff_t

◆ iterator

using edm4eic::JetCollection::iterator = JetMutableCollectionIterator

◆ mutable_type

using edm4eic::JetCollection::mutable_type = MutableJet

◆ reverse_iterator

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

◆ size_type

using edm4eic::JetCollection::size_type = size_t

◆ value_type

using edm4eic::JetCollection::value_type = Jet

Constructor & Destructor Documentation

◆ JetCollection() [1/4]

edm4eic::JetCollection::JetCollection ( )
default

◆ JetCollection() [2/4]

edm4eic::JetCollection::JetCollection ( JetCollectionData && data,
bool isSubsetColl )

◆ JetCollection() [3/4]

edm4eic::JetCollection::JetCollection ( const JetCollection & )
delete

◆ JetCollection() [4/4]

edm4eic::JetCollection::JetCollection ( JetCollection && )
default

◆ ~JetCollection()

edm4eic::JetCollection::~JetCollection ( )
override

Member Function Documentation

◆ __cppyy_pythonize__()

static void edm4eic::JetCollection::__cppyy_pythonize__ ( PyObject * klass,
const std::string & name )
inlinestatic

Cppyy protocol to setup the pythonizations for this class. Not to be called directly.

◆ area()

std::vector< float > edm4eic::JetCollection::area ( const size_t nElem = 0) const

◆ at() [1/2]

MutableJet edm4eic::JetCollection::at ( std::size_t index)

Returns the object of given index.

◆ at() [2/2]

Jet edm4eic::JetCollection::at ( std::size_t index) const

Returns the const object of given index.

◆ backgroundEnergyDensity()

std::vector< float > edm4eic::JetCollection::backgroundEnergyDensity ( const size_t nElem = 0) const

◆ begin() [1/2]

iterator edm4eic::JetCollection::begin ( )
inline

◆ begin() [2/2]

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

◆ cbegin()

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

◆ cend()

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

◆ clear()

void edm4eic::JetCollection::clear ( )
final

◆ crbegin()

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

◆ create() [1/2]

MutableJet edm4eic::JetCollection::create ( )

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

◆ create() [2/2]

template<typename... Args>
MutableJet edm4eic::JetCollection::create ( Args &&... args)

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

◆ crend()

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

◆ empty()

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

Is the collection empty.

◆ end() [1/2]

iterator edm4eic::JetCollection::end ( )
inline

◆ end() [2/2]

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

◆ energy()

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

◆ getBuffers()

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

Get the collection buffers for this collection.

◆ getDatamodelRegistryIndex()

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

◆ getDataTypeName()

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

fully qualified type name of stored POD elements - with namespace

◆ getID()

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

◆ getSchemaVersion()

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

schema version

◆ getTypeName()

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

fully qualified type name

◆ getValueTypeName()

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

fully qualified type name of elements - with namespace

◆ hasID()

bool edm4eic::JetCollection::hasID ( ) const
inlinefinal

check if the collection has a valid ID

◆ isSubsetCollection()

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

◆ isValid()

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

◆ max_size()

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

maximal number of elements in the collection

◆ momentum()

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator[]() [1/2]

MutableJet edm4eic::JetCollection::operator[] ( std::size_t index)

Returns the object of a given index.

◆ operator[]() [2/2]

Jet edm4eic::JetCollection::operator[] ( std::size_t index) const

Returns the const object of given index.

◆ prepareAfterRead()

void edm4eic::JetCollection::prepareAfterRead ( )
final

◆ prepareForWrite()

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

◆ print()

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

Print this collection to the passed stream.

◆ push_back() [1/2]

void edm4eic::JetCollection::push_back ( const Jet & object)

Append an object to the (subset) collection.

◆ push_back() [2/2]

void edm4eic::JetCollection::push_back ( const MutableJet & object)

Append object to the collection.

◆ rbegin() [1/2]

reverse_iterator edm4eic::JetCollection::rbegin ( )
inline

◆ rbegin() [2/2]

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

◆ rend() [1/2]

reverse_iterator edm4eic::JetCollection::rend ( )
inline

◆ rend() [2/2]

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

◆ setID()

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

◆ setReferences()

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

◆ setSubsetCollection()

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

◆ size()

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

number of elements in the collection

◆ type()

std::vector< std::uint32_t > edm4eic::JetCollection::type ( const size_t nElem = 0) const

Friends And Related Symbol Documentation

◆ JetCollectionData

friend class JetCollectionData
friend

Member Data Documentation

◆ dataTypeName

std::string_view edm4eic::JetCollection::dataTypeName = "edm4eic::JetData"
staticconstexpr

◆ typeName

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

◆ valueTypeName

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