edm4eic::MutableProtoCluster Class Reference

#include <MutableProtoCluster.h>

Public Types
using	object_type = ProtoCluster
using	collection_type = ProtoClusterCollection

Public Member Functions
	MutableProtoCluster ()
	default constructor
	MutableProtoCluster (const MutableProtoCluster &other)=default
	copy constructor
MutableProtoCluster &	operator= (MutableProtoCluster other)
	copy-assignment operator
MutableProtoCluster	clone () const
	create a mutable deep-copy of the object with identical relations
	~MutableProtoCluster ()=default
	destructor
	operator ProtoCluster () const
	conversion to const object
void	addToHits (edm4eic::CalorimeterHit)
std::size_t	hits_size () const
edm4eic::CalorimeterHit	getHits (std::size_t) const
std::vector< edm4eic::CalorimeterHit >::const_iterator	hits_begin () const
std::vector< edm4eic::CalorimeterHit >::const_iterator	hits_end () const
podio::RelationRange< edm4eic::CalorimeterHit >	getHits () const
void	addToWeights (float)
std::size_t	weights_size () const
float	getWeights (std::size_t) const
std::vector< float >::const_iterator	weights_begin () const
std::vector< float >::const_iterator	weights_end () const
podio::RelationRange< float >	getWeights () const
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from ProtoClusterObj instance
bool	operator== (const MutableProtoCluster &other) const
bool	operator== (const ProtoCluster &other) const
bool	operator< (const MutableProtoCluster &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Friends
class	ProtoClusterCollection
class	ProtoClusterMutableCollectionIterator
class	ProtoCluster
void	swap (MutableProtoCluster &a, MutableProtoCluster &b)

Detailed Description

Collection of hits identified by the clustering algorithm to belong together

Author

: S. Joosten

Member Typedef Documentation

collection_type

using edm4eic::MutableProtoCluster::collection_type = ProtoClusterCollection

object_type

using edm4eic::MutableProtoCluster::object_type = ProtoCluster

Constructor & Destructor Documentation

MutableProtoCluster() [1/2]

edm4eic::MutableProtoCluster::MutableProtoCluster

(

)

default constructor

MutableProtoCluster() [2/2]

edm4eic::MutableProtoCluster::MutableProtoCluster ( const MutableProtoCluster & other )

default

copy constructor

~MutableProtoCluster()

edm4eic::MutableProtoCluster::~MutableProtoCluster ( )

default

destructor

Member Function Documentation

addToHits()

void edm4eic::MutableProtoCluster::addToHits

(

edm4eic::CalorimeterHit

component

)

addToWeights()

void edm4eic::MutableProtoCluster::addToWeights

(

float

component

)

clone()

MutableProtoCluster edm4eic::MutableProtoCluster::clone

(

)

const

create a mutable deep-copy of the object with identical relations

getHits() [1/2]

podio::RelationRange< edm4eic::CalorimeterHit > edm4eic::MutableProtoCluster::getHits

(

)

const

getHits() [2/2]

edm4eic::CalorimeterHit edm4eic::MutableProtoCluster::getHits

(

std::size_t

index

)

const

getObjectID()

const podio::ObjectID edm4eic::MutableProtoCluster::getObjectID

(

)

const

getWeights() [1/2]

podio::RelationRange< float > edm4eic::MutableProtoCluster::getWeights

(

)

const

getWeights() [2/2]

float edm4eic::MutableProtoCluster::getWeights

(

std::size_t

index

)

const

hits_begin()

std::vector< edm4eic::CalorimeterHit >::const_iterator edm4eic::MutableProtoCluster::hits_begin

(

)

const

hits_end()

std::vector< edm4eic::CalorimeterHit >::const_iterator edm4eic::MutableProtoCluster::hits_end

(

)

const

hits_size()

std::size_t edm4eic::MutableProtoCluster::hits_size

(

)

const

id()

podio::ObjectID edm4eic::MutableProtoCluster::id ( ) const

inline

isAvailable()

bool edm4eic::MutableProtoCluster::isAvailable

(

)

const

check whether the object is actually available

operator ProtoCluster()

edm4eic::MutableProtoCluster::operator ProtoCluster

(

)

const

conversion to const object

operator<()

bool edm4eic::MutableProtoCluster::operator< ( const MutableProtoCluster & other ) const

inline

operator=()

MutableProtoCluster & edm4eic::MutableProtoCluster::operator=

(

MutableProtoCluster

other

)

copy-assignment operator

operator==() [1/2]

bool edm4eic::MutableProtoCluster::operator== ( const MutableProtoCluster & other ) const

inline

operator==() [2/2]

bool edm4eic::MutableProtoCluster::operator==

(

const ProtoCluster &

other

)

const

unlink()

void edm4eic::MutableProtoCluster::unlink ( )

inline

disconnect from ProtoClusterObj instance

weights_begin()

std::vector< float >::const_iterator edm4eic::MutableProtoCluster::weights_begin

(

)

const

weights_end()

std::vector< float >::const_iterator edm4eic::MutableProtoCluster::weights_end

(

)

const

weights_size()

std::size_t edm4eic::MutableProtoCluster::weights_size

(

)

const

Friends And Related Symbol Documentation

ProtoCluster

friend class ProtoCluster

friend

ProtoClusterCollection

friend class ProtoClusterCollection

friend

ProtoClusterMutableCollectionIterator

friend class ProtoClusterMutableCollectionIterator

friend

swap

void swap ( MutableProtoCluster & a, MutableProtoCluster & b )

friend

---

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

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