coding conventions

diff --git a/HLT/SampleLib/AliHLTDummyComponent.cxx b/HLT/SampleLib/AliHLTDummyComponent.cxx
index f7e97269d3e1f73af4054c944400cf0201348549..aec502235e8d24a60326a1f23fd8ffba0b30b786 100644 (file)
--- a/HLT/SampleLib/AliHLTDummyComponent.cxx
+++ b/HLT/SampleLib/AliHLTDummyComponent.cxx
@@ -22,6 +22,12 @@
     @date   
     @brief  A dummy processing component for the HLT. */
 
+// see header file for class documentation
+// or
+// refer to README to build package
+// or
+// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+
 #if __GNUC__ >= 3
 using namespace std;
 #endif

diff --git a/HLT/SampleLib/AliHLTDummyComponent.h b/HLT/SampleLib/AliHLTDummyComponent.h
index 41f98223de5ba12fba857bb39bdfffce38fcdf8c..1b1638645c5454b5c888cf4c7bb0c05542b78a5e 100644 (file)
--- a/HLT/SampleLib/AliHLTDummyComponent.h
+++ b/HLT/SampleLib/AliHLTDummyComponent.h
@@ -10,6 +10,11 @@
     @date   
     @brief  Declaration of a dummy component. */
 
+// see below for class documentation
+// or
+// refer to README to build package
+// or
+// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
 
 #include "AliHLTProcessor.h"
 

diff --git a/HLT/TPCLib/AliHLTTPCAgent.cxx b/HLT/TPCLib/AliHLTTPCAgent.cxx
index 7e4085a122136c956f33b85d19591819d99198cc..230b632a1d2bf6bace4bf6b2cdd1afb99fdee1bf 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCAgent.cxx
+++ b/HLT/TPCLib/AliHLTTPCAgent.cxx
@@ -31,6 +31,7 @@ AliHLTTPCAgent gAliHLTTPCAgent;
 // component headers
 #include "AliHLTAltroChannelSelectorComponent.h"
 #include "AliHLTTPCDigitDumpComponent.h"
+#include "AliHLTTPCEsdWriterComponent.h"
 
 /** ROOT macro for the implementation of ROOT specific class methods */
 ClassImp(AliHLTTPCAgent)
@@ -120,5 +121,8 @@ int AliHLTTPCAgent::RegisterComponents(AliHLTComponentHandler* pHandler) const
   if (!pHandler) return -EINVAL;
   pHandler->AddComponent(new AliHLTAltroChannelSelectorComponent);
   pHandler->AddComponent(new AliHLTTPCDigitDumpComponent);
+  pHandler->AddComponent(new AliHLTTPCEsdWriterComponent::AliWriter);
+  pHandler->AddComponent(new AliHLTTPCEsdWriterComponent::AliConverter);
+
   return 0;
 }

diff --git a/HLT/TPCLib/AliHLTTPCDigitReader.cxx b/HLT/TPCLib/AliHLTTPCDigitReader.cxx
index 2802a6828b1c870e1290354ed2754fb339babe00..ded7b76db78d907db138d03b33739c0b257b701d 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCDigitReader.cxx
+++ b/HLT/TPCLib/AliHLTTPCDigitReader.cxx
@@ -24,6 +24,12 @@
     @brief  An abstract reader class for TPC 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
+
 #if __GNUC__>= 3
 using namespace std;
 #endif
