edm4eic::MCRecoVertexParticleAssociation Class Reference

#include <MCRecoVertexParticleAssociation.h>

Public Types
using	mutable_type = MutableMCRecoVertexParticleAssociation
using	collection_type = MCRecoVertexParticleAssociationCollection

Public Member Functions
	MCRecoVertexParticleAssociation ()
	default constructor
	MCRecoVertexParticleAssociation (const std::uint32_t simID, const std::uint32_t recID, const float weight)
	Constructor initializing all members.
	MCRecoVertexParticleAssociation (const MCRecoVertexParticleAssociation &other)=default
	copy constructor
MCRecoVertexParticleAssociation &	operator= (MCRecoVertexParticleAssociation other) &
	copy-assignment operator
MCRecoVertexParticleAssociation &	operator= (MCRecoVertexParticleAssociation other) &&=delete
MutableMCRecoVertexParticleAssociation	clone (bool cloneRelations=true) const
	~MCRecoVertexParticleAssociation ()=default
	destructor
	MCRecoVertexParticleAssociation (const MutableMCRecoVertexParticleAssociation &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 Vertex (position in Vertices array)
float	getWeight () const
	Access the weight of this association.
const edm4eic::Vertex	getRec () const
	Access the reference to the vertex.
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 MCRecoVertexParticleAssociationObj instance
bool	operator== (const MCRecoVertexParticleAssociation &other) const
bool	operator== (const MutableMCRecoVertexParticleAssociation &other) const
bool	operator!= (const MCRecoVertexParticleAssociation &other) const
bool	operator!= (const MutableMCRecoVertexParticleAssociation &other) const
bool	operator< (const MCRecoVertexParticleAssociation &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static MCRecoVertexParticleAssociation	makeEmpty ()

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

Friends
class	MutableMCRecoVertexParticleAssociation
class	MCRecoVertexParticleAssociationCollection
class	edm4eic::MCRecoVertexParticleAssociationCollectionData
class	MCRecoVertexParticleAssociationCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const MCRecoVertexParticleAssociation &obj)
void	swap (MCRecoVertexParticleAssociation &a, MCRecoVertexParticleAssociation &b)

Detailed Description

Association between a Vertex and a MCParticle

Author

: S. Joosten

Member Typedef Documentation

collection_type

using edm4eic::MCRecoVertexParticleAssociation::collection_type = MCRecoVertexParticleAssociationCollection

mutable_type

using edm4eic::MCRecoVertexParticleAssociation::mutable_type = MutableMCRecoVertexParticleAssociation

Constructor & Destructor Documentation

MCRecoVertexParticleAssociation() [1/4]

edm4eic::MCRecoVertexParticleAssociation::MCRecoVertexParticleAssociation

(

)

default constructor

MCRecoVertexParticleAssociation() [2/4]

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

Constructor initializing all members.

MCRecoVertexParticleAssociation() [3/4]

edm4eic::MCRecoVertexParticleAssociation::MCRecoVertexParticleAssociation ( const MCRecoVertexParticleAssociation & other )

default

copy constructor

~MCRecoVertexParticleAssociation()

edm4eic::MCRecoVertexParticleAssociation::~MCRecoVertexParticleAssociation ( )

default

destructor

MCRecoVertexParticleAssociation() [4/4]

edm4eic::MCRecoVertexParticleAssociation::MCRecoVertexParticleAssociation

(

const MutableMCRecoVertexParticleAssociation &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutableMCRecoVertexParticleAssociation edm4eic::MCRecoVertexParticleAssociation::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::MCRecoVertexParticleAssociation::getObjectID

(

)

const

getRec()

const edm4eic::Vertex edm4eic::MCRecoVertexParticleAssociation::getRec

(

)

const

Access the reference to the vertex.

getRecID()

std::uint32_t edm4eic::MCRecoVertexParticleAssociation::getRecID

(

)

const

Access the Index of corresponding Vertex (position in Vertices array)

getSim()

const edm4hep::MCParticle edm4eic::MCRecoVertexParticleAssociation::getSim

(

)

const

Access the reference to the Monte-Carlo particle.

getSimID()

std::uint32_t edm4eic::MCRecoVertexParticleAssociation::getSimID

(

)

const

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

getWeight()

float edm4eic::MCRecoVertexParticleAssociation::getWeight

(

)

const

Access the weight of this association.

id()

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

inline

isAvailable()

bool edm4eic::MCRecoVertexParticleAssociation::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

MCRecoVertexParticleAssociation edm4eic::MCRecoVertexParticleAssociation::makeEmpty ( )

static

operator!=() [1/2]

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

inline

operator!=() [2/2]

bool edm4eic::MCRecoVertexParticleAssociation::operator!= ( const MutableMCRecoVertexParticleAssociation & other ) const

inline

operator<()

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

inline

operator=() [1/2]

MCRecoVertexParticleAssociation & edm4eic::MCRecoVertexParticleAssociation::operator=

(

MCRecoVertexParticleAssociation

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::MCRecoVertexParticleAssociation::operator==

(

const MutableMCRecoVertexParticleAssociation &

other

)

const

unlink()

void edm4eic::MCRecoVertexParticleAssociation::unlink ( )

inline

disconnect from MCRecoVertexParticleAssociationObj instance

Friends And Related Symbol Documentation

edm4eic::MCRecoVertexParticleAssociationCollectionData

friend class edm4eic::MCRecoVertexParticleAssociationCollectionData

friend

MCRecoVertexParticleAssociationCollection

friend class MCRecoVertexParticleAssociationCollection

friend

MCRecoVertexParticleAssociationCollectionIterator

friend class MCRecoVertexParticleAssociationCollectionIterator

friend

MutableMCRecoVertexParticleAssociation

friend class MutableMCRecoVertexParticleAssociation

friend

podio::detail::getOrderKey

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

friend

swap

void swap ( MCRecoVertexParticleAssociation & a, MCRecoVertexParticleAssociation & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::MCRecoVertexParticleAssociation::typeName = "edm4eic::MCRecoVertexParticleAssociation"

staticconstexpr

---

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

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