pftools::Deposition Class Reference

This class holds an arbitrary energy deposition, specified in terms of angular position, energy, depth (optional) and detector element type. More...

#include <Deposition.h>

Public Member Functions
	Deposition (DetectorElementPtr element, double eta=0.0, double phi=0.0, double energy=0.0, double depth=0.0)
double	getDepth () const
DetectorElementPtr	getDetectorElement () const
double	getEnergy () const
double	getEta () const
double	getPhi () const
void	setEnergy (double energy)
virtual	~Deposition ()

Private Attributes
double	myDepth
DetectorElementPtr	myElementPtr
double	myEnergy
double	myEta
double	myPhi

Friends
std::ostream &	operator<< (std::ostream &s, const Deposition &d)

Detailed Description

This class holds an arbitrary energy deposition, specified in terms of angular position, energy, depth (optional) and detector element type.

Author

Jamie Balin

Date

April 2008

Definition at line 20 of file Deposition.h.

Constructor & Destructor Documentation

Deposition::Deposition	(	DetectorElementPtr	element,
		double	eta = 0.0,
		double	phi = 0.0,
		double	energy = 0.0,
		double	depth = 0.0
	)

Definition at line 3 of file Deposition.cc.

                                     :
    myElementPtr(element), myEta(eta), myPhi(phi), myEnergy(energy),
            myDepth(depth) {
}

Deposition::~Deposition ( )

virtual

Definition at line 9 of file Deposition.cc.

                        {
}

Member Function Documentation

double pftools::Deposition::getDepth ( void  ) const

inline

Definition at line 52 of file Deposition.h.

References myDepth.

                                   {
        return myDepth;
    }

DetectorElementPtr pftools::Deposition::getDetectorElement ( ) const

inline

Definition at line 43 of file Deposition.h.

References myElementPtr.

Referenced by pftools::ParticleDeposit::getRecEnergy(), pftools::ParticleDeposit::getTruthEnergy(), and pftools::ParticleDeposit::setRecEnergy().

                                                         {
        return myElementPtr;
    }

double pftools::Deposition::getEnergy ( ) const

inline

Definition at line 38 of file Deposition.h.

References myEnergy.

Referenced by pftools::ParticleDeposit::getRecEnergy(), and pftools::ParticleDeposit::getTruthEnergy().

                                    {
        return myEnergy;
    }

double pftools::Deposition::getEta ( ) const

inline

Definition at line 28 of file Deposition.h.

References myEta.

Referenced by pftools::ParticleDeposit::getRecEnergy().

                                 {
        return myEta;
    }

double pftools::Deposition::getPhi ( ) const

inline

Definition at line 33 of file Deposition.h.

References myPhi.

Referenced by pftools::ParticleDeposit::getRecEnergy().

                                 {
        return myPhi;
    }

void pftools::Deposition::setEnergy ( double  energy )

inline

Definition at line 23 of file Deposition.h.

References relval_parameters_module::energy, and myEnergy.

Referenced by pftools::ParticleDeposit::setRecEnergy().

                                         {
        myEnergy = energy;
    }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  s, const Deposition &  d  )

friend

Member Data Documentation

double pftools::Deposition::myDepth

private

Definition at line 74 of file Deposition.h.

Referenced by getDepth().

DetectorElementPtr pftools::Deposition::myElementPtr

private

Definition at line 69 of file Deposition.h.

Referenced by getDetectorElement().

double pftools::Deposition::myEnergy

private

Definition at line 73 of file Deposition.h.

Referenced by getEnergy(), and setEnergy().

double pftools::Deposition::myEta

private

Definition at line 71 of file Deposition.h.

Referenced by getEta().

double pftools::Deposition::myPhi

private

Definition at line 72 of file Deposition.h.

Referenced by getPhi().