#include <RingImageCollection.h>

Inheritance diagram for edm4eic::RingImageCollection:

Public Types
using	value_type = RingImage
using	mutable_type = MutableRingImage
using	const_iterator = RingImageCollectionIterator
using	iterator = RingImageMutableCollectionIterator
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
	RingImageCollection ()=default
	RingImageCollection (RingImageCollectionData &&data, bool isSubsetColl)
	RingImageCollection (const RingImageCollection &)=delete
RingImageCollection &	operator= (const RingImageCollection &)=delete
	RingImageCollection (RingImageCollection &&)=default
RingImageCollection &	operator= (RingImageCollection &&)=default
	~RingImageCollection () override
void	clear () final
void	print (std::ostream &os=std::cout, bool flush=true) const final
	Print this collection to the passed stream.
MutableRingImage	create ()
	Append a new object to the collection, and return this object.
template<typename... Args>
MutableRingImage	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
RingImage	operator[] (std::size_t index) const
	Returns the const object of given index.
MutableRingImage	operator[] (std::size_t index)
	Returns the object of a given index.
RingImage	at (std::size_t index) const
	Returns the const object of given index.
MutableRingImage	at (std::size_t index)
	Returns the object of given index.
void	push_back (const MutableRingImage &object)
	Append object to the collection.
