#include <IrtParticleCollection.h>

Inheritance diagram for edm4eic::IrtParticleCollection:

Public Types
using	value_type = IrtParticle

using	mutable_type = MutableIrtParticle

using	const_iterator = IrtParticleCollectionIterator

using	iterator = IrtParticleMutableCollectionIterator

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
	IrtParticleCollection ()=default

	IrtParticleCollection (IrtParticleCollectionData &&data, bool isSubsetColl)

	IrtParticleCollection (const IrtParticleCollection &)=delete

IrtParticleCollection &	operator= (const IrtParticleCollection &)=delete

	IrtParticleCollection (IrtParticleCollection &&)=default

IrtParticleCollection &	operator= (IrtParticleCollection &&)=default

	~IrtParticleCollection () override

void	clear () final

void	print (std::ostream &os=std::cout, bool flush=true) const final
	Print this collection to the passed stream.

MutableIrtParticle	create ()
	Append a new object to the collection, and return this object.

template<typename... Args>
MutableIrtParticle	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

IrtParticle	operator[] (std::size_t index) const
	Returns the const object of given index.

MutableIrtParticle	operator[] (std::size_t index)
	Returns the object of a given index.

IrtParticle	at (std::size_t index) const
	Returns the const object of given index.

MutableIrtParticle	at (std::size_t index)
	Returns the object of given index.

void	push_back (const MutableIrtParticle &object)
	Append object to the collection.

