4 #ifndef ALIHLTTPCDIGITREADER_H
5 #define ALIHLTTPCDIGITREADER_H
7 //* This file is property of and copyright by the ALICE HLT Project *
8 //* ALICE Experiment at CERN, All rights reserved. *
9 //* See cxx source for full Copyright notice *
11 /** @file AliHLTTPCDigitReader.h
12 @author Timm Steinbeck, Jochen Thaeder, Matthias Richter, Kenneth Aamodt
14 @brief An abstract reader class for TPC data.
17 #include "AliHLTLogging.h"
21 * @class AliHLTTPCDigitReader
22 * An abstract reader class for the TPC data. The Data is treated as a stream
23 * of data points, each containing row number, pad number, time bin and ADC
24 * value. The class hides the actual encoding of the data stream for the sub-
25 * sequent components like the cluster finder.
27 * Some of the data decoders allow random access of the data within one channel.
28 * This functionality is available for all readers if caching is enabled (see
29 * @ref EnableCaching).
31 * The digit reader can be locked for the current channel. If locked, function
32 * @ref Next will return false if data of the current channel is finnished.
35 class AliHLTTPCDigitReader : public AliHLTLogging {
37 /** standard constructor
39 AliHLTTPCDigitReader();
41 virtual ~AliHLTTPCDigitReader();
44 * Init the reader with a data block.
45 * The function fetches the first and last row for the readout partition
46 * from @ref AliHLTTPCTransform. The method is pure virtual and must be implemented
48 * @param ptr pointer to data buffer
49 * @param size size of the data buffer
50 * @param patch patch (readout partition) number within the slice
51 * @param slice sector no (0 to 35)
53 virtual int InitBlock(void* ptr,unsigned long size, Int_t patch, Int_t slice)=0;
57 * <b>Note:</b> This method is for backward compatibility only, not for further
58 * use. The <i>firstrow</i> and <i>lastrow</i> parameters are fetched from
59 * @ref AliHLTTPCTransform.
61 * @param ptr pointer to data buffer
62 * @param size size of the data buffer
63 * @param firstrow first row occuring in the data
64 * @param lastrow last row occuring in the data
65 * @param patch patch (readout partition) number within the slice
66 * @param slice sector no (0 to 35)
68 virtual int InitBlock(void* ptr,unsigned long size,Int_t firstrow,Int_t lastrow, Int_t patch, Int_t slice);
71 * Reset digit reader and release internal structures.
73 virtual int Reset() {return 0;}
83 * Set the reader position to the next value.
84 * If the reader was not yet initialized, initialization is carried out and
85 * the position set to the beginning of the stream (which is in essence the
86 * end of the data block due to the back-linked list).
88 * The modifiers determine the unit of the positioning:
89 * - @ref kNextSignal set to the next signal value
90 * - @ref kNextChannel set at the beginning of the next channel
91 * - @ref kNextBunch set at the beginning of the next bunch within the
94 * If the reader is locked for a pad/channel, Next operates only on the data
95 * belonging to the current channel and returns false at the end of the
98 * The function does some basic stuff and forwards to @ref NextSignal, @ref
99 * NextBunch or @ref NextChannel depending on the modifer. This function is
100 * also necessary if the common sorting is going to be used (not yet implemented)
101 * @return true if data is available, false if not
103 bool Next(int type=kNextSignal);
106 * Set stream position to the next Pad (ALTRO channel).
107 * This is the direct entry to data access on a channel/bunch basis suited
108 * for fast data access.
109 * @return true if data is available, false if not
111 virtual bool NextChannel();
114 * Set stream to the next ALTRO bunch within the current pad.
115 * This is the direct entry to data access on a channel/bunch basis suited
116 * for fast data access.
117 * @return bunch length, 0 if no data bunch available in the current pad
119 virtual int NextBunch();
122 * Get current hardware address.
124 virtual AliHLTUInt32_t GetAltroBlockHWaddr() const;
127 * Get current hardware address from row and pad number.
129 virtual AliHLTUInt32_t GetAltroBlockHWaddr(Int_t row, Int_t pad) const;
132 * Get the row number of the current value.
134 virtual int GetRow()=0;
137 * Get the pad number of the current value.
139 virtual int GetPad()=0;
142 * Get the current ADC value.
144 virtual int GetSignal()=0;
147 * Get pointer to the the current ADC value.
149 virtual const UInt_t* GetSignals();
152 * Get the time bin of the current value.
153 * If @ref NextBunch has been used the function returns the
154 * first time bin of the bunch.
156 virtual int GetTime()=0;
159 * Method to use old rcu fomat.
161 virtual void SetOldRCUFormat(Bool_t oldrcuformat);
164 * Method to set read unsorted flag.
166 virtual void SetUnsorted(Bool_t unsorted);
169 * Enable chaching of the current channel.
170 * Some of the readers allow random data access within one channel.
171 * The others have the possibility to cache the data in order to support
172 * this functionality. Caching is off by default.
173 * @param bCache the current channel is cached
175 void EnableCaching(bool bCache=false);
178 * Rewind the current channel to the beginning.
179 * The function uses the reader methods @ref RewindCurrentChannel or
180 * @ref RewindToPrevChannel to set the stream position to the beginning of the
181 * current channel. If the reader is locked for a channel, the function
182 * rewinds to the begnning of that channel.
187 * Returns the bunch size. Used by the fast decoder.
189 virtual int GetBunchSize();
192 * Returns the row offset. Used by the fast decoder.
194 virtual int GetRowOffset() const;
197 * Returns the trailer size.
199 virtual int GetRCUTrailerSize();
202 * Returns the trailer data.
204 virtual bool GetRCUTrailerData(UChar_t*& trData);
207 * Access operator to the data of a specific time bin.
208 * Not clear if we can manage this.
210 //int operator[](int timebin);
214 /** constructor, locks reader for the current pad */
215 LockGuard(AliHLTTPCDigitReader& reader)
217 {reader.fLckRow=reader.GetRow(); reader.fLckPad=reader.GetPad(); reader.SetFlag(kLocked);}
218 /** destructor, unlocks reader */
220 {fReader.ClearFlag(kLocked|kChannelOverwrap); fReader.fLckRow=-1; fReader.fLckPad=-1;}
223 /** instance of the controlled reader */
224 AliHLTTPCDigitReader& fReader; //!transient
228 /** reader locked for the current channel */
230 /** stream position already at the next channel */
231 kChannelOverwrap = 0x2,
232 /** reader doe not allow channel rewind */
234 /** warning missing fast access methods */
235 kWarnMissFastAccess = 0x8,
236 /** warning on missing RCU trailer getters */
237 kWarnMissTrailerGetters = 0x10,
238 /** channel caching enabled */
239 kChannelCaching = 0x100
243 * Set the reader position to the next value.
244 * This is the reader specific method called by @ref Next.
245 * @return true if data is available, false if not
247 virtual bool NextSignal()=0;
250 * Set a status flag of the reader.
251 * @return current value of the status flags
253 unsigned int SetFlag(unsigned int flag);
256 * Clear a status flag of the reader.
257 * @return current value of the status flags
259 unsigned int ClearFlag(unsigned int flag);
262 * Check a status flag of the reader.
264 int CheckFlag(unsigned int flag) const {return (fFlags&flag)!=0;}
267 * Rewind to the beginning.of the current channel.
269 virtual int RewindCurrentChannel();
272 * Rewind to the beginning of the previous channel.
274 virtual int RewindToPrevChannel();
278 * Print a warning once for missing functionality.
279 * Set corresponding flag to avoid repetitive warnings.
281 void PrintWarningOnce(int type, const char* message);
283 /** pad/channel is locked */
284 unsigned int fFlags; //!transient
286 /** row the reader is locked to */
287 int fLckRow; //!transient
289 /** pad the reader is locked to */
290 int fLckPad; //!transient
292 ClassDef(AliHLTTPCDigitReader, 0)