dd4pod::Geant4Particle Class Reference

#include <Geant4Particle.h>

Public Member Functions

 Geant4Particle ()
 default constructor More...
 
 Geant4Particle (int ID, int g4Parent, int reason, int mask, int steps, int secondaries, int pdgID, int status, std::array< int, 2 > colorFlow, int genStatus, int charge, std::array< int, 1 > spare, std::array< float, 3 > spin, double vsx, double vsy, double vsz, double vex, double vey, double vez, double psx, double psy, double psz, double pex, double pey, double pez, double mass, double time, double properTime)
 
 Geant4Particle (Geant4ParticleObj *obj)
 constructor from existing Geant4ParticleObj More...
 
 Geant4Particle (const Geant4Particle &other)
 copy constructor More...
 
Geant4Particleoperator= (const Geant4Particle &other)
 copy-assignment operator More...
 
Geant4Particle clone () const
 support cloning (deep-copy) More...
 
 ~Geant4Particle ()
 destructor More...
 
 operator ConstGeant4Particle () const
 conversion to const object More...
 
const int & ID () const
 Access the x. More...
 
const int & g4Parent () const
 Access the x. More...
 
const int & reason () const
 Access the x. More...
 
const int & mask () const
 Access the x. More...
 
const int & steps () const
 Access the x. More...
 
const int & secondaries () const
 Access the x. More...
 
const int & pdgID () const
 Access the x. More...
 
const int & status () const
 Access the x. More...
 
const std::array< int, 2 > & colorFlow () const
 Access the x. More...
 
const int & colorFlow (size_t i) const
 Access item i of the x. More...
 
const int & genStatus () const
 Access the x. More...
 
const int & charge () const
 Access the x. More...
 
const std::array< int, 1 > & spare () const
 Access the x. More...
 
const int & spare (size_t i) const
 Access item i of the x. More...
 
const std::array< float, 3 > & spin () const
 Access the x. More...
 
const float & spin (size_t i) const
 Access item i of the x. More...
 
const double & vsx () const
 Access the startpoint x. More...
 
const double & vsy () const
 Access the startpoint x. More...
 
const double & vsz () const
 Access the startpoint x. More...
 
const double & vex () const
 Access the endpoint x. More...
 
const double & vey () const
 Access the endpoint x. More...
 
const double & vez () const
 Access the endpoint x. More...
 
const double & psx () const
 Access the startpoint x. More...
 
const double & psy () const
 Access the startpoint py. More...
 
const double & psz () const
 Access the startpoint pz. More...
 
const double & pex () const
 Access the endpoint x. More...
 
const double & pey () const
 Access the endpoint x. More...
 
const double & pez () const
 Access the endpoint pz. More...
 
const double & mass () const
 Access the x. More...
 
const double & time () const
 Access the x. More...
 
const double & properTime () const
 Access the x. More...
 
void ID (int value)
 Set the x. More...
 
void g4Parent (int value)
 Set the x. More...
 
void reason (int value)
 Set the x. More...
 
void mask (int value)
 Set the x. More...
 
void steps (int value)
 Set the x. More...
 
void secondaries (int value)
 Set the x. More...
 
void pdgID (int value)
 Set the x. More...
 
void status (int value)
 Set the x. More...
 
void colorFlow (std::array< int, 2 > value)
 Set the x. More...
 
void colorFlow (size_t i, int value)
 
std::array< int, 2 > & colorFlow ()
 Get reference to x. More...
 
void genStatus (int value)
 Set the x. More...
 
void charge (int value)
 Set the x. More...
 
void spare (std::array< int, 1 > value)
 Set the x. More...
 
void spare (size_t i, int value)
 
std::array< int, 1 > & spare ()
 Get reference to x. More...
 
void spin (std::array< float, 3 > value)
 Set the x. More...
 
void spin (size_t i, float value)
 
std::array< float, 3 > & spin ()
 Get reference to x. More...
 
