Added documentation of each file.
[u/mrichter/AliRoot.git] / FMD / AliFMDBoolMap.h
CommitLineData
56b1929b 1#ifndef ALIFMDBOOLMAP_H
2#define ALIFMDBOOLMAP_H
3/* Copyright (c) 2004, ALICE Experiment @ CERN.
4 * All rights reserved
5 * See AliFMDBoolMap.cxx for full copyright notice
6 *
7 * Created Mon Nov 8 12:51:51 2004 by Christian Holm Christensen
8 */
9/* $Id$ */
c2fc1258 10/** @file AliFMDBoolMap.h
11 @author Christian Holm Christensen <cholm@nbi.dk>
12 @date Sun Mar 26 18:28:59 2006
13 @brief Per strip boolean map
14*/
56b1929b 15//__________________________________________________________
16//
17// Map of Bool_t for each FMD strip
088f8e79 18// Used in calibration and the like classes.
19// Used amoung other things for dead-channel map
56b1929b 20//
21#ifndef ALIFMDMAP_H
22# include <AliFMDMap.h>
23#endif
24
9f662337 25/** @class AliFMDBoolMap
26 @brief MAp of per strip boolean values.
27 @ingroup FMD_base
28 */
56b1929b 29class AliFMDBoolMap : public AliFMDMap
30{
31public:
9f662337 32 /** Copy constructor
33 @param other Object to copy from. */
56b1929b 34 AliFMDBoolMap(const AliFMDBoolMap& other);
9f662337 35 /** Constructor
36 @param maxDet Number of detectors (3)
37 @param maxRing Number of rings (2)
38 @param maxSec Number of sectors (40)
39 @param maxStr Number of strips (20) */
56b1929b 40 AliFMDBoolMap(size_t maxDet = kMaxDetectors,
baa92757 41 size_t maxRing = kMaxRings,
42 size_t maxSec = kMaxSectors,
43 size_t maxStr = kMaxStrips);
9f662337 44 /** Destructor */
56b1929b 45 virtual ~AliFMDBoolMap() { delete [] fData; }
9f662337 46 /** Assignment operator
47 @param other Object to assign from
48 @return reference to this object. */
56b1929b 49 AliFMDBoolMap& operator=(const AliFMDBoolMap& other);
9f662337 50 /** Reset to value
51 @param v Value to reset from */
69b696b9 52 virtual void Reset(const Bool_t& v=Bool_t());
9f662337 53 /** Access operator
54 @param det Detector
55 @param ring Ring
56 @param sec Sector
57 @param str Strip
58 @return reference value stored for the strip */
56b1929b 59 virtual Bool_t& operator()(UShort_t det,
69b696b9 60 Char_t ring,
61 UShort_t sec,
62 UShort_t str);
9f662337 63 /** Access operator
64 @param det Detector
65 @param ring Ring
66 @param sec Sector
67 @param str Strip
68 @return value stored for the strip */
56b1929b 69 virtual const Bool_t& operator()(UShort_t det,
69b696b9 70 Char_t ring,
71 UShort_t sec,
72 UShort_t str) const;
56b1929b 73protected:
bfdc7f5d 74 size_t fTotal; // Total number of entries
75 Bool_t* fData; // [fTotal] The Data
76 ClassDef(AliFMDBoolMap,2) // Map of Bool_t data per strip
56b1929b 77};
78
79#endif
80//__________________________________________________________
81//
82// Local Variables:
83// mode: C++
84// End:
85//