- added TPCLib to doxygen docu, code corrections according to documentation and effC++
authorrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 16 Nov 2006 07:15:30 +0000 (07:15 +0000)
committerrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 16 Nov 2006 07:15:30 +0000 (07:15 +0000)
- code documentation

14 files changed:
HLT/README
HLT/TPCLib/AliHLTTPC.cxx
HLT/TPCLib/AliHLTTPCBenchmark.cxx
HLT/TPCLib/AliHLTTPCBenchmark.h
HLT/TPCLib/AliHLTTPCClusterFinder.cxx
HLT/TPCLib/AliHLTTPCDataCompressorHelper.cxx
HLT/TPCLib/AliHLTTPCDataCompressorHelper.h
HLT/TPCLib/AliHLTTPCDigitReader.h
HLT/TPCLib/AliHLTTPCFileHandler.cxx
HLT/TPCLib/AliHLTTPCFileHandler.h
HLT/TPCLib/AliHLTTPCPad.h
HLT/TPCLib/AliHLTTPCTransform.cxx
HLT/TPCLib/AliHLTTPCTransform.h
HLT/doc/doxygen.conf.in

index 8336e4f0362fb489c69db4b4e5b9fe9985777e65..bbfdc0afbcb20250e9b147e19a36831a0081988a 100644 (file)
@@ -97,15 +97,17 @@ use a separate build directory.
   make install
 
 You should redirect the output of the make into a file.
-The default install directories are set to the current directory ($PWD).
-
-To override the default prefix use
---prefix=<dir>           
+The default install directory is set to the current directory ($PWD). To
+override the default directory use the option --prefix=<dir>           
+All binary libraries will be installed under <prefix>/lib. If the directory
+id eaual to $ALICE_ROOT, the libraries will be installed under 
+<prefix>/lib/tgt_<arch> as used for AliRoot.
 
 Some important options:
 --enable-logging  # Enable/Disable logging (default enabled)
 --enable-sample   # Compile the sample library
 --enable-tpc      # Compile the TPC library
+--enable-phos      # Compile the PHOS library
 
 Note: You can have several build directories with different configure options,
 but using the same source code. 
@@ -141,12 +143,17 @@ Please include the following information into your request:
 9. Committing to the AliRoot CVS
 ================================
 For development of HLT analysis code check out a HEAD version from the 
-repository and implement your code. For committing do:
-1. cvs update
-2. correct merging conflicts
-3. compile and test your code again
-4. send the whole HLT module except the build sub-directories to
+repository and implement your code. 
+
+For committing do:
+1. make sure that the code changes are correct
+   cvs diff | less
+   remember to restore all temporary changes you made (e.g. log level default)
+2. cvs update
+3. correct merging conflicts
+4. compile and test your code again
+5. send the whole HLT module except the build sub-directories to
    Matthias.Richter@ift.uib.no
-5. you will get a notification when the code is committed, right after that you
+6. you will get a notification when the code is committed, right after that you
    must either do another cvs update or check out the complete module again in
    order to have the right CVS information
index 5e7caef25c5b18ee586f77f9e3a2d0e7f2655753..63a753cab9e1a16f2976f3bb78945289fd9d1b79 100644 (file)
@@ -59,8 +59,6 @@
 
 ClassImp(AliHLTTPC)
 
-Bool_t AliHLTTPC::fgDoVertexFit = kTRUE;//Include the vertex in the final track fit
-
 AliHLTTPC::AliHLTTPC()
 {
   //Default constructor. Should also be used when input is from binary files.
@@ -114,6 +112,8 @@ AliHLTTPC::AliHLTTPC(AliRunLoader *rl)
 }
 #endif
 
