edm4eic::ProtoCluster Class Reference

#include <ProtoCluster.h>

Public Types
using	mutable_type = MutableProtoCluster
using	collection_type = ProtoClusterCollection

Public Member Functions
	ProtoCluster ()
	default constructor
	ProtoCluster (const ProtoCluster &other)=default
	copy constructor
ProtoCluster &	operator= (ProtoCluster other) &
	copy-assignment operator
ProtoCluster &	operator= (ProtoCluster other) &&=delete
MutableProtoCluster	clone (bool cloneRelations=true) const
	~ProtoCluster ()=default
	destructor
	ProtoCluster (const MutableProtoCluster &other)
	converting constructor from mutable object
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
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 ProtoCluster &other) const
bool	operator== (const MutableProtoCluster &other) const
bool	operator!= (const ProtoCluster &other) const
bool	operator!= (const MutableProtoCluster &other) const
bool	operator< (const ProtoCluster &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static ProtoCluster	makeEmpty ()

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

Friends
class	MutableProtoCluster
class	ProtoClusterCollection
class	edm4eic::ProtoClusterCollectionData
class	ProtoClusterCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const ProtoCluster &obj)
void	swap (ProtoCluster &a, ProtoCluster &b)

Detailed Description

Collection of hits identified by the clustering algorithm to belong together

Author

: S. Joosten

Member Typedef Documentation

collection_type

using edm4eic::ProtoCluster::collection_type = ProtoClusterCollection

mutable_type

using edm4eic::ProtoCluster::mutable_type = MutableProtoCluster

Constructor & Destructor Documentation

ProtoCluster() [1/3]

edm4eic::ProtoCluster::ProtoCluster

(

)

default constructor

ProtoCluster() [2/3]

edm4eic::ProtoCluster::ProtoCluster ( const ProtoCluster & other )

default

copy constructor

~ProtoCluster()

edm4eic::ProtoCluster::~ProtoCluster ( )

default

destructor

ProtoCluster() [3/3]

edm4eic::ProtoCluster::ProtoCluster

(

const MutableProtoCluster &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutableProtoCluster edm4eic::ProtoCluster::clone

(

bool

cloneRelations = true

)

const

create a mutable deep-copy of the object with identical relations if cloneRelations=false, the relations are not cloned and will be empty

getHits() [1/2]

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

(

)

const

getHits() [2/2]

edm4eic::CalorimeterHit edm4eic::ProtoCluster::getHits

(

std::size_t

index

)

const

getObjectID()

const podio::ObjectID edm4eic::ProtoCluster::getObjectID

(

)

const

getWeights() [1/2]

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

(

)

const

getWeights() [2/2]

float edm4eic::ProtoCluster::getWeights

(

std::size_t

index

)

const

hits_begin()

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

(

)

const

hits_end()

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

(

)

const

hits_size()

std::size_t edm4eic::ProtoCluster::hits_size

(

)

const

id()

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

inline

isAvailable()

bool edm4eic::ProtoCluster::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

ProtoCluster edm4eic::ProtoCluster::makeEmpty ( )

static

operator!=() [1/2]

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

inline

operator!=() [2/2]

bool edm4eic::ProtoCluster::operator!= ( const ProtoCluster & other ) const

inline

operator<()

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

inline

operator=() [1/2]

ProtoCluster & edm4eic::ProtoCluster::operator=

(

ProtoCluster

other

)

&

copy-assignment operator

operator=() [2/2]

ProtoCluster & edm4eic::ProtoCluster::operator= ( ProtoCluster other ) &&

delete

operator==() [1/2]

bool edm4eic::ProtoCluster::operator==

(

const MutableProtoCluster &

other

)

const

operator==() [2/2]

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

inline

unlink()

void edm4eic::ProtoCluster::unlink ( )

inline

disconnect from ProtoClusterObj instance

weights_begin()

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

(

)

const

weights_end()

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

(

)

const

weights_size()

std::size_t edm4eic::ProtoCluster::weights_size

(

)

const

Friends And Related Symbol Documentation

edm4eic::ProtoClusterCollectionData

friend class edm4eic::ProtoClusterCollectionData

friend

MutableProtoCluster

friend class MutableProtoCluster

friend

podio::detail::getOrderKey

podio::detail::OrderKey podio::detail::getOrderKey ( const ProtoCluster & obj )

friend

ProtoClusterCollection

friend class ProtoClusterCollection

friend

ProtoClusterCollectionIterator

friend class ProtoClusterCollectionIterator

friend

swap

void swap ( ProtoCluster & a, ProtoCluster & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::ProtoCluster::typeName = "edm4eic::ProtoCluster"

staticconstexpr

---

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

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