Coding conventions
authorpostrow <postrow@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 18 Mar 2010 17:19:23 +0000 (17:19 +0000)
committerpostrow <postrow@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 18 Mar 2010 17:19:23 +0000 (17:19 +0000)
EPOS/AliGenEpos.cxx
EPOS/AliGenEpos.h
EPOS/AliGenEposIsajetToPdgConverter.cxx
EPOS/AliGenEposIsajetToPdgConverter.h
EPOS/TEpos.cxx
EPOS/TEpos.h
EPOS/eposproc.h

index ed994f1..7e4cfb6 100644 (file)
@@ -1,11 +1,11 @@
-/*
- * AliGenEpos.cxx
- *
- *  ALICE event generator based on EPOS model from Klaus Werner
- *
- *  Created on: Feb 28, 2009
- *      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
- */
+//
+// AliGenEpos.cxx
+//
+//  ALICE event generator based on EPOS model from Klaus Werner
+//
+//  Created on: Feb 28, 2009
+//      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
+//
 
 #include "AliGenEpos.h"
 #include "TEpos.h"
@@ -36,6 +36,7 @@ AliGenEpos::AliGenEpos(Int_t npart) : AliGenMC(npart),
 }
 
 void AliGenEpos::Init() {
+  // Sets up TEpos
        AliGenMC::Init();
        TEpos *epos = GetTEpos();
        epos->SetLaproj(this->fZProjectile);
@@ -52,6 +53,7 @@ void AliGenEpos::Init() {
 }
 
 void AliGenEpos::Generate() {
+  // Does actual generation and output conversion
          Float_t polar[3]   =   {0,0,0};
          Float_t origin0[3]  =   {0,0,0};
          Float_t origin[3]   =   {0,0,0};
index 6957a7f..78a03f4 100644 (file)
@@ -1,18 +1,19 @@
-/*
- * AliGenEpos.cpp
- *
- *  ALICE event generator based on EPOS model from Klaus Werner
- *
- *  Created on: Feb 28, 2009
- *      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
- */
-
-#ifndef ALIGENEPOS_H_
-#define ALIGENEPOS_H_
+//
+// AliGenEpos.cpp
+//
+//  ALICE event generator based on EPOS model from Klaus Werner
+//
+//  Created on: Feb 28, 2009
+//      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
+//
+
+#ifndef ALI_GEN_EPOS_H
+#define ALI_GEN_EPOS_H
 
 #include "AliGenMC.h"
 #include "TEpos.h"
 
+
 class AliGenEpos: public AliGenMC {
 public:
        AliGenEpos();
@@ -26,13 +27,13 @@ public:
        void SetReactionPlaneAngleRange(Float_t phimin, Float_t phimax) { fPhiMin = phimin; fPhiMax = phimax; }
        void AddNoDecay(Int_t nodecay) { GetTEpos()->AddNoDecay(nodecay); }
        void AddExtraInputLine(const char *line) { GetTEpos()->AddExtraInputLine(line); }
-       Float_t GetPhiMin() { return fPhiMin; }
-       Float_t GetPhiMax() { return fPhiMax; }
-       Float_t GetBmin() { return fBmin; }
-       Float_t GetBMax() { return fBmax; }
+       Float_t GetPhiMin() const { return fPhiMin; }
+       Float_t GetPhiMax() const { return fPhiMax; }
+       Float_t GetBmin() const { return fBmin; }
+       Float_t GetBMax() const { return fBmax; }
 
        void FilterModelOutput(Bool_t value) {fFilterModelOutput = value;}
-       Bool_t IsModelOutputFiltered() { return fFilterModelOutput; }
+       Bool_t IsModelOutputFiltered() const { return fFilterModelOutput; }
 protected:
        virtual TEpos* GetTEpos() { return (TEpos *)fMCEvGen; }
 
@@ -48,4 +49,4 @@ private:
        ClassDef(AliGenEpos,1)
 };
 
-#endif /* ALIGENEPOS_H_ */
+#endif /* ALI_GEN_EPOS_H */
index fbee5f6..ae00327 100644 (file)
@@ -1,20 +1,19 @@
-/*
- * AliGenEposIsajetToPdgConverter.cxx
- *
- *  Helper class used by TEpos to insert EPOS internal objects and higher
- *  resonances to PDG database.
- *  Quark clusters has has unaltered code, unknown objects have code of
- *  form 6xxxxxxxx, and higher resonances have codes from Particle Physics
- *  Review '96
- *
- *  Created on: Aug 03, 2009
- *      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
- */
+//
+// AliGenEposIsajetToPdgConverter.cxx
+//
+//  Helper class used by TEpos to insert EPOS internal objects and higher
+//  resonances to PDG database.
+//  Quark clusters has has unaltered code, unknown objects have code of
+//  form 6xxxxxxxx, and higher resonances have codes from Particle Physics
+//  Review '96
+//
+//  Created on: Aug 03, 2009
+//      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
+//
 
 
 #include "TDatabasePDG.h"
 #include "AliGenEposIsajetToPdgConverter.h"
-#include "stdio.h"
 
 ClassImp(AliGenEposIsajetToPdgConverter)
 
@@ -24,8 +23,9 @@ AliGenEposIsajetToPdgConverter::AliGenEposIsajetToPdgConverter() {
 
 AliGenEposIsajetToPdgConverter::~AliGenEposIsajetToPdgConverter() { }
 
-Int_t AliGenEposIsajetToPdgConverter::ConvertIsajetToPdg(Int_t isajet) {
-       if (!sfParticlesAdded) {
+Int_t AliGenEposIsajetToPdgConverter::ConvertIsajetToPdg(Int_t isajet) const{
+  // Perform code conversion, init PDG if first time called
+       if (!fgParticlesAdded) {
                AddHigherResonances();
        }       
        TDatabasePDG *pdgDb = TDatabasePDG::Instance();
@@ -45,19 +45,21 @@ Int_t AliGenEposIsajetToPdgConverter::ConvertIsajetToPdg(Int_t isajet) {
        }
        
        if (pdg == 0) {
-               printf("TEpos: Warning, unknown particle, ISAJET: %d\n",isajet);
+               Printf("TEpos: Warning, unknown particle, ISAJET: %d\n",isajet);
        }
        return pdg;
 }
 
-void AliGenEposIsajetToPdgConverter::AddQuarkCluster(Int_t clusterCode) {
+void AliGenEposIsajetToPdgConverter::AddQuarkCluster(Int_t clusterCode) const {
+  // Add EPOS internal object to the PDG db
        TDatabasePDG *pdgDb = TDatabasePDG::Instance();
        if(!pdgDb->GetParticle(clusterCode)) {
                pdgDb->AddParticle("Quark cluster", "Quark cluster", 0.0, kFALSE, 0, 0, "EPOS Quark cluster", clusterCode);
        }
 }
 
-Int_t AliGenEposIsajetToPdgConverter::AddUnknownObject(Int_t code) {
+Int_t AliGenEposIsajetToPdgConverter::AddUnknownObject(Int_t code) const {
+  // Add EPOS internal object to the PDG db
        Int_t newCode = 600000000 + code;
        TDatabasePDG *pdgDb = TDatabasePDG::Instance();
        if(!pdgDb->GetParticle(newCode)) {
@@ -66,7 +68,8 @@ Int_t AliGenEposIsajetToPdgConverter::AddUnknownObject(Int_t code) {
        return newCode;
 }
 
-Int_t AliGenEposIsajetToPdgConverter::ExtendedMapping(Int_t isajet) {
+Int_t AliGenEposIsajetToPdgConverter::ExtendedMapping(Int_t isajet) const {
+  // Mappings for some internal EPOS objects and resonaces
        Int_t sign = isajet < 0 ? -1 : 1;
        isajet*=sign;
        Int_t retVal = 0;
@@ -116,12 +119,13 @@ Int_t AliGenEposIsajetToPdgConverter::ExtendedMapping(Int_t isajet) {
        return sign*retVal;
 }
 
-Bool_t AliGenEposIsajetToPdgConverter::sfParticlesAdded = kFALSE;
+Bool_t AliGenEposIsajetToPdgConverter::fgParticlesAdded = kFALSE;
 
 void AliGenEposIsajetToPdgConverter::AddHigherResonances() {
-       if(sfParticlesAdded)
+  // Adds higher resonances known by EPOS but not to the PDG
+       if(fgParticlesAdded)
                return;
-       sfParticlesAdded=kTRUE;
+       fgParticlesAdded=kTRUE;
        TDatabasePDG *fPdgDb = TDatabasePDG::Instance();
        //| 332 | F0(975)     |
        fPdgDb->AddAntiParticle("F0_bar", -10221);
index c74889c..ee148d1 100644 (file)
@@ -1,21 +1,21 @@
-/*
- * AliGenEposIsajetToPdgConverter.h
- *
- *  Helper class used by TEpos to insert EPOS internal objects and higher
- *  resonances to PDG database.
- *  Quark clusters has has unaltered code, unknown objects have code of
- *  form 6xxxxxxxx, and higher resonances have codes from Particle Physics
- *  Review '96
- *
- *  Created on: Aug 03, 2009
- *      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
- */
+//
+// AliGenEposIsajetToPdgConverter.h
+//
+//  Helper class used by TEpos to insert EPOS internal objects and higher
+//  resonances to PDG database.
+//  Quark clusters has has unaltered code, unknown objects have code of
+//  form 6xxxxxxxx, and higher resonances have codes from Particle Physics
+//  Review '96
+//
+//  Created on: Aug 03, 2009
+//      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
+//
 
 
-#ifndef ALIGENEPOSISAJETTOPDGCONVERTER_H_
-#define ALIGENEPOSISAJETTOPDGCONVERTER_H_
+#ifndef ALI_GEN_EPOS_ISAJET_TO_PDG_CONVERTER_H
+#define ALI_GEN_EPOS_ISAJET_TO_PDG_CONVERTER_H
 
-#include <TROOT.h>
+#include <Rtypes.h>
 
 class TDatabasePDG;
 
@@ -24,19 +24,19 @@ class AliGenEposIsajetToPdgConverter
 public:
        AliGenEposIsajetToPdgConverter();
        
-       Int_t ConvertIsajetToPdg(Int_t isajet);
+       Int_t ConvertIsajetToPdg(Int_t isajet) const;
 
        virtual ~AliGenEposIsajetToPdgConverter();
        static void AddHigherResonances();
 
 private:
-       Int_t ExtendedMapping(Int_t isajet);
-       void AddQuarkCluster(Int_t clusterCode);
-       Int_t AddUnknownObject(Int_t code);
+       Int_t ExtendedMapping(Int_t isajet) const;
+       void AddQuarkCluster(Int_t clusterCode) const ;
+       Int_t AddUnknownObject(Int_t code) const;
 
-       static Bool_t sfParticlesAdded; //flag indicating that resonances
+       static Bool_t fgParticlesAdded; //flag indicating that resonances
                                        // have been alredy inserted
        ClassDef(AliGenEposIsajetToPdgConverter,1)
 };
 
-#endif /* ALIGENEPOSISAJETTOPDGCONVERTER_H_ */
+#endif /* ALI_GEN_EPOS_ISAJET_TO_PDG_CONVERTER_H */
index 3856701..343dccc 100644 (file)
@@ -1,18 +1,18 @@
-/*
- *###################################################################
- *#        EPOS 1.67     K. WERNER, T. PIEROG, S. PORTEBOEUF.       #
- *#                      Contact: werner@subatech.in2p3.fr          #
- *###################################################################
- *
- * TEpos.cxx
- * 
- * Wraper class for interfacing EPOS model, derived from ROOT's TGenerator.
- * It generates temporary input file for the model, providing user with
- * ability to add his/hers own lines to the input.
- * Output is read directly from common blocks.
- *
- *      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
- */
+//
+//###################################################################
+//#        EPOS 1.67     K. WERNER, T. PIEROG, S. PORTEBOEUF.       #
+//#                      Contact: werner@subatech.in2p3.fr          #
+//###################################################################
+//
+// TEpos.cxx
+// 
+// Wraper class for interfacing EPOS model, derived from ROOT's TGenerator.
+// It generates temporary input file for the model, providing user with
+// ability to add his/hers own lines to the input.
+// Output is read directly from common blocks.
+//
+//      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
+//
 
 
 #include <TClonesArray.h>
@@ -76,6 +76,7 @@ TEpos::~TEpos() {
 }
 
 TEpos& TEpos::operator=(const TEpos&) {
+  //operator=
        if (!fIdConverter) {
                fIdConverter = new AliGenEposIsajetToPdgConverter();
        }
@@ -83,6 +84,7 @@ TEpos& TEpos::operator=(const TEpos&) {
 }
 
 void TEpos::Initialize() {
+  // Generates input file and prepares EPOS to read from it.
        Int_t nopeno = 0;
        GenerateInputFile();
        aaset(0);
@@ -115,6 +117,7 @@ void TEpos::GenerateEvent() {
 }
 
 Int_t TEpos::ImportParticles(TClonesArray *particles, Option_t *) {
+  //Fills provided ClonesArray with generated particles
        particles->Clear();
        if (!cevt.nevt) return 0;
        Int_t numpart = cptl.nptl;
@@ -141,6 +144,7 @@ Int_t TEpos::ImportParticles(TClonesArray *particles, Option_t *) {
 }
 
 TObjArray*  TEpos::ImportParticles(Option_t *) {
+  //Creates new particle array
        fParticles->Clear();
        if (!cevt.nevt) return NULL;
        Int_t numpart = cptl.nptl;
@@ -176,6 +180,7 @@ void TEpos::AddExtraInputLine(const char *line) {
 }
 
 void TEpos::GenerateInputFile() {
+  // Generate input file in EPOS format
        ofstream file(GetInputFileName(), ios_base::out | ios_base::trunc);
        char epo[256];
        char *epoEnv = getenv("EPO");
index 2ec6f32..4a504b7 100644 (file)
@@ -1,18 +1,18 @@
-/*
- *###################################################################
- *#        EPOS 1.67     K. WERNER, T. PIEROG, S. PORTEBOEUF.       #
- *#                      Contact: werner@subatech.in2p3.fr          #
- *###################################################################
- *
- * TEpos.h
- * 
- * Wraper class for interfacing EPOS model, derived from ROOT's TGenerator.
- * It generates temporary input file for the model, providing user with
- * ability to add his/hers own lines to the input.
- * Output is read directly from common blocks.
- *
- *      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
- */
+//
+//###################################################################
+//#        EPOS 1.67     K. WERNER, T. PIEROG, S. PORTEBOEUF.       #
+//#                      Contact: werner@subatech.in2p3.fr          #
+//###################################################################
+//
+// TEpos.h
+// 
+// Wraper class for interfacing EPOS model, derived from ROOT's TGenerator.
+// It generates temporary input file for the model, providing user with
+// ability to add his/hers own lines to the input.
+// Output is read directly from common blocks.
+//
+//      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
+//
 
 
 #ifndef TEPOS_H
index c9b9c9d..7cdd552 100644 (file)
@@ -1,15 +1,15 @@
-/*
- *###################################################################
- *#        EPOS 1.67     K. WERNER, T. PIEROG, S. PORTEBOEUF.       #
- *#                      Contact: werner@subatech.in2p3.fr          #
- *###################################################################
- *
- * eposproc.h
- * 
- * Definitions of EPOS subroutines used in the interface.
- *
- *      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
- */
+//
+//###################################################################
+//#        EPOS 1.67     K. WERNER, T. PIEROG, S. PORTEBOEUF.       #
+//#                      Contact: werner@subatech.in2p3.fr          #
+//###################################################################
+//
+// eposproc.h
+// 
+// Definitions of EPOS subroutines used in the interface.
+//
+//      Author: Piotr Ostrowski, postrow@if.pw.edu.pl
+//
 
 
 #ifndef ROOT_Eposproc