+Bool_t AliHLTTPC::fgDoVertexFit = kTRUE;//Include the vertex in the final track fit
+
 void AliHLTTPC::Init(Char_t *path,EFileType filetype,Int_t npatches)
 {
   //Init the whole standard tracker chain
index 8969ec2752fadf316a276d0292bc8a1226ebc9ae..71487fc951026eb2e31d64380e1e59a3ceb22dee 100644 (file)
@@ -4,7 +4,7 @@
 //*-- Copyright &copy ALICE HLT Group
 
 /** \class AliHLTTPCBenchmark
-</pre>
+<pre>
 //_____________________________________________________________
 //
 // AliHLTTPCBenchmark
@@ -33,16 +33,37 @@ using namespace std;
 ClassImp(AliHLTTPCBenchmark)
 
 AliHLTTPCBenchmark::AliHLTTPCBenchmark()
+  :
+  fNbench(0),
+  fNmax(20),
+  fNames(NULL),
+  fTimer(NULL),
+  fSum(NULL),
+  fMin(NULL),
+  fMax(NULL),
+  fCount(NULL)
 {
   //Constructor
-  fNbench = 0;
-  fNmax   = 20;
-  fNames  = 0;
-  fTimer  = 0;
-  fSum    = 0;
-  fMin    = 0;
-  fMax    = 0;
-  fCount  = 0;
+}
+
+AliHLTTPCBenchmark::AliHLTTPCBenchmark(const AliHLTTPCBenchmark&)
+  :
+  fNbench(0),
+  fNmax(20),
+  fNames(NULL),
+  fTimer(NULL),
+  fSum(NULL),
+  fMin(NULL),
+  fMax(NULL),
+  fCount(NULL)
+{
+  HLTFatal("copy constructor untested");
+}
+
+AliHLTTPCBenchmark& AliHLTTPCBenchmark::operator=(const AliHLTTPCBenchmark&)
+{ 
+  HLTFatal("assignment operator untested");
+  return *this;
 }
 
 AliHLTTPCBenchmark::~AliHLTTPCBenchmark()
index 4e9319cbebb266799ac39e51e3e4dd7cb04db705..d60972d8babe236a3862a6c179c8d377d4f145d4 100644 (file)
@@ -18,16 +18,23 @@ class TString;
 #else
 class  AliHLTTPCStopwatch;
 #endif
+#include "AliHLTLogging.h"
 
-class AliHLTTPCBenchmark {
+class AliHLTTPCBenchmark : public AliHLTLogging {
 
 public:
-   AliHLTTPCBenchmark();
-   virtual ~AliHLTTPCBenchmark();
-   Int_t      GetBench(const char *name);
-   void       Start(const char *name);
+  /** standard constructor */
+  AliHLTTPCBenchmark();
+  /** not a valid copy constructor, defined according to effective C++ style */
+  AliHLTTPCBenchmark(const AliHLTTPCBenchmark&);
+  /** not a valid assignment op, but defined according to effective C++ style */
+  AliHLTTPCBenchmark& operator=(const AliHLTTPCBenchmark&);
+  /** destructor */
+  virtual ~AliHLTTPCBenchmark();
+   Int_t      GetBench(const Char_t *name);
+   void       Start(const Char_t *name);
    void       Stop(const char *name);
-   void       Analyze(const char* name);
+   void       Analyze(const Char_t* name);
    
    static Double_t GetCpuTime();
 
index 9e92fd9b44476c8aa5a94eaa84678ee800e0d65e..162036448a691a5f4018e3e1a5c98911e40c4be5 100644 (file)
@@ -1,12 +1,30 @@
 // @(#) $Id$
 // Original: AliL3ClustFinderNew.cxx,v 1.29 2005/06/14 10:55:21 cvetan Exp 
 
-// Author: Anders Vestbo <mailto:vestbo@fi.uib.no>, 
-//         Constantin Loizides <mailto:loizides@ikf.uni-frankfurt.de>
-//         Jochen Thaeder <mailto:thaeder@kip.uni-heidelberg.de>
-
-//*-- Copyright &copy ALICE HLT Group
-
+/**************************************************************************
+ * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ *                                                                        *
+ * Authors: Anders Vestbo <mailto:vestbo@fi.uib.no>,                     *
+ *          Constantin Loizides <mailto:loizides@ikf.uni-frankfurt.de>    *
+ *          Jochen Thaeder <mailto:thaeder@kip.uni-heidelberg.de>         *
+ *          for The ALICE Off-line Project.                               *
+ *                                                                        *
+ * Permission to use, copy, modify and distribute this software and its   *
+ * documentation strictly for non-commercial purposes is hereby granted   *
+ * without fee, provided that the above copyright notice appears in all   *
+ * copies and that both the copyright notice and this permission notice   *
+ * appear in the supporting documentation. The authors make no claims     *
+ * about the suitability of this software for any purpose. It is          *
+ * provided "as is" without express or implied warranty.                  *
+ **************************************************************************/
+
+/** @file   AliHLTTPCClusterFinder.cxx
+    @author Anders Vestbo <mailto:vestbo@fi.uib.no>,                
+           Constantin Loizides <mailto:loizides@ikf.uni-frankfurt.de>
+           Jochen Thaeder <mailto:thaeder@kip.uni-heidelberg.de>     
+    @date   
+    @brief  Cluster Finder for the TPC
+*/
 
 #include "AliHLTTPCDigitReader.h"
 #include "AliHLTTPCRootTypes.h"
index 7641146ed080425a699f8c9eb786ec32bd632dcd..6c733e455139c1bfa15c132b6ab92846c0efb658 100644 (file)
@@ -24,6 +24,13 @@ using namespace std;
 
 ClassImp(AliHLTTPCDataCompressorHelper)
 
+AliHLTTPCDataCompressorHelper::AliHLTTPCDataCompressorHelper() 
+{
+}
+
+AliHLTTPCDataCompressorHelper::~AliHLTTPCDataCompressorHelper() 
+{
+}
 
 Int_t AliHLTTPCDataCompressorHelper::fgNumTimeBits = 12;
 Int_t AliHLTTPCDataCompressorHelper::fgNumPadBits = 12;
index 9ddb4ed0ad8449505e434cb604131190fec3fc14..3adf71662bf2f5985c5fdeb6812e1f9120e3decf 100644 (file)
@@ -9,7 +9,8 @@
 class AliHLTTPCDataCompressorHelper {
   
  public:
-  virtual ~AliHLTTPCDataCompressorHelper() {}
+  AliHLTTPCDataCompressorHelper();
+  virtual ~AliHLTTPCDataCompressorHelper();
 
   static void SetBitNumbers(Int_t pad,Int_t time,Int_t charge,Int_t shape);
   static void SetTransverseResolutions(Float_t res1,Float_t res2,Float_t res3,Float_t width=0.005);
index 7dd6e4770bff52201e4ad4d59f14a44f590f7236..f62308010eac7aa223a478e757203943f77ad1cb 100644 (file)
@@ -7,7 +7,7 @@
 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
  * See cxx source for full Copyright notice                               */
 
-/** @file   AliHLTTPCDigitReaderRaw.h
+/** @file   AliHLTTPCDigitReader.h
     @author Timm Steinbeck, Jochen Thaeder, Matthias Richter
     @date   
     @brief  An abstract reader class for TPC data.
@@ -34,7 +34,7 @@ public:
   /**
    * Init the reader with a data block.
    * The function fetches the first and last row for the readout partition
-   * from @ref AliHLTTransform. The method is pure virtual and must be implemented
+   * from @ref AliHLTTPCTransform. The method is pure virtual and must be implemented
    * by the child class.
    * @param ptr     pointer to data buffer
    * @param size    size of the data buffer
index a5fea83e648c6e5d0c09556314fb3abab60df264..3ae48ae6b2318871472c1aa5bf1a24814f9ea23e 100644 (file)
@@ -71,6 +71,58 @@ using namespace std;
 
 ClassImp(AliHLTTPCFileHandler)
 
+AliHLTTPCFileHandler::AliHLTTPCFileHandler(Bool_t b)
+  :
+  fInAli(NULL),
+#ifdef use_newio
+  fUseRunLoader(kFALSE),
+#endif
+  fParam(NULL),
+  fMC(NULL),
+  fDigits(NULL),
+  fDigitsTree(NULL),
+  fIndexCreated(kFALSE),
+  fUseStaticIndex(b)
+{
+  //Default constructor
+
+  for(Int_t i=0;i<AliHLTTPCTransform::GetNSlice();i++)
+    for(Int_t j=0;j<AliHLTTPCTransform::GetNRows();j++) 
+      fIndex[i][j]=-1;
+
+  if(fUseStaticIndex&&!fgStaticIndexCreated) CleanStaticIndex();
+}
+
+AliHLTTPCFileHandler::AliHLTTPCFileHandler(const AliHLTTPCFileHandler& ref)
+  :
+  fInAli(NULL),
+#ifdef use_newio
+  fUseRunLoader(kFALSE),
+#endif
+  fParam(NULL),
+  fMC(NULL),
+  fDigits(NULL),
+  fDigitsTree(NULL),
+  fIndexCreated(kFALSE),
+  fUseStaticIndex(ref.fUseStaticIndex)
+{
+  HLTFatal("copy constructor untested");
+}
+
+AliHLTTPCFileHandler& AliHLTTPCFileHandler::operator=(const AliHLTTPCFileHandler&)
+{ 
+  HLTFatal("assignment operator untested");
+  return *this;
+}
+
+AliHLTTPCFileHandler::~AliHLTTPCFileHandler()
+{
+  //Destructor
+  if(fMC) CloseMCOutput();
+  FreeDigitsTree();
+  if(fInAli) CloseAliInput();
+}
+
 // of course on start up the index is not created
 Bool_t AliHLTTPCFileHandler::fgStaticIndexCreated=kFALSE;
 Int_t  AliHLTTPCFileHandler::fgStaticIndex[36][159]; 
@@ -137,35 +189,6 @@ Int_t AliHLTTPCFileHandler::LoadStaticIndex(Char_t *prefix,Int_t event)
   return 0;
 }
 
-AliHLTTPCFileHandler::AliHLTTPCFileHandler(Bool_t b)
-{
-  //Default constructor
-  fInAli = 0;
-#ifdef use_newio
-  fUseRunLoader = kFALSE;
-#endif
-  fParam = 0;
-  fMC =0;
-  fDigits=0;
-  fDigitsTree=0;
-  fIndexCreated=kFALSE;
-  fUseStaticIndex=b;
-
-  for(Int_t i=0;i<AliHLTTPCTransform::GetNSlice();i++)
-    for(Int_t j=0;j<AliHLTTPCTransform::GetNRows();j++) 
-      fIndex[i][j]=-1;
-
-  if(fUseStaticIndex&&!fgStaticIndexCreated) CleanStaticIndex();
-}
-
-AliHLTTPCFileHandler::~AliHLTTPCFileHandler()
-{
-  //Destructor
-  if(fMC) CloseMCOutput();
-  FreeDigitsTree();
-  if(fInAli) CloseAliInput();
-}
-
 void AliHLTTPCFileHandler::FreeDigitsTree()
 { 
   //free digits tree
index 9c16132b37cfdef217d2551a91af7bd887b2c3a8..2a200d3cc39830c174a4728b8a0bd472f18c245b 100644 (file)
@@ -17,13 +17,14 @@ class TClonesArray;
 #include <TObject.h>
 #include <TFile.h>
 #include <TTree.h>
+#include "AliHLTLogging.h"
 
 class AliHLTTPCSpacePointData;
 class AliHLTTPCDigitRowData;
 class AliHLTTPCTrackSegmentData;
 class AliHLTTPCTrackArray;
 
-class AliHLTTPCFileHandler:public AliHLTTPCMemHandler{
+class AliHLTTPCFileHandler:public AliHLTTPCMemHandler, public AliHLTLogging {
 
  protected:
 #ifdef use_newio
@@ -51,7 +52,13 @@ class AliHLTTPCFileHandler:public AliHLTTPCMemHandler{
   Bool_t CreateIndex();  //create the index
 
  public:
+  /** standard constructor */
   AliHLTTPCFileHandler(Bool_t b=kFALSE);
+  /** not a valid copy constructor, defined according to effective C++ style */
+  AliHLTTPCFileHandler(const AliHLTTPCFileHandler&);
+  /** not a valid assignment op, but defined according to effective C++ style */
+  AliHLTTPCFileHandler& operator=(const AliHLTTPCFileHandler&);
+  /** destructor */
   ~AliHLTTPCFileHandler();
 
   void FreeDigitsTree();
index 00dec1fa8c462bc3b3bd9cf434ca67a219734b31..c30305b9cb34a28c45f9fbc184f8874a42f86247 100644 (file)
@@ -192,7 +192,7 @@ class AliHLTTPCPad : public AliHLTLogging {
   /**
    * Get the base line value of a certain channel.
    * @param bin      Channel number
-   * @param base line value at bin
+   * @return base line value at bin
    */
   AliHLTTPCSignal_t GetBaseLine(Int_t bin) const;
 
index c0d015d0ecea25e845f4bd0f6d62f7c81a20b70c..534aaf4591ea11358718a8d63f2439c56ecf83ad 100644 (file)
@@ -76,6 +76,10 @@ using namespace std;
 
 ClassImp(AliHLTTPCTransform)
 
+AliHLTTPCTransform::AliHLTTPCTransform()
+{
+}
+
 const Double_t AliHLTTPCTransform::fgkAnodeWireSpacing = 0.25; //Taken from the TDR
 const Double_t AliHLTTPCTransform::fgkBFACT = 0.0029980;       //Conversion Factor
 const Double_t AliHLTTPCTransform::fgkPi  =   3.141592653589793;
index 375be8140e4d7bac90a10d4a13f42c7983dbe9cd..dbcd62abeda2818c3169228696db9a907105cd5d 100644 (file)
@@ -13,6 +13,7 @@
 class AliHLTTPCTransform {
 
  public:
+    AliHLTTPCTransform();
   enum VersionType { kVdefault=0, kVdeprecated=1, kValiroot=10, kVcosmics=100};
 
  private:
index ee81f0851c96942777279861197dd0e3c90d174e..72619478aeb03577ab86312acf85d9f89c1ff367 100644 (file)
@@ -64,6 +64,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 INPUT                  = @top_srcdir@/doc      \
                         @top_srcdir@/BASE      \
+                        @top_srcdir@/TPCLib    \
                         @top_srcdir@/SampleLib
 FILE_PATTERNS          = *.h *.c *.cpp *.hpp *.cxx
 RECURSIVE              = YES