MarlinTPC  1.2.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
marlintpc::TPCVoxel Class Reference

An LCFixedObject class to store charge in voxels of a TPC. More...

#include <TPCVoxel.h>

Inheritance diagram for marlintpc::TPCVoxel:

Public Member Functions

 TPCVoxel (int padIndex, int timeIndex, int charge, int moduleID=0)
 
 TPCVoxel (EVENT::LCObject *obj)
 
 TPCVoxel (const TPCVoxel &original)
 
int getModuleID () const
 Returns the GEAR ModuleID.
 
int getPadIndex () const
 Returns the GEAR pad index.
 
int getTimeIndex () const
 Returns the time index of the voxel.
 
int getCharge () const
 Returns the charge in the voxel (in electrons/ions)
 
void setCharge (int charge)
 Set the charge if the voxel (in electrons/ions)
 
bool operator== (const TPCVoxel &right) const
 Two voxels are equal if their pad index and time index are equal. More...
 
bool operator< (const TPCVoxel &right) const
 < operator for e.g. sorting in STL containers. More...
 
TPCVoxeloperator= (const TPCVoxel &that)
 
void print (std::ostream &os=std::cout) const
 Print the voxel information.
 
virtual const std::string getTypeName () const
 Implementation of the getTypeName method of LCGenericObject.
 
virtual const std::string getDataDescription () const
 Implementation of the getDataDescripton method of LCGenericObject PadIndex, TimeIndex and Charge are all ints. More...
 

Static Public Member Functions

static std::string getRevision ()
 returns the svn revision of the code
 

Protected Member Functions

void setModuleID (int moduleID)
 Set the module, only called from the constructor.
 
void setPadIndex (int padIndex)
 Set the pad index, only called from the constructor.
 
void setTimeIndex (int timeIndex)
 Set the time index, only called from the constructor.
 

Detailed Description

An LCFixedObject class to store charge in voxels of a TPC.

Also provides comparison operators for sorting, e.g. in STL containers.

Member Function Documentation

virtual const std::string marlintpc::TPCVoxel::getDataDescription ( ) const
inlinevirtual

Implementation of the getDataDescripton method of LCGenericObject PadIndex, TimeIndex and Charge are all ints.

bool marlintpc::TPCVoxel::operator< ( const TPCVoxel right) const

< operator for e.g. sorting in STL containers.

They are sorted in pad index, and within this in time index. Charge is not considdered.

References getModuleID(), getPadIndex(), and getTimeIndex().

bool marlintpc::TPCVoxel::operator== ( const TPCVoxel right) const

Two voxels are equal if their pad index and time index are equal.

The charge is not considered.

References getModuleID(), getPadIndex(), and getTimeIndex().


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