coding rules and class documentation
authorrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Wed, 4 Apr 2012 08:04:07 +0000 (08:04 +0000)
committerrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Wed, 4 Apr 2012 08:04:07 +0000 (08:04 +0000)
HLT/rec/AliHLTOUTDigitReader.cxx
HLT/rec/AliHLTOUTDigitReader.h
HLT/rec/AliHLTOUTHomerCollection.cxx
HLT/rec/AliHLTOUTHomerCollection.h
HLT/rec/AliHLTOUTRawReader.cxx
HLT/rec/AliHLTOUTRawReader.h

index 7188a83..3c4e93e 100644 (file)
@@ -1,11 +1,10 @@
 // $Id$
 
 //**************************************************************************
-//* This file is property of and copyright by the ALICE HLT Project        * 
+//* This file is property of and copyright by the                          * 
 //* ALICE Experiment at CERN, All rights reserved.                         *
 //*                                                                        *
 //* Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no>        *
-//*                  for The ALICE HLT Project.                            *
 //*                                                                        *
 //* Permission to use, copy, modify and distribute this software and its   *
 //* documentation strictly for non-commercial purposes is hereby granted   *
 //* provided "as is" without express or implied warranty.                  *
 //**************************************************************************
 
-/** @file   AliHLTOUTDigitReader.cxx
-    @author Matthias Richter
-    @date   
-    @brief  HLTOUT data wrapper for simulated AliRoot HLT digit data.
-*/
+/// @file   AliHLTOUTDigitReader.cxx
+/// @author Matthias Richter
+/// @date   
+/// @brief  HLTOUT data wrapper for simulated AliRoot HLT digit data.
+///
 
 #include "AliHLTOUTDigitReader.h"
 #include "AliRawDataHeader.h"
