edm4eic::SimPulseCollection Class Reference

#include <SimPulseCollection.h>

Inheritance diagram for edm4eic::SimPulseCollection:

Public Types
using	value_type = SimPulse
using	const_iterator = SimPulseCollectionIterator
using	iterator = SimPulseMutableCollectionIterator
using	difference_type = ptrdiff_t
using	size_type = size_t

Public Member Functions
	SimPulseCollection ()
	SimPulseCollection (SimPulseCollectionData &&data, bool isSubsetColl)
	SimPulseCollection (const SimPulseCollection &)=delete
SimPulseCollection &	operator= (const SimPulseCollection &)=delete
	SimPulseCollection (SimPulseCollection &&)=default
SimPulseCollection &	operator= (SimPulseCollection &&)=default
	~SimPulseCollection ()
void	clear () final
void	print (std::ostream &os=std::cout, bool flush=true) const final
	Print this collection to the passed stream.
SimPulseCollection *	operator-> ()
	operator to allow pointer like calling of members a la LCIO
MutableSimPulse	create ()
	Append a new object to the collection, and return this object.
template<typename... Args>
MutableSimPulse	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
SimPulse	operator[] (std::size_t index) const
	Returns the const object of given index.
MutableSimPulse	operator[] (std::size_t index)
	Returns the object of a given index.
SimPulse	at (std::size_t index) const
	Returns the const object of given index.
MutableSimPulse	at (std::size_t index)
	Returns the object of given index.
void	push_back (const MutableSimPulse &object)
	Append object to the collection.
