UserInfo< Info, Payload > Class Template Reference

UserInfo class which is used to attach additional information to Geant4 particles and tracks. More...

#include <UserInfo.h>

Inheritance diagram for UserInfo< Info, Payload >:

Public Member Functions
	UserInfo (Payload data)
	The constructor of the user info class.
Payload	getData ()
	Returns the payloaded data.
int	getStatus ()
	Get status of optical photon (used for performance speed-ups) 0 initial 1 prescaled in StackingAction 2 quantum efficiency has been applied.
double	getFraction ()
	Get optical photon propagation fraction (used for performance speed-ups) status=0: fraction=1 status=1: fraction=PhotonFraction as set in FullSim status=2: fraction=quantum efficiency.
MCParticleTrajectory *	getTrajectory ()
	Get optional particle trajectory.
void	setStatus (int status)
	Set status of optical photon (used for performance speed-ups)
void	setFraction (double fraction)
	Store optical photon propagation fraction (used for performance speed-ups)
void	setTrajectory (MCParticleTrajectory *trajectory)
	Set the optional particle trajectory.
virtual void	Print () const
	Prints information, not implemented in this class.

Static Public Member Functions
template<class Carrier>
static Payload	getInfo (Carrier &obj)
	Static function to just return UserInformation attached to the obj of type Carrier.

Protected Attributes
Payload	m_data
	The data which is payloaded to the specified class.
int	m_status
	optical photon: status
double	m_fraction
	optical photon: propagation fraction
MCParticleTrajectory *	m_trajectory
	Particle trajectory, if any.

Detailed Description

template<class Info, class Payload>
class Belle2::Simulation::UserInfo< Info, Payload >

UserInfo class which is used to attach additional information to Geant4 particles and tracks.

This class is designed as a template based payload class.

Definition at line 36 of file UserInfo.h.

Constructor & Destructor Documentation

UserInfo()

template<class Info, class Payload>

UserInfo ( Payload data )

inlineexplicit

The constructor of the user info class.

Parameters

data	The data which should be payloaded to the class.

Definition at line 44 of file UserInfo.h.

: Info(), m_data(data), m_status(0), m_fraction(1.0), m_trajectory(nullptr) {}

Member Function Documentation

getData()

template<class Info, class Payload>

Payload getData ( )

inline

Returns the payloaded data.

Returns

The data added to the class.

Definition at line 50 of file UserInfo.h.

{ return m_data; }

getFraction()

template<class Info, class Payload>

double getFraction ( )

inline

Get optical photon propagation fraction (used for performance speed-ups) status=0: fraction=1 status=1: fraction=PhotonFraction as set in FullSim status=2: fraction=quantum efficiency.

Returns

fraction

Definition at line 68 of file UserInfo.h.

{return m_fraction;}

getInfo()

template<class Info, class Payload>

template<class Carrier>

static Payload getInfo ( Carrier & obj )

inlinestatic

Static function to just return UserInformation attached to the obj of type Carrier.

Throws an exception of type CouldNotFindUserInfo if no information was found.

Parameters

obj	Reference to the carrier.

Returns

The data attached to the carrier.

Definition at line 100 of file UserInfo.h.

      {
        UserInfo<Info, Payload>* userinfo = dynamic_cast<UserInfo<Info, Payload>*>(obj.GetUserInformation());
        if (!userinfo) throw(CouldNotFindUserInfo());
        return userinfo->getData();
      }

getStatus()

template<class Info, class Payload>

int getStatus ( )

inline

Get status of optical photon (used for performance speed-ups) 0 initial 1 prescaled in StackingAction 2 quantum efficiency has been applied.

Returns

status

Definition at line 59 of file UserInfo.h.

{return m_status;}

getTrajectory()

template<class Info, class Payload>

MCParticleTrajectory * getTrajectory ( )

inline

Get optional particle trajectory.

Definition at line 71 of file UserInfo.h.

{ return m_trajectory; }

Print()

template<class Info, class Payload>

virtual void Print ( ) const

inlinevirtual

Prints information, not implemented in this class.

Definition at line 91 of file UserInfo.h.

{;}

setFraction()

template<class Info, class Payload>

void setFraction ( double fraction )

inline

Store optical photon propagation fraction (used for performance speed-ups)

Parameters

fraction

fraction

Definition at line 83 of file UserInfo.h.

{ m_fraction = fraction;}

setStatus()

template<class Info, class Payload>

void setStatus ( int status )

inline

Set status of optical photon (used for performance speed-ups)

Parameters

status

status

Definition at line 77 of file UserInfo.h.

{ m_status = status;}

setTrajectory()

template<class Info, class Payload>

void setTrajectory ( MCParticleTrajectory * trajectory )

inline

Set the optional particle trajectory.

Definition at line 86 of file UserInfo.h.

{ m_trajectory = trajectory; }

Member Data Documentation

m_data

template<class Info, class Payload>

Payload m_data

protected

The data which is payloaded to the specified class.

Definition at line 109 of file UserInfo.h.

m_fraction

template<class Info, class Payload>

double m_fraction

protected

optical photon: propagation fraction

Definition at line 112 of file UserInfo.h.

m_status

template<class Info, class Payload>

int m_status

protected

optical photon: status

Definition at line 111 of file UserInfo.h.

m_trajectory

template<class Info, class Payload>

MCParticleTrajectory* m_trajectory

protected

Particle trajectory, if any.

Definition at line 113 of file UserInfo.h.

---

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

• simulation/kernel/include/UserInfo.h