@@ -46,18 +45,18 @@ AliHLTOUTDigitReader::AliHLTOUTDigitReader(int event, AliHLTEsdManager* pEsdMana
   fppDigitArrays(NULL),
   fpEquipments(NULL),
   fNofDDLs(0),
-  fCurrent(-1)
+  fCurrentLink(-1)
 {
+  // constructor
+  //
+  // HLTOUT data wrapper for simulated AliRoot HLT digit data
+  // 
   // see header file for class documentation
-  // or
-  // refer to README to build package
-  // or
-  // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
 }
 
 AliHLTOUTDigitReader::~AliHLTOUTDigitReader()
 {
-  // see header file for class documentation
+  // destructor
   CloseTree();
 
   if (fpDigitFile) {
@@ -69,18 +68,18 @@ AliHLTOUTDigitReader::~AliHLTOUTDigitReader()
 
 Bool_t AliHLTOUTDigitReader::ReadNextData(UChar_t*& data)
 {
-  // see header file for class documentation
+  // overloaded from AliHLTOUTHomerCollection: switch to next DDL
   if (!fppDigitArrays && (!ReadArrays() || !fppDigitArrays))
     return kFALSE;
 
-  if (fCurrent>=fNofDDLs)
+  if (fCurrentLink>=fNofDDLs)
     return kFALSE;
 
-  while (++fCurrent<fNofDDLs) {
-    if (fMinDDL>-1 && fMinDDL>fpEquipments[fCurrent]) continue;
-    if (fMaxDDL>-1 && fMaxDDL<fpEquipments[fCurrent]) continue;
-    if (fppDigitArrays[fCurrent]->GetSize()>(int)sizeof(AliRawDataHeader)) {
-      data=reinterpret_cast<UChar_t*>(fppDigitArrays[fCurrent]->GetArray());
+  while (++fCurrentLink<fNofDDLs) {
+    if (fMinDDL>-1 && fMinDDL>fpEquipments[fCurrentLink]) continue;
+    if (fMaxDDL>-1 && fMaxDDL<fpEquipments[fCurrentLink]) continue;
+    if (fppDigitArrays[fCurrentLink]->GetSize()>(int)sizeof(AliRawDataHeader)) {
+      data=reinterpret_cast<UChar_t*>(fppDigitArrays[fCurrentLink]->GetArray());
       data+=sizeof(AliRawDataHeader);
       return kTRUE;
     }
@@ -90,48 +89,51 @@ Bool_t AliHLTOUTDigitReader::ReadNextData(UChar_t*& data)
 
 int AliHLTOUTDigitReader::Reset()
 {
-  // see header file for class documentation
-  fCurrent=-1;
+  // overloaded from AliHLTOUTHomerCollection: reset DDL position
+  fCurrentLink=-1;
   return 0;
 }
 
 int AliHLTOUTDigitReader::GetDataSize()
 {
-  // see header file for class documentation
-  if (fCurrent>=0 && fCurrent<fNofDDLs && fppDigitArrays) {
-    return fppDigitArrays[fCurrent]->GetSize()-sizeof(AliRawDataHeader);
+  // overloaded from AliHLTOUTHomerCollection: get size of current DDL
+  if (fCurrentLink>=0 && fCurrentLink<fNofDDLs && fppDigitArrays) {
+    return fppDigitArrays[fCurrentLink]->GetSize()-sizeof(AliRawDataHeader);
   }
   return 0;
 }
 
 const AliRawDataHeader* AliHLTOUTDigitReader::GetDataHeader()
 {
-  // see header file for class documentation
-  if (fCurrent>=0 && fCurrent<fNofDDLs && fppDigitArrays) {
-    return reinterpret_cast<AliRawDataHeader*>(fppDigitArrays[fCurrent]->GetArray());
+  // overloaded from AliHLTOUTHomerCollection: get data header of current DDL
+  if (fCurrentLink>=0 && fCurrentLink<fNofDDLs && fppDigitArrays) {
+    return reinterpret_cast<AliRawDataHeader*>(fppDigitArrays[fCurrentLink]->GetArray());
   }
   return NULL;
 }
 
 void AliHLTOUTDigitReader::SelectEquipment(int /*equipmentType*/, int minEquipmentId, int maxEquipmentId)
 {
-  // see header file for class documentation
+  // overloaded from AliHLTOUTHomerCollection: select equipment range
   fMinDDL=minEquipmentId;
   fMaxDDL=maxEquipmentId;
 }
 
 int AliHLTOUTDigitReader::GetEquipmentId()
 {
-  // see header file for class documentation
-  if (fCurrent>=0 && fCurrent<fNofDDLs && fpEquipments) {
-    return fpEquipments[fCurrent];
+  // overloaded from AliHLTOUTHomerCollection: get id of current DDL
+  if (fCurrentLink>=0 && fCurrentLink<fNofDDLs && fpEquipments) {
+    return fpEquipments[fCurrentLink];
   }
   return -1;
 }
 
 bool AliHLTOUTDigitReader::ReadArrays()
 {
-  // see header file for class documentation
+  // Read the data from the root file and HLTOUT raw tree.
+  // Retrieve the number of branches and allocate arrays acording
+  // to that. After initialization of the arrays and variables, the
+  // event fEnvent is read.
   bool result=false;
 
   if (GetCurrentEventNo()<0) {
@@ -203,7 +205,7 @@ bool AliHLTOUTDigitReader::ReadArrays()
 
 int AliHLTOUTDigitReader::CloseTree()
 {
-  // see header file for class documentation
+  // Cleanup tree and data arrays.
   int iResult=0;
   for (int i=0; i<fNofDDLs; i++) {
     if (fppDigitArrays[i]) delete fppDigitArrays[i];
@@ -216,14 +218,16 @@ int AliHLTOUTDigitReader::CloseTree()
   if (fpDigitTree) delete fpDigitTree;
   fpDigitTree=NULL;
   fNofDDLs=0;
-  fCurrent=-1;
+  fCurrentLink=-1;
 
   return iResult;
 }
 
 void AliHLTOUTDigitReader::SetParam(TTree* /*pDigitTree*/, int event)
 {
-  // see header file for class documentation
+  // set parameter for this HLTOUT instance
+  // The function is for internal use only in conjunction with the
+  // AliHLTOUT::New() functions.
 
   // TODO: here we have the implemented to correct loading of
   // the digit file from the run loader. At time of writing
@@ -234,7 +238,9 @@ void AliHLTOUTDigitReader::SetParam(TTree* /*pDigitTree*/, int event)
 
 void AliHLTOUTDigitReader::SetParam(const char* filename, int event)
 {
-  // see header file for class documentation
+  // set parameter for this HLTOUT instance
+  // The function is for internal use only in conjunction with the
+  // AliHLTOUT::New() functions.
 
   if (filename && filename[0]!=0) {
     fDigitFileName=filename;
index 37363b9..49d3a27 100644 (file)
@@ -3,15 +3,15 @@
 
 #ifndef ALIHLTOUTDIGITREADER_H
 #define ALIHLTOUTDIGITREADER_H
-//* This file is property of and copyright by the ALICE HLT Project        * 
+//* This file is property of and copyright by the                          * 
 //* ALICE Experiment at CERN, All rights reserved.                         *
-//* See cxx source for full Copyright notice                               */
+//* See cxx source for full Copyright notice                               *
 
-/** @file   AliHLTOUTDigitReader.h
-    @author Matthias Richter
-    @date   
-    @brief  HLTOUT data wrapper for simulated AliRoot HLT digit data.
-*/
+/// @file   AliHLTOUTDigitReader.h
+/// @author Matthias Richter
+/// @date   
+/// @brief  HLTOUT data wrapper for simulated AliRoot HLT digit data.
+///
 
 #include "AliHLTOUTHomerCollection.h"
 #include "TString.h"
@@ -98,8 +98,8 @@ class AliHLTOUTDigitReader : public AliHLTOUTHomerCollection {
   /** number of DDL objects -> size of the arrays */
   int fNofDDLs; //!transient
 
-  /** current position in the array */
-  int fCurrent; //!transient
+  /** current position in the array of DDLs*/
+  int fCurrentLink; //!transient
 
   ClassDef(AliHLTOUTDigitReader, 0)
 };
index c9d551b..c7f2ca1 100644 (file)
@@ -1,11 +1,10 @@
 // $Id$
 
 //**************************************************************************
-//* This file is property of and copyright by the ALICE HLT Project        * 
+//* This file is property of and copyright by the                          * 
 //* ALICE Experiment at CERN, All rights reserved.                         *
 //*                                                                        *
 //* Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no>        *
-//*                  for The ALICE HLT Project.                            *
 //*                                                                        *
 //* Permission to use, copy, modify and distribute this software and its   *
 //* documentation strictly for non-commercial purposes is hereby granted   *
 //* provided "as is" without express or implied warranty.                  *
 //**************************************************************************
 
-/** @file   AliHLTOUTHomerCollection.cxx
-    @author Matthias Richter
-    @date   
-    @brief  General collection for HLTOUT data in DDL format.
-*/
+/// @file   AliHLTOUTHomerCollection.cxx
+/// @author Matthias Richter
+/// @date   
+/// @brief  General collection for HLTOUT data in DDL format.
+///
 
 #include "AliHLTOUTHomerCollection.h"
 #include "AliHLTHOMERLibManager.h"
@@ -35,22 +34,22 @@ ClassImp(AliHLTOUTHomerCollection)
 AliHLTOUTHomerCollection::AliHLTOUTHomerCollection(int event, AliHLTEsdManager* pEsdManager)
   :
   AliHLTOUTHomerBuffer(NULL, 0),
-  fpCurrent(NULL),
   fEvent(event),
+  fpCurrent(NULL),
   fpEsdManager(pEsdManager)
 {
+  // constructor
+  //
+  // General collection for HLTOUT data in DDL format
+  // 
   // see header file for class documentation
-  // or
-  // refer to README to build package
-  // or
-  // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
 }
 
 const int AliHLTOUTHomerCollection::fgkIdShift=16;
 
 AliHLTOUTHomerCollection::~AliHLTOUTHomerCollection()
 {
-  // see header file for class documentation
+  // destructor
   if (fpManager) {
     if (fpCurrent) fpManager->DeleteReader(fpCurrent);
     fpCurrent=NULL;
@@ -59,7 +58,7 @@ AliHLTOUTHomerCollection::~AliHLTOUTHomerCollection()
 
 int AliHLTOUTHomerCollection::GenerateIndex()
 {
-  // see header file for class documentation
+  // Overloaded from AliHLTOUT
   // step through all HLT ddls, create HOMER readers and
   // scan data block
   int iResult=0;
@@ -91,7 +90,7 @@ int AliHLTOUTHomerCollection::GenerateIndex()
 int AliHLTOUTHomerCollection::GetDataBuffer(AliHLTUInt32_t index, const AliHLTUInt8_t* &pBuffer, 
                                      AliHLTUInt32_t& size)
 {
-  // see header file for class documentation
+  // Overloaded from AliHLTOUT: get data buffer at specified index
   int iResult=0;
   pBuffer=NULL;
   size=0;
@@ -138,7 +137,7 @@ int AliHLTOUTHomerCollection::GetDataBuffer(AliHLTUInt32_t index, const AliHLTUI
 
 AliHLTHOMERReader* AliHLTOUTHomerCollection::OpenReader(UChar_t* pSrc, unsigned int size)
 {
-  // see header file for class documentation
+  // open HOMER reader for buffer
   unsigned int offset=sizeof(AliHLTOUTEventHeader);
   const AliRawDataHeader* pCDH=GetDataHeader();
   AliHLTUInt32_t id=(GetEquipmentId());
@@ -198,7 +197,7 @@ AliHLTHOMERReader* AliHLTOUTHomerCollection::OpenReader(UChar_t* pSrc, unsigned
 
 int AliHLTOUTHomerCollection::WriteESD(const AliHLTUInt8_t* pBuffer, AliHLTUInt32_t size, AliHLTComponentDataType dt, AliESDEvent* tgtesd) const
 {
-  // see header file for class documentation
+  // write ESD
   if (!pBuffer && size<=0) return -EINVAL;
   int iResult=0;
   if (fpEsdManager) {
index 6b88aed..c65c653 100644 (file)
@@ -3,15 +3,15 @@
 
 #ifndef ALIHLTOUTHOMERCOLLECTION_H
 #define ALIHLTOUTHOMERCOLLECTION_H
-//* This file is property of and copyright by the ALICE HLT Project        * 
+//* This file is property of and copyright by the                          * 
 //* ALICE Experiment at CERN, All rights reserved.                         *
 //* See cxx source for full Copyright notice                               *
 
-/** @file   AliHLTOUTHomerCollection.h
-    @author Matthias Richter
-    @date   
-    @brief  General collection for HLTOUT data in DDL format.
-*/
+/// @file   AliHLTOUTHomerCollection.h
+/// @author Matthias Richter
+/// @date   
+/// @brief  General collection for HLTOUT data in DDL format.
+///
 #include "AliHLTOUTHomerBuffer.h"
 
 class AliHLTHOMERReader;
@@ -84,6 +84,11 @@ class AliHLTOUTHomerCollection : public AliHLTOUTHomerBuffer {
   // interface function of AliHLTOUT
   int WriteESD(const AliHLTUInt8_t* pBuffer, AliHLTUInt32_t size, AliHLTComponentDataType dt, AliESDEvent* tgtesd=NULL) const;
 
+  /** current event no */
+  int fEvent; //!transient
+
+private:
+
  private:
   /** copy constructor prohibited */
   AliHLTOUTHomerCollection(const AliHLTOUTHomerCollection&);
@@ -97,6 +102,7 @@ class AliHLTOUTHomerCollection : public AliHLTOUTHomerBuffer {
 
   /**
    * Get the data buffer
+   * Overloaded from AliHLTOUT
    * @param [in]  index   index of the block
    * @param [out] pBuffer buffer of the selected data block
    * @param [out] size    size of the selected data block
@@ -118,11 +124,6 @@ class AliHLTOUTHomerCollection : public AliHLTOUTHomerBuffer {
   /** current instance of the HOMER reader */
   AliHLTHOMERReader* fpCurrent;  //!transient
 
-protected:
-  /** current event no */
-  int fEvent; //!transient
-
-private:
   /** instance of the ESD manager for writing and merging */
   AliHLTEsdManager* fpEsdManager; //!transient
 
index 9a6f012..db510e2 100644 (file)
@@ -1,11 +1,10 @@
 // $Id$
 
 //**************************************************************************
-//* This file is property of and copyright by the ALICE HLT Project        * 
+//* This file is property of and copyright by the                          * 
 //* ALICE Experiment at CERN, All rights reserved.                         *
 //*                                                                        *
 //* Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no>        *
-//*                  for The ALICE HLT Project.                            *
 //*                                                                        *
 //* Permission to use, copy, modify and distribute this software and its   *
 //* documentation strictly for non-commercial purposes is hereby granted   *
 //* provided "as is" without express or implied warranty.                  *
 //**************************************************************************
 
-/** @file   AliHLTOUTRawReader.cxx
-    @author Matthias Richter
-    @date   
-    @brief  HLTOUT data wrapper for AliRawReader.                         
-*/
+/// @file   AliHLTOUTRawReader.cxx
+/// @author Matthias Richter
+/// @date   
+/// @brief  HLTOUT data wrapper for AliRawReader.
+///
 
 #include "AliHLTOUTRawReader.h"
 #include "AliRawReader.h"
@@ -33,11 +32,11 @@ AliHLTOUTRawReader::AliHLTOUTRawReader()
   AliHLTOUTHomerCollection(),
   fpRawreader(NULL)
 {
+  // constructor
+  //
+  // HLTOUT data wrapper for AliRawReader
+  // 
   // see header file for class documentation
-  // or
-  // refer to README to build package
-  // or
-  // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
 }
 
 AliHLTOUTRawReader::AliHLTOUTRawReader(AliRawReader* pRawreader, int event, AliHLTEsdManager* pEsdManager)
@@ -54,46 +53,46 @@ AliHLTOUTRawReader::AliHLTOUTRawReader(AliRawReader* pRawreader, int event, AliH
 
 AliHLTOUTRawReader::~AliHLTOUTRawReader()
 {
-  // see header file for class documentation
+  // destructor
 }
 
 Bool_t AliHLTOUTRawReader::ReadNextData(UChar_t*& data)
 {
-  // see header file for class documentation
+  // overloaded from AliHLTOUTHomerCollection: switch to next DDL
   if (!fpRawreader) return kFALSE;
   return fpRawreader->ReadNextData(data);
 }
 
 int AliHLTOUTRawReader::Reset()
 {
-  // see header file for class documentation
+  // overloaded from AliHLTOUTHomerCollection: reset DDL position
   if (fpRawreader) return fpRawreader->Reset();
   return 0;
 }
 
 int AliHLTOUTRawReader::GetDataSize()
 {
-  // see header file for class documentation
+  // overloaded from AliHLTOUTHomerCollection: get size of current DDL
   if (fpRawreader) return fpRawreader->GetDataSize();
   return 0;
 }
 
 const AliRawDataHeader* AliHLTOUTRawReader::GetDataHeader()
 {
-  // see header file for class documentation
+  // overloaded from AliHLTOUTHomerCollection: get data header of current DDL
   if (fpRawreader) return fpRawreader->GetDataHeader();
   return NULL;
 }
 
 void AliHLTOUTRawReader::SelectEquipment(int equipmentType, int minEquipmentId, int maxEquipmentId)
 {
-  // see header file for class documentation
+  // overloaded from AliHLTOUTHomerCollection: select equipment range
   if (fpRawreader) fpRawreader->SelectEquipment(equipmentType, minEquipmentId, maxEquipmentId);
 }
 
 int AliHLTOUTRawReader::GetEquipmentId()
 {
-  // see header file for class documentation
+  // overloaded from AliHLTOUTHomerCollection: get id of current DDL
   if (fpRawreader) return fpRawreader->GetEquipmentId();
   return -1;
 }
index 16eaf47..e2db4e9 100644 (file)
@@ -1,17 +1,17 @@
 //-*- Mode: C++ -*-
-// @(#) $Id$
+// $Id$
 
 #ifndef ALIHLTOUTRAWREADER_H
 #define ALIHLTOUTRAWREADER_H
-//* This file is property of and copyright by the ALICE HLT Project        * 
+//* This file is property of and copyright by the                          * 
 //* ALICE Experiment at CERN, All rights reserved.                         *
-//* See cxx source for full Copyright notice                               */
+//* See cxx source for full Copyright notice                               *
 
-/** @file   AliHLTOUTRawReader.h
-    @author Matthias Richter
-    @date   
-    @brief  HLTOUT data wrapper for AliRawReader.
-*/
+/// @file   AliHLTOUTRawReader.h
+/// @author Matthias Richter
+/// @date   
+/// @brief  HLTOUT data wrapper for AliRawReader.
+///
 
 #include "AliHLTOUTHomerCollection.h"