@@ -40,14 +46,21 @@ AliHLTTPCDigitReader::AliHLTTPCDigitReader()
   fLckRow(-1),
   fLckPad(-1)
 {
+  // see header file for class documentation
+  // or
+  // refer to README to build package
+  // or
+  // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
 }
 
 AliHLTTPCDigitReader::~AliHLTTPCDigitReader()
 {
+  // see header file for class documentation
 }
 
 int AliHLTTPCDigitReader::InitBlock(void* ptr,unsigned long size,Int_t firstrow,Int_t lastrow, Int_t patch, Int_t slice)
 {
+  // see header file for class documentation
   if (patch<0 || patch>=AliHLTTPCTransform::GetNumberOfPatches()) {
     HLTError("invalid readout partition number %d", patch);
     return -EINVAL;
@@ -65,12 +78,17 @@ int AliHLTTPCDigitReader::InitBlock(void* ptr,unsigned long size,Int_t firstrow,
 
 void AliHLTTPCDigitReader::SetOldRCUFormat(Bool_t /*oldrcuformat*/)
 {
+  // default method of the base class
 }
-void AliHLTTPCDigitReader::SetUnsorted(Bool_t /*unsorted*/){
+
+void AliHLTTPCDigitReader::SetUnsorted(Bool_t /*unsorted*/)
+{
+  // default method of the base class
 }
 
 bool AliHLTTPCDigitReader::Next()
 {
+  // see header file for class documentation
   if (!CheckFlag(kLocked)) return NextSignal();
 
   bool haveData=false;
@@ -87,12 +105,14 @@ bool AliHLTTPCDigitReader::Next()
 
 void AliHLTTPCDigitReader::EnableCaching(bool bCache)
 {
+  // see header file for class documentation
   if (bCache) SetFlag(kChannelCaching);
   else ClearFlag(kChannelCaching);
 }
 
 int AliHLTTPCDigitReader::RewindChannel()
 {
+  // see header file for class documentation
   int iResult=0;
   
   return iResult;
@@ -100,11 +120,13 @@ int AliHLTTPCDigitReader::RewindChannel()
 
 unsigned int AliHLTTPCDigitReader::SetFlag(unsigned int flag)
 {
+  // see header file for class documentation
   return fFlags|=flag;
 }
        
 unsigned int AliHLTTPCDigitReader::ClearFlag(unsigned int flag)
 {
+  // see header file for class documentation
   return fFlags&=~flag;
 }
 
@@ -115,6 +137,7 @@ unsigned int AliHLTTPCDigitReader::ClearFlag(unsigned int flag)
 
 int AliHLTTPCDigitReader::RewindCurrentChannel()
 {
+  // see header file for class documentation
   SetFlag(kNoRewind);
   if (!CheckFlag(kChannelCaching)) return -ENODATA;
   return -ENOSYS;
@@ -122,6 +145,7 @@ int AliHLTTPCDigitReader::RewindCurrentChannel()
 
 int AliHLTTPCDigitReader::RewindToPrevChannel()
 {
+  // see header file for class documentation
   SetFlag(kNoRewind);
   if (!CheckFlag(kChannelCaching)) return -ENODATA;
   return -ENOSYS;

diff --git a/HLT/TPCLib/AliHLTTPCDigitReader.h b/HLT/TPCLib/AliHLTTPCDigitReader.h
index 948993894b6ff438df289ce3be6ca3138ed16291..8602f09fe7a4b1f4cc2a4a6ad621159575645b2f 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCDigitReader.h
+++ b/HLT/TPCLib/AliHLTTPCDigitReader.h
@@ -14,6 +14,12 @@
     @brief  An abstract reader class for TPC data.
 */
 
+// see below for class documentation
+// or
+// refer to README to build package
+// or
+// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+
 #include "AliHLTLogging.h"
 #include "TObject.h"
 
@@ -183,7 +189,7 @@ protected:
   /**
    * Check a status flag of the reader.
    */
-  inline int CheckFlag(unsigned int flag) {return (fFlags&flag)!=0;}
+  int CheckFlag(unsigned int flag) const {return (fFlags&flag)!=0;}
 
   /**
    * Rewind to the beginning.of the current channel.

diff --git a/HLT/TPCLib/AliHLTTPCEsdWriterComponent.cxx b/HLT/TPCLib/AliHLTTPCEsdWriterComponent.cxx
index 7148724f253b4b785dcd8d05c2e1f6a18cc40f72..00ab9fb4db267904d82a3aa05f2fbcd0d9703401 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCEsdWriterComponent.cxx
+++ b/HLT/TPCLib/AliHLTTPCEsdWriterComponent.cxx
@@ -23,6 +23,12 @@
             mapping tracker in the AliESD 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
+
 #include <cassert>
 #include "AliHLTTPCEsdWriterComponent.h"
 #include "AliESDEvent.h"
@@ -34,10 +40,6 @@
 #include "AliHLTTPCDefinitions.h"
 #include "AliHLTTPCTransform.h"
 
-/** global instance for component registration */
-AliHLTTPCEsdWriterComponent::AliWriter gTPCEsdWriter;
-AliHLTTPCEsdWriterComponent::AliConverter gTPCEsdConverter;
-
 /** ROOT macro for the implementation of ROOT specific class methods */
 ClassImp(AliHLTTPCEsdWriterComponent)
 

diff --git a/HLT/TPCLib/AliHLTTPCEsdWriterComponent.h b/HLT/TPCLib/AliHLTTPCEsdWriterComponent.h
index b477ff977e84f9285677f3e89177383a76904509..a729be707014e11d7fd0ef333189fe89bd0580e5 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCEsdWriterComponent.h
+++ b/HLT/TPCLib/AliHLTTPCEsdWriterComponent.h
@@ -12,6 +12,12 @@
             mapping tracker in the AliESD format
 
                                                                           */
+// see below for class documentation
+// or
+// refer to README to build package
+// or
+// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+
 #include "AliHLTRootFileWriterComponent.h"
 #include "AliHLTProcessor.h"
 
@@ -83,7 +89,7 @@ class AliHLTTPCEsdWriterComponent : public AliHLTLogging
   /** standard constructor */
   AliWriter();
   /** destructor */
-  ~AliWriter();
+  virtual ~AliWriter();
 
   /**
    * The id of the component.
@@ -108,9 +114,9 @@ class AliHLTTPCEsdWriterComponent : public AliHLTLogging
    * @param blocks        input data block descriptors
    * @param trigData     trigger data structure
    */
-  virtual int DumpEvent( const AliHLTComponentEventData& evtData,
-                        const AliHLTComponentBlockData* blocks, 
-                        AliHLTComponentTriggerData& trigData );
+  int DumpEvent( const AliHLTComponentEventData& evtData,
+                const AliHLTComponentBlockData* blocks, 
+                AliHLTComponentTriggerData& trigData );
 
   using AliHLTRootFileWriterComponent::DumpEvent;
 
@@ -164,7 +170,7 @@ class AliHLTTPCEsdWriterComponent : public AliHLTLogging
     /** standard constructor */
     AliConverter();
     /** destructor */
-    ~AliConverter();
+    virtual ~AliConverter();
 
     // interface methods of base class
     const char* GetComponentID() {return "TPCEsdConverter";};