void vsx (double value)
 Set the startpoint x. More...
 
void vsy (double value)
 Set the startpoint x. More...
 
void vsz (double value)
 Set the startpoint x. More...
 
void vex (double value)
 Set the endpoint x. More...
 
void vey (double value)
 Set the endpoint x. More...
 
void vez (double value)
 Set the endpoint x. More...
 
void psx (double value)
 Set the startpoint x. More...
 
void psy (double value)
 Set the startpoint py. More...
 
void psz (double value)
 Set the startpoint pz. More...
 
void pex (double value)
 Set the endpoint x. More...
 
void pey (double value)
 Set the endpoint x. More...
 
void pez (double value)
 Set the endpoint pz. More...
 
void mass (double value)
 Set the x. More...
 
void time (double value)
 Set the x. More...
 
void properTime (double value)
 Set the x. More...
 
void addparents (int)
 
unsigned int parents_size () const
 
int parents (unsigned int) const
 
std::vector< int >::const_iterator parents_begin () const
 
std::vector< int >::const_iterator parents_end () const
 
podio::RelationRange< int > parents () const
 
void adddaughters (int)
 
unsigned int daughters_size () const
 
int daughters (unsigned int) const
 
std::vector< int >::const_iterator daughters_begin () const
 
std::vector< int >::const_iterator daughters_end () const
 
podio::RelationRange< int > daughters () const
 
double Px () const
 
double Py () const
 
double Pz () const
 
double Px2 () const
 
double Py2 () const
 
double Pz2 () const
 
bool isAvailable () const
 check whether the object is actually available More...
 
void unlink ()
 disconnect from Geant4ParticleObj instance More...
 
bool operator== (const Geant4Particle &other) const
 
bool operator== (const ConstGeant4Particle &other) const
 
