edm4eic::MCRecoClusterParticleAssociation Class Reference

#include <MCRecoClusterParticleAssociation.h>

Public Types
using	mutable_type = MutableMCRecoClusterParticleAssociation
using	collection_type = MCRecoClusterParticleAssociationCollection

Public Member Functions
	MCRecoClusterParticleAssociation ()
	default constructor
	MCRecoClusterParticleAssociation (const std::uint32_t simID, const std::uint32_t recID, const float weight)
	Constructor initializing all members.
	MCRecoClusterParticleAssociation (const MCRecoClusterParticleAssociation &other)=default
	copy constructor
MCRecoClusterParticleAssociation &	operator= (MCRecoClusterParticleAssociation other) &
	copy-assignment operator
MCRecoClusterParticleAssociation &	operator= (MCRecoClusterParticleAssociation other) &&=delete
MutableMCRecoClusterParticleAssociation	clone (bool cloneRelations=true) const
	~MCRecoClusterParticleAssociation ()=default
	destructor
	MCRecoClusterParticleAssociation (const MutableMCRecoClusterParticleAssociation &other)
	converting constructor from mutable object
std::uint32_t	getSimID () const
	Access the Index of corresponding MCParticle (position in MCParticles array)
std::uint32_t	getRecID () const
	Access the Index of corresponding Cluster (position in Clusters array)
float	getWeight () const
	Access the weight of this association.
const edm4eic::Cluster	getRec () const
	Access the reference to the cluster.
const edm4hep::MCParticle	getSim () const
	Access the reference to the Monte-Carlo particle.
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from MCRecoClusterParticleAssociationObj instance
bool	operator== (const MCRecoClusterParticleAssociation &other) const
bool	operator== (const MutableMCRecoClusterParticleAssociation &other) const
bool	operator!= (const MCRecoClusterParticleAssociation &other) const
bool	operator!= (const MutableMCRecoClusterParticleAssociation &other) const
bool	operator< (const MCRecoClusterParticleAssociation &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static MCRecoClusterParticleAssociation	makeEmpty ()

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

Friends
class	MutableMCRecoClusterParticleAssociation
class	MCRecoClusterParticleAssociationCollection
class	edm4eic::MCRecoClusterParticleAssociationCollectionData
class	MCRecoClusterParticleAssociationCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const MCRecoClusterParticleAssociation &obj)
void	swap (MCRecoClusterParticleAssociation &a, MCRecoClusterParticleAssociation &b)

Detailed Description

Association between a Cluster and a MCParticle

Author

: S. Joosten

Member Typedef Documentation

collection_type

using edm4eic::MCRecoClusterParticleAssociation::collection_type = MCRecoClusterParticleAssociationCollection

mutable_type

using edm4eic::MCRecoClusterParticleAssociation::mutable_type = MutableMCRecoClusterParticleAssociation

Constructor & Destructor Documentation

MCRecoClusterParticleAssociation() [1/4]

edm4eic::MCRecoClusterParticleAssociation::MCRecoClusterParticleAssociation

(

)

default constructor

MCRecoClusterParticleAssociation() [2/4]

edm4eic::MCRecoClusterParticleAssociation::MCRecoClusterParticleAssociation	(	const std::uint32_t	simID,
		const std::uint32_t	recID,
		const float	weight )

Constructor initializing all members.

MCRecoClusterParticleAssociation() [3/4]

edm4eic::MCRecoClusterParticleAssociation::MCRecoClusterParticleAssociation ( const MCRecoClusterParticleAssociation & other )

default

copy constructor

~MCRecoClusterParticleAssociation()

edm4eic::MCRecoClusterParticleAssociation::~MCRecoClusterParticleAssociation ( )

default

destructor

MCRecoClusterParticleAssociation() [4/4]

edm4eic::MCRecoClusterParticleAssociation::MCRecoClusterParticleAssociation

(

const MutableMCRecoClusterParticleAssociation &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutableMCRecoClusterParticleAssociation edm4eic::MCRecoClusterParticleAssociation::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

getObjectID()

const podio::ObjectID edm4eic::MCRecoClusterParticleAssociation::getObjectID

(

)

const

getRec()

const edm4eic::Cluster edm4eic::MCRecoClusterParticleAssociation::getRec

(

)

const

Access the reference to the cluster.

getRecID()

std::uint32_t edm4eic::MCRecoClusterParticleAssociation::getRecID

(

)

const

Access the Index of corresponding Cluster (position in Clusters array)

getSim()

const edm4hep::MCParticle edm4eic::MCRecoClusterParticleAssociation::getSim

(

)

const

Access the reference to the Monte-Carlo particle.

getSimID()

std::uint32_t edm4eic::MCRecoClusterParticleAssociation::getSimID

(

)

const

Access the Index of corresponding MCParticle (position in MCParticles array)

getWeight()

float edm4eic::MCRecoClusterParticleAssociation::getWeight

(

)

const

Access the weight of this association.

id()

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

inline

isAvailable()

bool edm4eic::MCRecoClusterParticleAssociation::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

MCRecoClusterParticleAssociation edm4eic::MCRecoClusterParticleAssociation::makeEmpty ( )

static

operator!=() [1/2]

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

inline

operator!=() [2/2]

bool edm4eic::MCRecoClusterParticleAssociation::operator!= ( const MutableMCRecoClusterParticleAssociation & other ) const

inline

operator<()

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

inline

operator=() [1/2]

MCRecoClusterParticleAssociation & edm4eic::MCRecoClusterParticleAssociation::operator=

(

MCRecoClusterParticleAssociation

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::MCRecoClusterParticleAssociation::operator==

(

const MutableMCRecoClusterParticleAssociation &

other

)

const

unlink()

void edm4eic::MCRecoClusterParticleAssociation::unlink ( )

inline

disconnect from MCRecoClusterParticleAssociationObj instance

Friends And Related Symbol Documentation

edm4eic::MCRecoClusterParticleAssociationCollectionData

friend class edm4eic::MCRecoClusterParticleAssociationCollectionData

friend

MCRecoClusterParticleAssociationCollection

friend class MCRecoClusterParticleAssociationCollection

friend

MCRecoClusterParticleAssociationCollectionIterator

friend class MCRecoClusterParticleAssociationCollectionIterator

friend

MutableMCRecoClusterParticleAssociation

friend class MutableMCRecoClusterParticleAssociation

friend

podio::detail::getOrderKey

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

friend

swap

void swap ( MCRecoClusterParticleAssociation & a, MCRecoClusterParticleAssociation & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::MCRecoClusterParticleAssociation::typeName = "edm4eic::MCRecoClusterParticleAssociation"

staticconstexpr

---

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

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