void	push_back (const SimPulse &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
std::vector< std::uint64_t >	cellID (const size_t nElem=0) const
std::vector< float >	integral (const size_t nElem=0) const
std::vector< edm4hep::Vector3f >	position (const size_t nElem=0) const
std::vector< float >	time (const size_t nElem=0) const
std::vector< float >	interval (const size_t nElem=0) const

Static Public Attributes
static constexpr auto	typeName = "edm4eic::SimPulseCollection"
static constexpr auto	valueTypeName = "edm4eic::SimPulse"
static constexpr auto	dataTypeName = "edm4eic::SimPulseData"

Friends
class	SimPulseCollectionData

Detailed Description

A Collection is identified by an ID.

Member Typedef Documentation

const_iterator

using edm4eic::SimPulseCollection::const_iterator = SimPulseCollectionIterator

difference_type

using edm4eic::SimPulseCollection::difference_type = ptrdiff_t

iterator

using edm4eic::SimPulseCollection::iterator = SimPulseMutableCollectionIterator

size_type

using edm4eic::SimPulseCollection::size_type = size_t

value_type

using edm4eic::SimPulseCollection::value_type = SimPulse

Constructor & Destructor Documentation

SimPulseCollection() [1/4]

edm4eic::SimPulseCollection::SimPulseCollection

(

)

SimPulseCollection() [2/4]

edm4eic::SimPulseCollection::SimPulseCollection	(	SimPulseCollectionData &&	data,
		bool	isSubsetColl )

SimPulseCollection() [3/4]

edm4eic::SimPulseCollection::SimPulseCollection ( const SimPulseCollection & )

delete

SimPulseCollection() [4/4]

edm4eic::SimPulseCollection::SimPulseCollection ( SimPulseCollection && )

default

~SimPulseCollection()

edm4eic::SimPulseCollection::~SimPulseCollection

(

)

Member Function Documentation

at() [1/2]

MutableSimPulse edm4eic::SimPulseCollection::at

(

std::size_t

index

)

Returns the object of given index.

at() [2/2]

SimPulse edm4eic::SimPulseCollection::at

(

std::size_t

index

)

const

Returns the const object of given index.

begin() [1/2]

iterator edm4eic::SimPulseCollection::begin ( )

inline

begin() [2/2]

const_iterator edm4eic::SimPulseCollection::begin ( ) const

inline

cbegin()

const_iterator edm4eic::SimPulseCollection::cbegin ( ) const

inline

cellID()

std::vector< std::uint64_t > edm4eic::SimPulseCollection::cellID

(

const size_t

nElem = 0

)

const

cend()

const_iterator edm4eic::SimPulseCollection::cend ( ) const

inline

clear()

void edm4eic::SimPulseCollection::clear ( )

final

create() [1/2]

MutableSimPulse edm4eic::SimPulseCollection::create

(

)

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

create() [2/2]

template<typename... Args>

MutableSimPulse edm4eic::SimPulseCollection::create

(

Args &&...

args

)

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

empty()

bool edm4eic::SimPulseCollection::empty ( ) const

final

Is the collection empty.

end() [1/2]

iterator edm4eic::SimPulseCollection::end ( )

inline

end() [2/2]

const_iterator edm4eic::SimPulseCollection::end ( ) const

inline

getBuffers()

podio::CollectionWriteBuffers edm4eic::SimPulseCollection::getBuffers ( )

final

Get the collection buffers for this collection.

getDatamodelRegistryIndex()

size_t edm4eic::SimPulseCollection::getDatamodelRegistryIndex ( ) const

final

getDataTypeName()

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

inlinefinal

fully qualified type name of stored POD elements - with namespace

getID()

uint32_t edm4eic::SimPulseCollection::getID ( ) const

inlinefinal

getSchemaVersion()

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

final

schema version

getTypeName()

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

inlinefinal

fully qualified type name

getValueTypeName()

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

inlinefinal

fully qualified type name of elements - with namespace

integral()

std::vector< float > edm4eic::SimPulseCollection::integral

(

const size_t

nElem = 0

)

const

interval()

std::vector< float > edm4eic::SimPulseCollection::interval

(

const size_t

nElem = 0

)

const

isSubsetCollection()

bool edm4eic::SimPulseCollection::isSubsetCollection ( ) const

inlinefinal

isValid()

bool edm4eic::SimPulseCollection::isValid ( ) const

inlinefinal

max_size()

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

final

maximal number of elements in the collection

operator->()

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

inline

operator to allow pointer like calling of members a la LCIO

operator=() [1/2]

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

delete

operator=() [2/2]

SimPulseCollection & edm4eic::SimPulseCollection::operator= ( SimPulseCollection && )

default

operator[]() [1/2]

MutableSimPulse edm4eic::SimPulseCollection::operator[]

(

std::size_t

index

)

Returns the object of a given index.

operator[]() [2/2]

SimPulse edm4eic::SimPulseCollection::operator[]

(

std::size_t

index

)

const

Returns the const object of given index.

position()

std::vector< edm4hep::Vector3f > edm4eic::SimPulseCollection::position

(

const size_t

nElem = 0

)

const

prepareAfterRead()

void edm4eic::SimPulseCollection::prepareAfterRead ( )

final

prepareForWrite()

void edm4eic::SimPulseCollection::prepareForWrite ( ) const

final

print()

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

final

Print this collection to the passed stream.

push_back() [1/2]

void edm4eic::SimPulseCollection::push_back

(

const MutableSimPulse &

object

)

Append object to the collection.

push_back() [2/2]

void edm4eic::SimPulseCollection::push_back

(

const SimPulse &

object

)

Append an object to the (subset) collection.

setID()

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

inlinefinal

setReferences()

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

final

setSubsetCollection()

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

final

size()

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

final

number of elements in the collection

time()

std::vector< float > edm4eic::SimPulseCollection::time

(

const size_t

nElem = 0

)

const

Friends And Related Symbol Documentation

SimPulseCollectionData

friend class SimPulseCollectionData

friend

Member Data Documentation

dataTypeName

auto edm4eic::SimPulseCollection::dataTypeName = "edm4eic::SimPulseData"

staticconstexpr

typeName

auto edm4eic::SimPulseCollection::typeName = "edm4eic::SimPulseCollection"

staticconstexpr

valueTypeName

auto edm4eic::SimPulseCollection::valueTypeName = "edm4eic::SimPulse"

staticconstexpr

---

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

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