void	push_back (const RingImage &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< float >	npe (const size_t nElem=0) const
std::vector< edm4hep::Vector3f >	position (const size_t nElem=0) const
std::vector< edm4hep::Vector3f >	positionError (const size_t nElem=0) const
std::vector< float >	theta (const size_t nElem=0) const
std::vector< float >	thetaError (const size_t nElem=0) const
std::vector< float >	radius (const size_t nElem=0) const
std::vector< float >	radiusError (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::RingImageCollection"
static constexpr std::string_view	valueTypeName = "edm4eic::RingImage"
static constexpr std::string_view	dataTypeName = "edm4eic::RingImageData"

Friends
class	RingImageCollectionData

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

using edm4eic::RingImageCollection::const_iterator = RingImageCollectionIterator

◆ const_reverse_iterator

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

◆ difference_type

using edm4eic::RingImageCollection::difference_type = ptrdiff_t

◆ iterator

using edm4eic::RingImageCollection::iterator = RingImageMutableCollectionIterator

◆ mutable_type

using edm4eic::RingImageCollection::mutable_type = MutableRingImage

◆ reverse_iterator

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

◆ size_type

using edm4eic::RingImageCollection::size_type = size_t

◆ value_type

using edm4eic::RingImageCollection::value_type = RingImage

Constructor & Destructor Documentation

◆ RingImageCollection() [1/4]

edm4eic::RingImageCollection::RingImageCollection ( )

default

◆ RingImageCollection() [2/4]

edm4eic::RingImageCollection::RingImageCollection	(	RingImageCollectionData &&	data,
		bool	isSubsetColl )

◆ RingImageCollection() [3/4]

edm4eic::RingImageCollection::RingImageCollection ( const RingImageCollection & )

delete

◆ RingImageCollection() [4/4]

edm4eic::RingImageCollection::RingImageCollection ( RingImageCollection && )

default

◆ ~RingImageCollection()

edm4eic::RingImageCollection::~RingImageCollection ( )

override

Member Function Documentation

◆ __cppyy_pythonize__()

void edm4eic::RingImageCollection::__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]

MutableRingImage edm4eic::RingImageCollection::at ( std::size_t index )

Returns the object of given index.

◆ at() [2/2]

RingImage edm4eic::RingImageCollection::at ( std::size_t index ) const

Returns the const object of given index.

◆ begin() [1/2]

iterator edm4eic::RingImageCollection::begin ( )

inline

◆ begin() [2/2]

const_iterator edm4eic::RingImageCollection::begin ( ) const

inline

◆ cbegin()

const_iterator edm4eic::RingImageCollection::cbegin ( ) const

inline

◆ cend()

const_iterator edm4eic::RingImageCollection::cend ( ) const

inline

◆ clear()

void edm4eic::RingImageCollection::clear ( )

final

◆ crbegin()

const_reverse_iterator edm4eic::RingImageCollection::crbegin ( ) const

inline

◆ create() [1/2]

MutableRingImage edm4eic::RingImageCollection::create ( )

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

◆ create() [2/2]

template<typename... Args>

MutableRingImage edm4eic::RingImageCollection::create ( Args &&... args )

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

◆ crend()

const_reverse_iterator edm4eic::RingImageCollection::crend ( ) const

inline

◆ empty()

bool edm4eic::RingImageCollection::empty ( ) const

final

Is the collection empty.

◆ end() [1/2]

iterator edm4eic::RingImageCollection::end ( )

inline

◆ end() [2/2]

const_iterator edm4eic::RingImageCollection::end ( ) const

inline

◆ getBuffers()

podio::CollectionWriteBuffers edm4eic::RingImageCollection::getBuffers ( )

final

Get the collection buffers for this collection.

◆ getDatamodelRegistryIndex()

size_t edm4eic::RingImageCollection::getDatamodelRegistryIndex ( ) const

final

◆ getDataTypeName()

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

inlinefinal

fully qualified type name of stored POD elements - with namespace

◆ getID()

uint32_t edm4eic::RingImageCollection::getID ( ) const

inlinefinal

◆ getSchemaVersion()

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

final

schema version

◆ getTypeName()

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

inlinefinal

fully qualified type name

◆ getValueTypeName()

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

inlinefinal

fully qualified type name of elements - with namespace

◆ hasID()

bool edm4eic::RingImageCollection::hasID ( ) const

inlinefinal

check if the collection has a valid ID

◆ isSubsetCollection()

bool edm4eic::RingImageCollection::isSubsetCollection ( ) const

inlinefinal

◆ isValid()

bool edm4eic::RingImageCollection::isValid ( ) const

inlinefinal

◆ max_size()

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

final

maximal number of elements in the collection

◆ npe()

std::vector< float > edm4eic::RingImageCollection::npe ( const size_t nElem = 0 ) const

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

RingImageCollection & edm4eic::RingImageCollection::operator= ( RingImageCollection && )

default

◆ operator[]() [1/2]

MutableRingImage edm4eic::RingImageCollection::operator[] ( std::size_t index )

Returns the object of a given index.

◆ operator[]() [2/2]

RingImage edm4eic::RingImageCollection::operator[] ( std::size_t index ) const

Returns the const object of given index.

◆ position()

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

◆ positionError()

std::vector< edm4hep::Vector3f > edm4eic::RingImageCollection::positionError ( const size_t nElem = 0 ) const

◆ prepareAfterRead()

void edm4eic::RingImageCollection::prepareAfterRead ( )

final

◆ prepareForWrite()

void edm4eic::RingImageCollection::prepareForWrite ( ) const

final

◆ print()

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

final

Print this collection to the passed stream.

◆ push_back() [1/2]

void edm4eic::RingImageCollection::push_back ( const MutableRingImage & object )

Append object to the collection.

◆ push_back() [2/2]

void edm4eic::RingImageCollection::push_back ( const RingImage & object )

Append an object to the (subset) collection.

◆ radius()

std::vector< float > edm4eic::RingImageCollection::radius ( const size_t nElem = 0 ) const

◆ radiusError()

std::vector< float > edm4eic::RingImageCollection::radiusError ( const size_t nElem = 0 ) const

◆ rbegin() [1/2]

reverse_iterator edm4eic::RingImageCollection::rbegin ( )

inline

◆ rbegin() [2/2]

const_reverse_iterator edm4eic::RingImageCollection::rbegin ( ) const

inline

◆ rend() [1/2]

reverse_iterator edm4eic::RingImageCollection::rend ( )

inline

◆ rend() [2/2]

const_reverse_iterator edm4eic::RingImageCollection::rend ( ) const

inline

◆ setID()

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

inlinefinal

◆ setReferences()

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

final

◆ setSubsetCollection()

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

final

◆ size()

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

final

number of elements in the collection

◆ theta()

std::vector< float > edm4eic::RingImageCollection::theta ( const size_t nElem = 0 ) const

◆ thetaError()

std::vector< float > edm4eic::RingImageCollection::thetaError ( const size_t nElem = 0 ) const

◆ RingImageCollectionData

friend class RingImageCollectionData

friend

Member Data Documentation

◆ dataTypeName

std::string_view edm4eic::RingImageCollection::dataTypeName = "edm4eic::RingImageData"

staticconstexpr

◆ typeName

std::string_view edm4eic::RingImageCollection::typeName = "edm4eic::RingImageCollection"

staticconstexpr

◆ valueTypeName

std::string_view edm4eic::RingImageCollection::valueTypeName = "edm4eic::RingImage"

staticconstexpr

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

build/edm4eic/RingImageCollection.h
build/src/RingImageCollection.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

◆ RingImageCollection() [1/4]

◆ RingImageCollection() [2/4]

◆ RingImageCollection() [3/4]

◆ RingImageCollection() [4/4]

◆ ~RingImageCollection()

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()

◆ npe()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ position()

◆ positionError()

◆ prepareAfterRead()

◆ prepareForWrite()

◆ print()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ radius()

◆ radiusError()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ setID()

◆ setReferences()

◆ setSubsetCollection()

◆ size()

◆ theta()

◆ thetaError()

Friends And Related Symbol Documentation

◆ RingImageCollectionData

Member Data Documentation

◆ dataTypeName

◆ typeName

◆ valueTypeName