void	push_back (const IrtParticle &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::int32_t >	PDG (const size_t nElem=0) const

std::vector< std::uint16_t >	npe (const size_t nElem=0) const

std::vector< std::uint16_t >	nhits (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::IrtParticleCollection"

static constexpr std::string_view	valueTypeName = "edm4eic::IrtParticle"

static constexpr std::string_view	dataTypeName = "edm4eic::IrtParticleData"

Friends
class	IrtParticleCollectionData

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

using edm4eic::IrtParticleCollection::const_iterator = IrtParticleCollectionIterator

◆ const_reverse_iterator

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

◆ difference_type

using edm4eic::IrtParticleCollection::difference_type = ptrdiff_t

◆ iterator

using edm4eic::IrtParticleCollection::iterator = IrtParticleMutableCollectionIterator

◆ mutable_type

using edm4eic::IrtParticleCollection::mutable_type = MutableIrtParticle

◆ reverse_iterator

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

◆ size_type

using edm4eic::IrtParticleCollection::size_type = size_t

◆ value_type

using edm4eic::IrtParticleCollection::value_type = IrtParticle

Constructor & Destructor Documentation

◆ IrtParticleCollection() [1/4]

edm4eic::IrtParticleCollection::IrtParticleCollection ( )

default

◆ IrtParticleCollection() [2/4]

edm4eic::IrtParticleCollection::IrtParticleCollection	(	IrtParticleCollectionData &&	data,
		bool	isSubsetColl )

◆ IrtParticleCollection() [3/4]

edm4eic::IrtParticleCollection::IrtParticleCollection ( const IrtParticleCollection & )

delete

◆ IrtParticleCollection() [4/4]

edm4eic::IrtParticleCollection::IrtParticleCollection ( IrtParticleCollection && )

default

◆ ~IrtParticleCollection()

edm4eic::IrtParticleCollection::~IrtParticleCollection ( )

override

Member Function Documentation

◆ __cppyy_pythonize__()

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

inlinestatic

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

◆ at() [1/2]

MutableIrtParticle edm4eic::IrtParticleCollection::at ( std::size_t index )

Returns the object of given index.

◆ at() [2/2]

IrtParticle edm4eic::IrtParticleCollection::at ( std::size_t index ) const

Returns the const object of given index.

◆ begin() [1/2]

iterator edm4eic::IrtParticleCollection::begin ( )

inline

◆ begin() [2/2]

const_iterator edm4eic::IrtParticleCollection::begin ( ) const

inline

◆ cbegin()

const_iterator edm4eic::IrtParticleCollection::cbegin ( ) const

inline

◆ cend()

const_iterator edm4eic::IrtParticleCollection::cend ( ) const

inline

◆ clear()

void edm4eic::IrtParticleCollection::clear ( )

final

◆ crbegin()

const_reverse_iterator edm4eic::IrtParticleCollection::crbegin ( ) const

inline

◆ create() [1/2]

MutableIrtParticle edm4eic::IrtParticleCollection::create ( )

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

◆ create() [2/2]

template<typename... Args>

MutableIrtParticle edm4eic::IrtParticleCollection::create ( Args &&... args )

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

◆ crend()

const_reverse_iterator edm4eic::IrtParticleCollection::crend ( ) const

inline

◆ empty()

bool edm4eic::IrtParticleCollection::empty ( ) const

final

Is the collection empty.

◆ end() [1/2]

iterator edm4eic::IrtParticleCollection::end ( )

inline

◆ end() [2/2]

const_iterator edm4eic::IrtParticleCollection::end ( ) const

inline

◆ getBuffers()

podio::CollectionWriteBuffers edm4eic::IrtParticleCollection::getBuffers ( )

final

Get the collection buffers for this collection.

◆ getDatamodelRegistryIndex()

size_t edm4eic::IrtParticleCollection::getDatamodelRegistryIndex ( ) const

final

◆ getDataTypeName()

const std::string_view edm4eic::IrtParticleCollection::getDataTypeName ( ) const

inlinefinal

fully qualified type name of stored POD elements - with namespace

◆ getID()

uint32_t edm4eic::IrtParticleCollection::getID ( ) const

inlinefinal

◆ getSchemaVersion()

podio::SchemaVersionT edm4eic::IrtParticleCollection::getSchemaVersion ( ) const

final

schema version

◆ getTypeName()

const std::string_view edm4eic::IrtParticleCollection::getTypeName ( ) const

inlinefinal

fully qualified type name

◆ getValueTypeName()

const std::string_view edm4eic::IrtParticleCollection::getValueTypeName ( ) const

inlinefinal

fully qualified type name of elements - with namespace

◆ hasID()

bool edm4eic::IrtParticleCollection::hasID ( ) const

inlinefinal

check if the collection has a valid ID

◆ isSubsetCollection()

bool edm4eic::IrtParticleCollection::isSubsetCollection ( ) const

inlinefinal

◆ isValid()

bool edm4eic::IrtParticleCollection::isValid ( ) const

inlinefinal

◆ max_size()

std::size_t edm4eic::IrtParticleCollection::max_size ( ) const

final

maximal number of elements in the collection

◆ nhits()

std::vector< std::uint16_t > edm4eic::IrtParticleCollection::nhits ( const size_t nElem = 0 ) const

◆ npe()

std::vector< std::uint16_t > edm4eic::IrtParticleCollection::npe ( const size_t nElem = 0 ) const

◆ operator=() [1/2]

IrtParticleCollection & edm4eic::IrtParticleCollection::operator= ( const IrtParticleCollection & )

delete

◆ operator=() [2/2]

IrtParticleCollection & edm4eic::IrtParticleCollection::operator= ( IrtParticleCollection && )

default

◆ operator[]() [1/2]

MutableIrtParticle edm4eic::IrtParticleCollection::operator[] ( std::size_t index )

Returns the object of a given index.

◆ operator[]() [2/2]

IrtParticle edm4eic::IrtParticleCollection::operator[] ( std::size_t index ) const

Returns the const object of given index.

◆ PDG()

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

◆ prepareAfterRead()

void edm4eic::IrtParticleCollection::prepareAfterRead ( )

final

◆ prepareForWrite()

void edm4eic::IrtParticleCollection::prepareForWrite ( ) const

final

◆ print()

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

final

Print this collection to the passed stream.

◆ push_back() [1/2]

void edm4eic::IrtParticleCollection::push_back ( const IrtParticle & object )

Append an object to the (subset) collection.

◆ push_back() [2/2]

void edm4eic::IrtParticleCollection::push_back ( const MutableIrtParticle & object )

Append object to the collection.

◆ rbegin() [1/2]

reverse_iterator edm4eic::IrtParticleCollection::rbegin ( )

inline

◆ rbegin() [2/2]

const_reverse_iterator edm4eic::IrtParticleCollection::rbegin ( ) const

inline

◆ rend() [1/2]

reverse_iterator edm4eic::IrtParticleCollection::rend ( )

inline

◆ rend() [2/2]

const_reverse_iterator edm4eic::IrtParticleCollection::rend ( ) const

inline

◆ setID()

void edm4eic::IrtParticleCollection::setID ( uint32_t ID )

inlinefinal

◆ setReferences()

bool edm4eic::IrtParticleCollection::setReferences ( const podio::ICollectionProvider * collectionProvider )

final

◆ setSubsetCollection()

void edm4eic::IrtParticleCollection::setSubsetCollection ( bool setSubset = true )

final

◆ size()

std::size_t edm4eic::IrtParticleCollection::size ( ) const

final

number of elements in the collection

Friends And Related Symbol Documentation

◆ IrtParticleCollectionData

friend class IrtParticleCollectionData

friend

Member Data Documentation

◆ dataTypeName

std::string_view edm4eic::IrtParticleCollection::dataTypeName = "edm4eic::IrtParticleData"

staticconstexpr

◆ typeName

std::string_view edm4eic::IrtParticleCollection::typeName = "edm4eic::IrtParticleCollection"

staticconstexpr

◆ valueTypeName

std::string_view edm4eic::IrtParticleCollection::valueTypeName = "edm4eic::IrtParticle"

staticconstexpr

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

build/edm4eic/IrtParticleCollection.h
build/src/IrtParticleCollection.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_reverse_iterator

◆ difference_type

◆ iterator

◆ mutable_type

◆ reverse_iterator

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ IrtParticleCollection() [1/4]

◆ IrtParticleCollection() [2/4]

◆ IrtParticleCollection() [3/4]

◆ IrtParticleCollection() [4/4]

◆ ~IrtParticleCollection()

Member Function Documentation

◆ __cppyy_pythonize__()

◆ at() [1/2]

◆ at() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ clear()

◆ crbegin()

◆ create() [1/2]

◆ create() [2/2]

◆ crend()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ getBuffers()

◆ getDatamodelRegistryIndex()

◆ getDataTypeName()

◆ getID()

◆ getSchemaVersion()

◆ getTypeName()

◆ getValueTypeName()

◆ hasID()

◆ isSubsetCollection()

◆ isValid()

◆ max_size()

◆ nhits()

◆ npe()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ PDG()

◆ prepareAfterRead()

◆ prepareForWrite()

◆ print()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ setID()

◆ setReferences()

◆ setSubsetCollection()

◆ size()

Friends And Related Symbol Documentation

◆ IrtParticleCollectionData

Member Data Documentation

◆ dataTypeName

◆ typeName

◆ valueTypeName