edm4eic::ProtoClusterCollection Class Reference

#include <ProtoClusterCollection.h>

Inheritance diagram for edm4eic::ProtoClusterCollection:

Public Types
using	value_type = ProtoCluster
using	mutable_type = MutableProtoCluster
using	const_iterator = ProtoClusterCollectionIterator
using	iterator = ProtoClusterMutableCollectionIterator
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
	ProtoClusterCollection ()
	ProtoClusterCollection (ProtoClusterCollectionData &&data, bool isSubsetColl)
	ProtoClusterCollection (const ProtoClusterCollection &)=delete
ProtoClusterCollection &	operator= (const ProtoClusterCollection &)=delete
	ProtoClusterCollection (ProtoClusterCollection &&)=default
ProtoClusterCollection &	operator= (ProtoClusterCollection &&)=default
	~ProtoClusterCollection () override
void	clear () final
void	print (std::ostream &os=std::cout, bool flush=true) const final
	Print this collection to the passed stream.
ProtoClusterCollection *	operator-> ()
	operator to allow pointer like calling of members a la LCIO
MutableProtoCluster	create ()
	Append a new object to the collection, and return this object.
template<typename... Args>
MutableProtoCluster	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
ProtoCluster	operator[] (std::size_t index) const
	Returns the const object of given index.
MutableProtoCluster	operator[] (std::size_t index)
	Returns the object of a given index.
ProtoCluster	at (std::size_t index) const
	Returns the const object of given index.
MutableProtoCluster	at (std::size_t index)
	Returns the object of given index.
void	push_back (const MutableProtoCluster &object)
	Append object to the collection.
