#include <CalorimeterHitCollection.h>

Inheritance diagram for edm4eic::CalorimeterHitCollection:

Public Types
using	value_type = CalorimeterHit

using	mutable_type = MutableCalorimeterHit

using	const_iterator = CalorimeterHitCollectionIterator

using	iterator = CalorimeterHitMutableCollectionIterator

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

	CalorimeterHitCollection (CalorimeterHitCollectionData &&data, bool isSubsetColl)

	CalorimeterHitCollection (const CalorimeterHitCollection &)=delete

CalorimeterHitCollection &	operator= (const CalorimeterHitCollection &)=delete

	CalorimeterHitCollection (CalorimeterHitCollection &&)=default

CalorimeterHitCollection &	operator= (CalorimeterHitCollection &&)=default

	~CalorimeterHitCollection () override

void	clear () final

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

CalorimeterHitCollection *	operator-> ()
	operator to allow pointer like calling of members a la LCIO

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

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

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

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

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

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

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

void	push_back (const CalorimeterHit &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::uint64_t >	cellID (const size_t nElem=0) const

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

std::vector< float >	energyError (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< edm4hep::Vector3f >	position (const size_t nElem=0) const

std::vector< edm4hep::Vector3f >	dimension (const size_t nElem=0) const

std::vector< std::int32_t >	sector (const size_t nElem=0) const

std::vector< std::int32_t >	layer (const size_t nElem=0) const

std::vector< edm4hep::Vector3f >	local (const size_t nElem=0) const

Static Public Attributes
static constexpr std::string_view	typeName = "edm4eic::CalorimeterHitCollection"

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

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

Friends
class	CalorimeterHitCollectionData

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

◆ const_iterator

using edm4eic::CalorimeterHitCollection::const_iterator = CalorimeterHitCollectionIterator

◆ const_reverse_iterator

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

◆ difference_type

using edm4eic::CalorimeterHitCollection::difference_type = ptrdiff_t

◆ iterator

using edm4eic::CalorimeterHitCollection::iterator = CalorimeterHitMutableCollectionIterator

◆ mutable_type

using edm4eic::CalorimeterHitCollection::mutable_type = MutableCalorimeterHit

◆ reverse_iterator

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

◆ size_type

using edm4eic::CalorimeterHitCollection::size_type = size_t

◆ value_type

using edm4eic::CalorimeterHitCollection::value_type = CalorimeterHit

Constructor & Destructor Documentation

◆ CalorimeterHitCollection() [1/4]

edm4eic::CalorimeterHitCollection::CalorimeterHitCollection ( )

◆ CalorimeterHitCollection() [2/4]

edm4eic::CalorimeterHitCollection::CalorimeterHitCollection	(	CalorimeterHitCollectionData &&	data,
		bool	isSubsetColl )

◆ CalorimeterHitCollection() [3/4]

edm4eic::CalorimeterHitCollection::CalorimeterHitCollection ( const CalorimeterHitCollection & )

delete

◆ CalorimeterHitCollection() [4/4]

edm4eic::CalorimeterHitCollection::CalorimeterHitCollection ( CalorimeterHitCollection && )

default

◆ ~CalorimeterHitCollection()

edm4eic::CalorimeterHitCollection::~CalorimeterHitCollection ( )

override

Member Function Documentation

◆ at() [1/2]

MutableCalorimeterHit edm4eic::CalorimeterHitCollection::at ( std::size_t index )

Returns the object of given index.

◆ at() [2/2]

CalorimeterHit edm4eic::CalorimeterHitCollection::at ( std::size_t index ) const

Returns the const object of given index.

◆ begin() [1/2]

iterator edm4eic::CalorimeterHitCollection::begin ( )

inline

◆ begin() [2/2]

const_iterator edm4eic::CalorimeterHitCollection::begin ( ) const

inline

◆ cbegin()

const_iterator edm4eic::CalorimeterHitCollection::cbegin ( ) const

inline

◆ cellID()

std::vector< std::uint64_t > edm4eic::CalorimeterHitCollection::cellID ( const size_t nElem = 0 ) const

◆ cend()

const_iterator edm4eic::CalorimeterHitCollection::cend ( ) const

inline

◆ clear()

void edm4eic::CalorimeterHitCollection::clear ( )

final

◆ crbegin()

const_reverse_iterator edm4eic::CalorimeterHitCollection::crbegin ( ) const

inline

◆ create() [1/2]

MutableCalorimeterHit edm4eic::CalorimeterHitCollection::create ( )

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

◆ create() [2/2]

template<typename... Args>

MutableCalorimeterHit edm4eic::CalorimeterHitCollection::create ( Args &&... args )

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

◆ crend()

const_reverse_iterator edm4eic::CalorimeterHitCollection::crend ( ) const

inline

◆ dimension()

std::vector< edm4hep::Vector3f > edm4eic::CalorimeterHitCollection::dimension ( const size_t nElem = 0 ) const

◆ empty()

bool edm4eic::CalorimeterHitCollection::empty ( ) const

final

Is the collection empty.

◆ end() [1/2]

iterator edm4eic::CalorimeterHitCollection::end ( )

inline

◆ end() [2/2]

const_iterator edm4eic::CalorimeterHitCollection::end ( ) const

inline

◆ energy()

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

◆ energyError()

std::vector< float > edm4eic::CalorimeterHitCollection::energyError ( const size_t nElem = 0 ) const

◆ getBuffers()

podio::CollectionWriteBuffers edm4eic::CalorimeterHitCollection::getBuffers ( )

final

Get the collection buffers for this collection.

◆ getDatamodelRegistryIndex()

size_t edm4eic::CalorimeterHitCollection::getDatamodelRegistryIndex ( ) const

final

◆ getDataTypeName()

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

inlinefinal

fully qualified type name of stored POD elements - with namespace

◆ getID()

uint32_t edm4eic::CalorimeterHitCollection::getID ( ) const

inlinefinal

◆ getSchemaVersion()

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

final

schema version

◆ getTypeName()

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

inlinefinal

fully qualified type name

◆ getValueTypeName()

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

inlinefinal

fully qualified type name of elements - with namespace

◆ isSubsetCollection()

bool edm4eic::CalorimeterHitCollection::isSubsetCollection ( ) const

inlinefinal

◆ isValid()

bool edm4eic::CalorimeterHitCollection::isValid ( ) const

inlinefinal

◆ layer()

std::vector< std::int32_t > edm4eic::CalorimeterHitCollection::layer ( const size_t nElem = 0 ) const

◆ local()

std::vector< edm4hep::Vector3f > edm4eic::CalorimeterHitCollection::local ( const size_t nElem = 0 ) const

◆ max_size()

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

final

maximal number of elements in the collection

◆ operator->()

CalorimeterHitCollection * edm4eic::CalorimeterHitCollection::operator-> ( )

inline

operator to allow pointer like calling of members a la LCIO

◆ operator=() [1/2]

CalorimeterHitCollection & edm4eic::CalorimeterHitCollection::operator= ( CalorimeterHitCollection && )

default

◆ operator=() [2/2]

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

delete

◆ operator[]() [1/2]

MutableCalorimeterHit edm4eic::CalorimeterHitCollection::operator[] ( std::size_t index )

Returns the object of a given index.

◆ operator[]() [2/2]

CalorimeterHit edm4eic::CalorimeterHitCollection::operator[] ( std::size_t index ) const

Returns the const object of given index.

◆ position()

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

◆ prepareAfterRead()

void edm4eic::CalorimeterHitCollection::prepareAfterRead ( )

final

◆ prepareForWrite()

void edm4eic::CalorimeterHitCollection::prepareForWrite ( ) const

final

◆ print()

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

final

Print this collection to the passed stream.

◆ push_back() [1/2]

void edm4eic::CalorimeterHitCollection::push_back ( const CalorimeterHit & object )

Append an object to the (subset) collection.

◆ push_back() [2/2]

void edm4eic::CalorimeterHitCollection::push_back ( const MutableCalorimeterHit & object )

Append object to the collection.

◆ rbegin() [1/2]

reverse_iterator edm4eic::CalorimeterHitCollection::rbegin ( )

inline

◆ rbegin() [2/2]

const_reverse_iterator edm4eic::CalorimeterHitCollection::rbegin ( ) const

inline

◆ rend() [1/2]

reverse_iterator edm4eic::CalorimeterHitCollection::rend ( )

inline

◆ rend() [2/2]

const_reverse_iterator edm4eic::CalorimeterHitCollection::rend ( ) const

inline

◆ sector()

std::vector< std::int32_t > edm4eic::CalorimeterHitCollection::sector ( const size_t nElem = 0 ) const

◆ setID()

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

inlinefinal

◆ setReferences()

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

final

◆ setSubsetCollection()

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

final

◆ size()

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

final

number of elements in the collection

◆ time()

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

◆ timeError()

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

Friends And Related Symbol Documentation

◆ CalorimeterHitCollectionData

friend class CalorimeterHitCollectionData

friend

Member Data Documentation

◆ dataTypeName

std::string_view edm4eic::CalorimeterHitCollection::dataTypeName = "edm4eic::CalorimeterHitData"

staticconstexpr

◆ typeName

std::string_view edm4eic::CalorimeterHitCollection::typeName = "edm4eic::CalorimeterHitCollection"

staticconstexpr

◆ valueTypeName

std::string_view edm4eic::CalorimeterHitCollection::valueTypeName = "edm4eic::CalorimeterHit"

staticconstexpr

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

build/edm4eic/CalorimeterHitCollection.h
build/src/CalorimeterHitCollection.cc

Public Types

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

◆ CalorimeterHitCollection() [1/4]

◆ CalorimeterHitCollection() [2/4]

◆ CalorimeterHitCollection() [3/4]

◆ CalorimeterHitCollection() [4/4]

◆ ~CalorimeterHitCollection()

Member Function Documentation

◆ at() [1/2]

◆ at() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cellID()

◆ cend()

◆ clear()

◆ crbegin()

◆ create() [1/2]

◆ create() [2/2]

◆ crend()

◆ dimension()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ energy()

◆ energyError()

◆ getBuffers()

◆ getDatamodelRegistryIndex()

◆ getDataTypeName()

◆ getID()

◆ getSchemaVersion()

◆ getTypeName()

◆ getValueTypeName()

◆ isSubsetCollection()

◆ isValid()

◆ layer()

◆ local()

◆ max_size()

◆ operator->()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ position()

◆ prepareAfterRead()

◆ prepareForWrite()

◆ print()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ sector()

◆ setID()

◆ setReferences()

◆ setSubsetCollection()

◆ size()

◆ time()

◆ timeError()

Friends And Related Symbol Documentation

◆ CalorimeterHitCollectionData

Member Data Documentation

◆ dataTypeName

◆ typeName

◆ valueTypeName