EDM4eic
EIC data model
Loading...
Searching...
No Matches
edm4eic::IrtParticle Class Reference

#include <IrtParticle.h>

Public Types

using mutable_type = MutableIrtParticle
 
using collection_type = IrtParticleCollection
 

Public Member Functions

 IrtParticle ()=default
 default constructor
 
 IrtParticle (const std::int32_t PDG, const std::uint16_t npe, const std::uint16_t nhits)
 Constructor initializing all members.
 
 IrtParticle (const IrtParticle &other)=default
 copy constructor
 
IrtParticleoperator= (IrtParticle other) &
 copy-assignment operator
 
IrtParticleoperator= (IrtParticle other) &&=delete
 
MutableIrtParticle clone (bool cloneRelations=true) const
 
 ~IrtParticle ()=default
 destructor
 
 IrtParticle (const MutableIrtParticle &other)
 converting constructor from mutable object
 
std::int32_t getPDG () const
 Access the Reconstructed most probable PDG code.
 
std::uint16_t getNpe () const
 Access the Detected photoelectron count.
 
std::uint16_t getNhits () const
 Access the Hit count associated with this particle by IRT engine.
 
const edm4eic::Track getTrack () const
 Access the charged particle track.
 
std::size_t radiators_size () const
 
edm4eic::IrtRadiatorInfo getRadiators (std::size_t) const
 
std::vector< edm4eic::IrtRadiatorInfo >::const_iterator radiators_begin () const
 
std::vector< edm4eic::IrtRadiatorInfo >::const_iterator radiators_end () const
 
podio::RelationRange< edm4eic::IrtRadiatorInfogetRadiators () const
 
bool isAvailable () const
 check whether the object is actually available
 
void unlink ()
 disconnect from IrtParticleObj instance
 
bool operator== (const IrtParticle &other) const
 
bool operator== (const MutableIrtParticle &other) const
 
bool operator!= (const IrtParticle &other) const
 
bool operator!= (const MutableIrtParticle &other) const
 
bool operator< (const IrtParticle &other) const
 
podio::ObjectID id () const
 
const podio::ObjectID getObjectID () const
 

Static Public Member Functions

static IrtParticle makeEmpty ()
 

Static Public Attributes

static constexpr std::string_view typeName = "edm4eic::IrtParticle"
 

Friends

class MutableIrtParticle
 
class IrtParticleCollection
 
class edm4eic::IrtParticleCollectionData
 
class IrtParticleCollectionIterator
 
podio::detail::OrderKey podio::detail::getOrderKey (const IrtParticle &obj)
 
void swap (IrtParticle &a, IrtParticle &b)
 

Detailed Description

IRT 2.1 output (track level)

Author
: A. Kiselev

Member Typedef Documentation

◆ collection_type

◆ mutable_type

Constructor & Destructor Documentation

◆ IrtParticle() [1/4]

edm4eic::IrtParticle::IrtParticle ( )
default

default constructor

◆ IrtParticle() [2/4]

edm4eic::IrtParticle::IrtParticle ( const std::int32_t PDG,
const std::uint16_t npe,
const std::uint16_t nhits )

Constructor initializing all members.

◆ IrtParticle() [3/4]

edm4eic::IrtParticle::IrtParticle ( const IrtParticle & other)
default

copy constructor

◆ ~IrtParticle()

edm4eic::IrtParticle::~IrtParticle ( )
default

destructor

◆ IrtParticle() [4/4]

edm4eic::IrtParticle::IrtParticle ( const MutableIrtParticle & other)

converting constructor from mutable object

Member Function Documentation

◆ clone()

MutableIrtParticle edm4eic::IrtParticle::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

◆ getNhits()

std::uint16_t edm4eic::IrtParticle::getNhits ( ) const

Access the Hit count associated with this particle by IRT engine.

◆ getNpe()

std::uint16_t edm4eic::IrtParticle::getNpe ( ) const

Access the Detected photoelectron count.

◆ getObjectID()

const podio::ObjectID edm4eic::IrtParticle::getObjectID ( ) const

◆ getPDG()

std::int32_t edm4eic::IrtParticle::getPDG ( ) const

Access the Reconstructed most probable PDG code.

◆ getRadiators() [1/2]

podio::RelationRange< edm4eic::IrtRadiatorInfo > edm4eic::IrtParticle::getRadiators ( ) const

◆ getRadiators() [2/2]

edm4eic::IrtRadiatorInfo edm4eic::IrtParticle::getRadiators ( std::size_t index) const

◆ getTrack()

const edm4eic::Track edm4eic::IrtParticle::getTrack ( ) const

Access the charged particle track.

◆ id()

podio::ObjectID edm4eic::IrtParticle::id ( ) const
inline

◆ isAvailable()

bool edm4eic::IrtParticle::isAvailable ( ) const

check whether the object is actually available

◆ makeEmpty()

IrtParticle edm4eic::IrtParticle::makeEmpty ( )
static

◆ operator!=() [1/2]

bool edm4eic::IrtParticle::operator!= ( const IrtParticle & other) const
inline

◆ operator!=() [2/2]

bool edm4eic::IrtParticle::operator!= ( const MutableIrtParticle & other) const
inline

◆ operator<()

bool edm4eic::IrtParticle::operator< ( const IrtParticle & other) const
inline

◆ operator=() [1/2]

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

copy-assignment operator

◆ operator=() [2/2]

IrtParticle & edm4eic::IrtParticle::operator= ( IrtParticle other) &&
delete

◆ operator==() [1/2]

bool edm4eic::IrtParticle::operator== ( const IrtParticle & other) const
inline

◆ operator==() [2/2]

bool edm4eic::IrtParticle::operator== ( const MutableIrtParticle & other) const

◆ radiators_begin()

std::vector< edm4eic::IrtRadiatorInfo >::const_iterator edm4eic::IrtParticle::radiators_begin ( ) const

◆ radiators_end()

std::vector< edm4eic::IrtRadiatorInfo >::const_iterator edm4eic::IrtParticle::radiators_end ( ) const

◆ radiators_size()

std::size_t edm4eic::IrtParticle::radiators_size ( ) const

◆ unlink()

void edm4eic::IrtParticle::unlink ( )
inline

disconnect from IrtParticleObj instance

Friends And Related Symbol Documentation

◆ edm4eic::IrtParticleCollectionData

◆ IrtParticleCollection

friend class IrtParticleCollection
friend

◆ IrtParticleCollectionIterator

friend class IrtParticleCollectionIterator
friend

◆ MutableIrtParticle

friend class MutableIrtParticle
friend

◆ podio::detail::getOrderKey

podio::detail::OrderKey podio::detail::getOrderKey ( const IrtParticle & obj)
friend

◆ swap

void swap ( IrtParticle & a,
IrtParticle & b )
friend

Member Data Documentation

◆ typeName

std::string_view edm4eic::IrtParticle::typeName = "edm4eic::IrtParticle"
staticconstexpr

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