void	push_back (const ProtoCluster &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

Static Public Attributes
static constexpr std::string_view	typeName = "edm4eic::ProtoClusterCollection"
static constexpr std::string_view	valueTypeName = "edm4eic::ProtoCluster"
static constexpr std::string_view	dataTypeName = "edm4eic::ProtoClusterData"

Friends
class	ProtoClusterCollectionData

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

const_iterator

using edm4eic::ProtoClusterCollection::const_iterator = ProtoClusterCollectionIterator

const_reverse_iterator

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

difference_type

using edm4eic::ProtoClusterCollection::difference_type = ptrdiff_t

iterator

using edm4eic::ProtoClusterCollection::iterator = ProtoClusterMutableCollectionIterator

mutable_type

using edm4eic::ProtoClusterCollection::mutable_type = MutableProtoCluster

reverse_iterator

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

size_type

using edm4eic::ProtoClusterCollection::size_type = size_t

value_type

using edm4eic::ProtoClusterCollection::value_type = ProtoCluster

Constructor & Destructor Documentation

ProtoClusterCollection() [1/4]

edm4eic::ProtoClusterCollection::ProtoClusterCollection

(

)

ProtoClusterCollection() [2/4]

edm4eic::ProtoClusterCollection::ProtoClusterCollection	(	ProtoClusterCollectionData &&	data,
		bool	isSubsetColl )

ProtoClusterCollection() [3/4]

edm4eic::ProtoClusterCollection::ProtoClusterCollection ( const ProtoClusterCollection & )

delete

ProtoClusterCollection() [4/4]

edm4eic::ProtoClusterCollection::ProtoClusterCollection ( ProtoClusterCollection && )

default

~ProtoClusterCollection()

edm4eic::ProtoClusterCollection::~ProtoClusterCollection ( )

override

Member Function Documentation

at() [1/2]

MutableProtoCluster edm4eic::ProtoClusterCollection::at

(

std::size_t

index

)

Returns the object of given index.

at() [2/2]

ProtoCluster edm4eic::ProtoClusterCollection::at

(

std::size_t

index

)

const

Returns the const object of given index.

begin() [1/2]

iterator edm4eic::ProtoClusterCollection::begin ( )

inline

begin() [2/2]

const_iterator edm4eic::ProtoClusterCollection::begin ( ) const

inline

cbegin()

const_iterator edm4eic::ProtoClusterCollection::cbegin ( ) const

inline

cend()

const_iterator edm4eic::ProtoClusterCollection::cend ( ) const

inline

clear()

void edm4eic::ProtoClusterCollection::clear ( )

final

crbegin()

const_reverse_iterator edm4eic::ProtoClusterCollection::crbegin ( ) const

inline

create() [1/2]

MutableProtoCluster edm4eic::ProtoClusterCollection::create

(

)

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

create() [2/2]

template<typename... Args>

MutableProtoCluster edm4eic::ProtoClusterCollection::create

(

Args &&...

args

)

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

crend()

const_reverse_iterator edm4eic::ProtoClusterCollection::crend ( ) const

inline

empty()

bool edm4eic::ProtoClusterCollection::empty ( ) const

final

Is the collection empty.

end() [1/2]

iterator edm4eic::ProtoClusterCollection::end ( )

inline

end() [2/2]

const_iterator edm4eic::ProtoClusterCollection::end ( ) const

inline

getBuffers()

podio::CollectionWriteBuffers edm4eic::ProtoClusterCollection::getBuffers ( )

final

Get the collection buffers for this collection.

getDatamodelRegistryIndex()

size_t edm4eic::ProtoClusterCollection::getDatamodelRegistryIndex ( ) const

final

getDataTypeName()

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

inlinefinal

fully qualified type name of stored POD elements - with namespace

getID()

uint32_t edm4eic::ProtoClusterCollection::getID ( ) const

inlinefinal

getSchemaVersion()

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

final

schema version

getTypeName()

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

inlinefinal

fully qualified type name

getValueTypeName()

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

inlinefinal

fully qualified type name of elements - with namespace

isSubsetCollection()

bool edm4eic::ProtoClusterCollection::isSubsetCollection ( ) const

inlinefinal

isValid()

bool edm4eic::ProtoClusterCollection::isValid ( ) const

inlinefinal

max_size()

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

final

maximal number of elements in the collection

operator->()

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

inline

operator to allow pointer like calling of members a la LCIO

operator=() [1/2]

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

delete

operator=() [2/2]

ProtoClusterCollection & edm4eic::ProtoClusterCollection::operator= ( ProtoClusterCollection && )

default

operator[]() [1/2]

MutableProtoCluster edm4eic::ProtoClusterCollection::operator[]

(

std::size_t

index

)

Returns the object of a given index.

operator[]() [2/2]

ProtoCluster edm4eic::ProtoClusterCollection::operator[]

(

std::size_t

index

)

const

Returns the const object of given index.

prepareAfterRead()

void edm4eic::ProtoClusterCollection::prepareAfterRead ( )

final

prepareForWrite()

void edm4eic::ProtoClusterCollection::prepareForWrite ( ) const

final

print()

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

final

Print this collection to the passed stream.

push_back() [1/2]

void edm4eic::ProtoClusterCollection::push_back

(

const MutableProtoCluster &

object

)

Append object to the collection.

push_back() [2/2]

void edm4eic::ProtoClusterCollection::push_back

(

const ProtoCluster &

object

)

Append an object to the (subset) collection.

rbegin() [1/2]

reverse_iterator edm4eic::ProtoClusterCollection::rbegin ( )

inline

rbegin() [2/2]

const_reverse_iterator edm4eic::ProtoClusterCollection::rbegin ( ) const

inline

rend() [1/2]

reverse_iterator edm4eic::ProtoClusterCollection::rend ( )

inline

rend() [2/2]

const_reverse_iterator edm4eic::ProtoClusterCollection::rend ( ) const

inline

setID()

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

inlinefinal

setReferences()

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

final

setSubsetCollection()

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

final

size()

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

final

number of elements in the collection

Friends And Related Symbol Documentation

ProtoClusterCollectionData

friend class ProtoClusterCollectionData

friend

Member Data Documentation

dataTypeName

std::string_view edm4eic::ProtoClusterCollection::dataTypeName = "edm4eic::ProtoClusterData"

staticconstexpr

typeName

std::string_view edm4eic::ProtoClusterCollection::typeName = "edm4eic::ProtoClusterCollection"

staticconstexpr

valueTypeName

std::string_view edm4eic::ProtoClusterCollection::valueTypeName = "edm4eic::ProtoCluster"

staticconstexpr

---

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

• build/edm4eic/ProtoClusterCollection.h
• build/src/ProtoClusterCollection.cc