bool operator< (const Geant4Particle &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Detailed Description

Podio implementation of dd4hep's dd4hep::sim::Geant4Particle class

Author
: W.Armstrong

Definition at line 27 of file Geant4Particle.h.

Constructor & Destructor Documentation

◆ Geant4Particle() [1/4]

dd4pod::Geant4Particle::Geant4Particle ( )

default constructor

Definition at line 16 of file Geant4Particle.cc.

◆ Geant4Particle() [2/4]

dd4pod::Geant4Particle::Geant4Particle ( int  ID,
int  g4Parent,
int  reason,
int  mask,
int  steps,
int  secondaries,
int  pdgID,
int  status,
std::array< int, 2 >  colorFlow,
int  genStatus,
int  charge,
std::array< int, 1 >  spare,
std::array< float, 3 >  spin,
double  vsx,
double  vsy,
double  vsz,
double  vex,
double  vey,
double  vez,
double  psx,
double  psy,
double  psz,
double  pex,
double  pey,
double  pez,
double  mass,
double  time,
double  properTime 
)

Definition at line 20 of file Geant4Particle.cc.

◆ Geant4Particle() [3/4]

dd4pod::Geant4Particle::Geant4Particle ( Geant4ParticleObj obj)

constructor from existing Geant4ParticleObj

Definition at line 62 of file Geant4Particle.cc.

◆ Geant4Particle() [4/4]

dd4pod::Geant4Particle::Geant4Particle ( const Geant4Particle other)

copy constructor

Definition at line 52 of file Geant4Particle.cc.

◆ ~Geant4Particle()

dd4pod::Geant4Particle::~Geant4Particle ( )

destructor

Definition at line 70 of file Geant4Particle.cc.

Member Function Documentation

◆ adddaughters()

void dd4pod::Geant4Particle::adddaughters ( int  component)

Definition at line 180 of file Geant4Particle.cc.

◆ addparents()

void dd4pod::Geant4Particle::addparents ( int  component)

Definition at line 144 of file Geant4Particle.cc.

◆ charge() [1/2]

const int & dd4pod::Geant4Particle::charge ( ) const

Access the x.

Definition at line 86 of file Geant4Particle.cc.

◆ charge() [2/2]

void dd4pod::Geant4Particle::charge ( int  value)

Set the x.

Definition at line 120 of file Geant4Particle.cc.

◆ clone()

Geant4Particle dd4pod::Geant4Particle::clone ( ) const

support cloning (deep-copy)

Definition at line 66 of file Geant4Particle.cc.

◆ colorFlow() [1/5]

std::array< int, 2 > & dd4pod::Geant4Particle::colorFlow ( )

Get reference to x.

Definition at line 118 of file Geant4Particle.cc.

◆ colorFlow() [2/5]

const std::array< int, 2 > & dd4pod::Geant4Particle::colorFlow ( ) const

Access the x.

Definition at line 83 of file Geant4Particle.cc.

◆ colorFlow() [3/5]

const int & dd4pod::Geant4Particle::colorFlow ( size_t  i) const

Access item i of the x.

Definition at line 84 of file Geant4Particle.cc.

◆ colorFlow() [4/5]

void dd4pod::Geant4Particle::colorFlow ( size_t  i,
int  value 
)

Definition at line 117 of file Geant4Particle.cc.

◆ colorFlow() [5/5]

void dd4pod::Geant4Particle::colorFlow ( std::array< int, 2 >  value)

Set the x.

Definition at line 116 of file Geant4Particle.cc.

◆ daughters() [1/2]

podio::RelationRange< int > dd4pod::Geant4Particle::daughters ( ) const

Definition at line 208 of file Geant4Particle.cc.

◆ daughters() [2/2]

int dd4pod::Geant4Particle::daughters ( unsigned int  index) const

Definition at line 201 of file Geant4Particle.cc.

◆ daughters_begin()

std::vector< int >::const_iterator dd4pod::Geant4Particle::daughters_begin ( ) const

Definition at line 185 of file Geant4Particle.cc.

◆ daughters_end()

std::vector< int >::const_iterator dd4pod::Geant4Particle::daughters_end ( ) const

Definition at line 191 of file Geant4Particle.cc.

◆ daughters_size()

unsigned int dd4pod::Geant4Particle::daughters_size ( ) const

Definition at line 197 of file Geant4Particle.cc.

◆ g4Parent() [1/2]

const int & dd4pod::Geant4Particle::g4Parent ( ) const

Access the x.

Definition at line 76 of file Geant4Particle.cc.

◆ g4Parent() [2/2]

void dd4pod::Geant4Particle::g4Parent ( int  value)

Set the x.

Definition at line 109 of file Geant4Particle.cc.

◆ genStatus() [1/2]

const int & dd4pod::Geant4Particle::genStatus ( ) const

Access the x.

Definition at line 85 of file Geant4Particle.cc.

◆ genStatus() [2/2]

void dd4pod::Geant4Particle::genStatus ( int  value)

Set the x.

Definition at line 119 of file Geant4Particle.cc.

◆ getObjectID()

const podio::ObjectID dd4pod::Geant4Particle::getObjectID ( ) const

Definition at line 228 of file Geant4Particle.cc.

◆ ID() [1/2]

const int & dd4pod::Geant4Particle::ID ( ) const

Access the x.

Definition at line 75 of file Geant4Particle.cc.

◆ id()

unsigned int dd4pod::Geant4Particle::id ( ) const
inline

Definition at line 278 of file Geant4Particle.h.

◆ ID() [2/2]

void dd4pod::Geant4Particle::ID ( int  value)

Set the x.

Definition at line 108 of file Geant4Particle.cc.

◆ isAvailable()

bool dd4pod::Geant4Particle::isAvailable ( ) const

check whether the object is actually available

Definition at line 221 of file Geant4Particle.cc.

◆ mask() [1/2]

const int & dd4pod::Geant4Particle::mask ( ) const

Access the x.

Definition at line 78 of file Geant4Particle.cc.

◆ mask() [2/2]

void dd4pod::Geant4Particle::mask ( int  value)

Set the x.

Definition at line 111 of file Geant4Particle.cc.

◆ mass() [1/2]

const double & dd4pod::Geant4Particle::mass ( ) const

Access the x.

Definition at line 103 of file Geant4Particle.cc.

◆ mass() [2/2]

void dd4pod::Geant4Particle::mass ( double  value)

Set the x.

Definition at line 139 of file Geant4Particle.cc.

◆ operator ConstGeant4Particle()

dd4pod::Geant4Particle::operator ConstGeant4Particle ( ) const

conversion to const object

Definition at line 73 of file Geant4Particle.cc.

◆ operator<()

bool dd4pod::Geant4Particle::operator< ( const Geant4Particle other) const
inline

Definition at line 276 of file Geant4Particle.h.

◆ operator=()

Geant4Particle & dd4pod::Geant4Particle::operator= ( const Geant4Particle other)

copy-assignment operator

Definition at line 56 of file Geant4Particle.cc.

◆ operator==() [1/2]

bool dd4pod::Geant4Particle::operator== ( const ConstGeant4Particle other) const

Definition at line 235 of file Geant4Particle.cc.

◆ operator==() [2/2]

bool dd4pod::Geant4Particle::operator== ( const Geant4Particle other) const
inline

Definition at line 272 of file Geant4Particle.h.

◆ parents() [1/2]

podio::RelationRange< int > dd4pod::Geant4Particle::parents ( ) const

Definition at line 172 of file Geant4Particle.cc.

◆ parents() [2/2]

int dd4pod::Geant4Particle::parents ( unsigned int  index) const

Definition at line 165 of file Geant4Particle.cc.

◆ parents_begin()

std::vector< int >::const_iterator dd4pod::Geant4Particle::parents_begin ( ) const

Definition at line 149 of file Geant4Particle.cc.

◆ parents_end()

std::vector< int >::const_iterator dd4pod::Geant4Particle::parents_end ( ) const

Definition at line 155 of file Geant4Particle.cc.

◆ parents_size()

unsigned int dd4pod::Geant4Particle::parents_size ( ) const

Definition at line 161 of file Geant4Particle.cc.

◆ pdgID() [1/2]

const int & dd4pod::Geant4Particle::pdgID ( ) const

Access the x.

Definition at line 81 of file Geant4Particle.cc.

◆ pdgID() [2/2]

void dd4pod::Geant4Particle::pdgID ( int  value)

Set the x.

Definition at line 114 of file Geant4Particle.cc.

◆ pex() [1/2]

const double & dd4pod::Geant4Particle::pex ( ) const

Access the endpoint x.

Definition at line 100 of file Geant4Particle.cc.

◆ pex() [2/2]

void dd4pod::Geant4Particle::pex ( double  value)

Set the endpoint x.

Definition at line 136 of file Geant4Particle.cc.

◆ pey() [1/2]

const double & dd4pod::Geant4Particle::pey ( ) const

Access the endpoint x.

Definition at line 101 of file Geant4Particle.cc.

◆ pey() [2/2]

void dd4pod::Geant4Particle::pey ( double  value)

Set the endpoint x.

Definition at line 137 of file Geant4Particle.cc.

◆ pez() [1/2]

const double & dd4pod::Geant4Particle::pez ( ) const

Access the endpoint pz.

Definition at line 102 of file Geant4Particle.cc.

◆ pez() [2/2]

void dd4pod::Geant4Particle::pez ( double  value)

Set the endpoint pz.

Definition at line 138 of file Geant4Particle.cc.

◆ properTime() [1/2]

const double & dd4pod::Geant4Particle::properTime ( ) const

Access the x.

Definition at line 105 of file Geant4Particle.cc.

◆ properTime() [2/2]

void dd4pod::Geant4Particle::properTime ( double  value)

Set the x.

Definition at line 141 of file Geant4Particle.cc.

◆ psx() [1/2]

const double & dd4pod::Geant4Particle::psx ( ) const

Access the startpoint x.

Definition at line 97 of file Geant4Particle.cc.

◆ psx() [2/2]

void dd4pod::Geant4Particle::psx ( double  value)

Set the startpoint x.

Definition at line 133 of file Geant4Particle.cc.

◆ psy() [1/2]

const double & dd4pod::Geant4Particle::psy ( ) const

Access the startpoint py.

Definition at line 98 of file Geant4Particle.cc.

◆ psy() [2/2]

void dd4pod::Geant4Particle::psy ( double  value)

Set the startpoint py.

Definition at line 134 of file Geant4Particle.cc.

◆ psz() [1/2]

const double & dd4pod::Geant4Particle::psz ( ) const

Access the startpoint pz.

Definition at line 99 of file Geant4Particle.cc.

◆ psz() [2/2]

void dd4pod::Geant4Particle::psz ( double  value)

Set the startpoint pz.

Definition at line 135 of file Geant4Particle.cc.

◆ Px()

double dd4pod::Geant4Particle::Px ( ) const
inline

Definition at line 256 of file Geant4Particle.h.

◆ Px2()

double dd4pod::Geant4Particle::Px2 ( ) const
inline

Definition at line 259 of file Geant4Particle.h.

◆ Py()

double dd4pod::Geant4Particle::Py ( ) const
inline

Definition at line 257 of file Geant4Particle.h.

◆ Py2()

double dd4pod::Geant4Particle::Py2 ( ) const
inline

Definition at line 260 of file Geant4Particle.h.

◆ Pz()

double dd4pod::Geant4Particle::Pz ( ) const
inline

Definition at line 258 of file Geant4Particle.h.

◆ Pz2()

double dd4pod::Geant4Particle::Pz2 ( ) const
inline

Definition at line 261 of file Geant4Particle.h.

◆ reason() [1/2]

const int & dd4pod::Geant4Particle::reason ( ) const

Access the x.

Definition at line 77 of file Geant4Particle.cc.

◆ reason() [2/2]

void dd4pod::Geant4Particle::reason ( int  value)

Set the x.

Definition at line 110 of file Geant4Particle.cc.

◆ secondaries() [1/2]

const int & dd4pod::Geant4Particle::secondaries ( ) const

Access the x.

Definition at line 80 of file Geant4Particle.cc.

◆ secondaries() [2/2]

void dd4pod::Geant4Particle::secondaries ( int  value)

Set the x.

Definition at line 113 of file Geant4Particle.cc.

◆ spare() [1/5]

std::array< int, 1 > & dd4pod::Geant4Particle::spare ( )

Get reference to x.

Definition at line 123 of file Geant4Particle.cc.

◆ spare() [2/5]

const std::array< int, 1 > & dd4pod::Geant4Particle::spare ( ) const

Access the x.

Definition at line 87 of file Geant4Particle.cc.

◆ spare() [3/5]

const int & dd4pod::Geant4Particle::spare ( size_t  i) const

Access item i of the x.

Definition at line 88 of file Geant4Particle.cc.

◆ spare() [4/5]

void dd4pod::Geant4Particle::spare ( size_t  i,
int  value 
)

Definition at line 122 of file Geant4Particle.cc.

◆ spare() [5/5]

void dd4pod::Geant4Particle::spare ( std::array< int, 1 >  value)

Set the x.

Definition at line 121 of file Geant4Particle.cc.

◆ spin() [1/5]

std::array< float, 3 > & dd4pod::Geant4Particle::spin ( )

Get reference to x.

Definition at line 126 of file Geant4Particle.cc.

◆ spin() [2/5]

const std::array< float, 3 > & dd4pod::Geant4Particle::spin ( ) const

Access the x.

Definition at line 89 of file Geant4Particle.cc.

◆ spin() [3/5]

const float & dd4pod::Geant4Particle::spin ( size_t  i) const

Access item i of the x.

Definition at line 90 of file Geant4Particle.cc.

◆ spin() [4/5]

void dd4pod::Geant4Particle::spin ( size_t  i,
float  value 
)

Definition at line 125 of file Geant4Particle.cc.

◆ spin() [5/5]

void dd4pod::Geant4Particle::spin ( std::array< float, 3 >  value)

Set the x.

Definition at line 124 of file Geant4Particle.cc.

◆ status() [1/2]

const int & dd4pod::Geant4Particle::status ( ) const

Access the x.

Definition at line 82 of file Geant4Particle.cc.

◆ status() [2/2]

void dd4pod::Geant4Particle::status ( int  value)

Set the x.

Definition at line 115 of file Geant4Particle.cc.

◆ steps() [1/2]

const int & dd4pod::Geant4Particle::steps ( ) const

Access the x.

Definition at line 79 of file Geant4Particle.cc.

◆ steps() [2/2]

void dd4pod::Geant4Particle::steps ( int  value)

Set the x.

Definition at line 112 of file Geant4Particle.cc.

◆ time() [1/2]

const double & dd4pod::Geant4Particle::time ( ) const

Access the x.

Definition at line 104 of file Geant4Particle.cc.

◆ time() [2/2]

void dd4pod::Geant4Particle::time ( double  value)

Set the x.

Definition at line 140 of file Geant4Particle.cc.

◆ unlink()

void dd4pod::Geant4Particle::unlink ( )
inline

disconnect from Geant4ParticleObj instance

Definition at line 270 of file Geant4Particle.h.

◆ vex() [1/2]

const double & dd4pod::Geant4Particle::vex ( ) const

Access the endpoint x.

Definition at line 94 of file Geant4Particle.cc.

◆ vex() [2/2]

void dd4pod::Geant4Particle::vex ( double  value)

Set the endpoint x.

Definition at line 130 of file Geant4Particle.cc.

◆ vey() [1/2]

const double & dd4pod::Geant4Particle::vey ( ) const

Access the endpoint x.

Definition at line 95 of file Geant4Particle.cc.

◆ vey() [2/2]

void dd4pod::Geant4Particle::vey ( double  value)

Set the endpoint x.

Definition at line 131 of file Geant4Particle.cc.

◆ vez() [1/2]

const double & dd4pod::Geant4Particle::vez ( ) const

Access the endpoint x.

Definition at line 96 of file Geant4Particle.cc.

◆ vez() [2/2]

void dd4pod::Geant4Particle::vez ( double  value)

Set the endpoint x.

Definition at line 132 of file Geant4Particle.cc.

◆ vsx() [1/2]

const double & dd4pod::Geant4Particle::vsx ( ) const

Access the startpoint x.

Definition at line 91 of file Geant4Particle.cc.

◆ vsx() [2/2]

void dd4pod::Geant4Particle::vsx ( double  value)

Set the startpoint x.

Definition at line 127 of file Geant4Particle.cc.

◆ vsy() [1/2]

const double & dd4pod::Geant4Particle::vsy ( ) const

Access the startpoint x.

Definition at line 92 of file Geant4Particle.cc.

◆ vsy() [2/2]

void dd4pod::Geant4Particle::vsy ( double  value)

Set the startpoint x.

Definition at line 128 of file Geant4Particle.cc.

◆ vsz() [1/2]

const double & dd4pod::Geant4Particle::vsz ( ) const

Access the startpoint x.

Definition at line 93 of file Geant4Particle.cc.

◆ vsz() [2/2]

void dd4pod::Geant4Particle::vsz ( double  value)

Set the startpoint x.

Definition at line 129 of file Geant4Particle.cc.


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