X-Git-Url: http://git.uio.no/git/?a=blobdiff_plain;f=HLT%2FBASE%2FAliHLTHOMERSourceDesc.h;h=7448e1baf0c71d872eaf42d3a2815d21741f86c4;hb=af7313f46d88d3c1c7a18ebe38e3915009d259a6;hp=f1078c1675f54d0eb6c972c77f71eb482470513c;hpb=1a04dcdedb97c7626cb0982fa03e8b5bfc847d27;p=u%2Fmrichter%2FAliRoot.git

diff --git a/HLT/BASE/AliHLTHOMERSourceDesc.h b/HLT/BASE/AliHLTHOMERSourceDesc.h
index f1078c1675f..7448e1baf0c 100644
--- a/HLT/BASE/AliHLTHOMERSourceDesc.h
+++ b/HLT/BASE/AliHLTHOMERSourceDesc.h
@@ -1,4 +1,5 @@
 //-*- Mode: C++ -*-
+// $Id$
 #ifndef ALIHLTHOMERSOURCEDESC_H
 #define ALIHLTHOMERSOURCEDESC_H
 
@@ -18,6 +19,12 @@
 // or
 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
 
+/**
+ * @defgroup alihlt_homer HOMER handling for AliROOT
+ * This section describes the handling of HOMER Sources, Blocks 
+ * and the HOMER Reader inside the HLT and AliROOT
+ */
+
 #include "TString.h"
 #include "TNamed.h"
 
@@ -35,18 +42,18 @@ class AliHLTHOMERSourceDesc : public TNamed {
 
 public:
 
-  /** standard constructor */
+  /**  constructor */
   AliHLTHOMERSourceDesc();       
 
-  /** constructor 
-   * @param hostname   hostname of the source
-   * @param port       port of the source
-   */
-  AliHLTHOMERSourceDesc( TString hostname, Int_t port );
-
   /** destructor */
   virtual ~AliHLTHOMERSourceDesc();
 
+  /*
+   * ---------------------------------------------------------------------------------
+   *                        Selection - public
+   * ---------------------------------------------------------------------------------
+   */
+
   // -- SELECTION --
 
   /** Set selection state
@@ -56,128 +63,127 @@ public:
 
   /** Checks if Source is selected to readout 
    * @return           returns state, either kTRUE or kFALSE
-  */
-  Bool_t IsSelected() { return fSelected; }
+   */
+  Bool_t IsSelected()           { return fSelected; }
 
   /** Select this source */
-  void Select() { fSelected = kTRUE; }
-
+  void Select()                 { fSelected = kTRUE; }
+  
   /** Deselect this source */
-  void Deselect() { fSelected = kFALSE; }
-
-  // -- SETTER --
+  void Deselect()               { fSelected = kFALSE; }
 
-  /** Set node name of this source 
-   * @param hostname   hostname of the source
-   * @param port       port of the source
+  /*
+   * ---------------------------------------------------------------------------------
+   *                        Setter - public
+   * ---------------------------------------------------------------------------------
    */
-   void SetHostnamePort( TString hostname, Int_t port ) { fHostname = hostname; fPort = port; }
 
-  /** Set name/obj name of this source 
-   *  @param s1        source name
-   *  @param s2        source class name, default is ""
+  /** Set Service of this source 
+   *  @param hostname  hostname of the source
+   *  @param port      port of the source
+   *  @param origin    HLT data origin
+   *  @param type      HLT data type
+   *  @param spec      HLT data specification
    */
-  void SetSourceName( TString s1, TString s2="" ) { fSourceName = s1; fClassName = s2; }
+  void SetService( TString hostname, Int_t port, TString origin, 
+		   TString type, TString spec );
 
-  /** Set detector, sub detector and sub sub detector of this source 
-   *  @param s1        detector name
-   *  @param s2        subdetector name
-   *  @param s3        subsubdetector name
+  /*
+   * ---------------------------------------------------------------------------------
+   *                        Getter - public
+   * ---------------------------------------------------------------------------------
    */
-  void SetDetectors( TString s1, TString s2, TString s3 ) { fDetector = s1; fSubDetector = s2; fSubSubDetector = s3; }
-
-  /** Set HLT specification anf HLT data type of this source 
-   *  @param ul        HLT specification
-   *  @param s         HLT data type
-   */
-  void SetSourceType( ULong_t ul, TString s ) { fSpecification = ul, fDataType = s; }
-
-  // -- GETTER --
 
   /** Get node name of this source 
    * @return           hostname
    */
-  TString GetHostname() { return fHostname; }
+  TString& GetHostname()       { return fHostname; }
 
   /** Get node name of this source 
    * @return           port
    */
-  Int_t GetPort() { return fPort; }
+  Int_t   GetPort()           { return fPort; }
 
   /** Get name of this source 
    * @return           name
    */
-  TString GetSourceName() { return fSourceName; }
-
-  /** Get object name of this source
-   * @return           class name
-   */
-  TString GetClassName() { return fClassName; }
+  TString& GetSourceName()     { return fSourceName; }
 
   /** Get detector of this source 
    * @return           detector
    */
-  TString GetDetector() { return fDetector; }
+  TString& GetDetector()       { return fDetector; }
 
   /** Get sub detector of this source 
    * @return           subdetector
    */
-  TString GetSubDetector() { return fSubDetector; }
+  Int_t   GetSubDetector()    { return fSubDetector; }
 
   /** Get sub sub detector of this source 
    * @return           subsubdetector
    */
-  TString GetSubSubDetector() { return fSubSubDetector; }
+  Int_t   GetSubSubDetector() { return fSubSubDetector; }
 
   /** Get HLT data type of this source
    * @return           HLT data type
    */
-  TString GetDataType() { return fDataType; }
+  TString& GetDataType()       { return fDataType; }
 
   /** Get HLT specification of this source
    * @return           HLT specification
    */
-  ULong_t GetSpecification() { return fSpecification; }
+  ULong_t GetSpecification()  { return fSpecification; }
 
+  ///////////////////////////////////////////////////////////////////////////////////
 
 private:
+
   /** copy constructor prohibited */
   AliHLTHOMERSourceDesc(const AliHLTHOMERSourceDesc&);
   
   /** assignment operator prohibited */
   AliHLTHOMERSourceDesc& operator=(const AliHLTHOMERSourceDesc&);
 
+  /*
+   * ---------------------------------------------------------------------------------
+   *                            Members - private
+   * ---------------------------------------------------------------------------------
+   */
+
   /** is selected to read out */
   Bool_t fSelected;             // see above
 
+  /** Name of Source */
+  TString fSourceName;          // see above
+
+  // -- Service Specifications --
+  // ----------------------------
+
   /** Name of HOMER Node */
   TString fHostname;            // see above
 
   /** Name of HOMER port */
   Int_t fPort;                  // see above
 
-  /** Name of Source */
-  TString fSourceName;          // see above
+  // -- Data Specifications --
+  // -------------------------
 
-  /** Object Name of Source */
-  TString fClassName;           // see above
+  /** HLT DataType */
+  TString fDataType;            // see above
 
   /** Detector Name, e.g. PHOS 
    *  corresponds to HLT origin
    */
   TString fDetector;            // see above
 
-  /** SubDetector Name e.g. MODULE */
-  TString fSubDetector;         // see above
-
-  /** SubSubDetector Name e.g. PARTITION */
-  TString fSubSubDetector;      // see above
-
   /** HLT Specification */
   ULong_t fSpecification;       // see above
 
-  /** HLT DataType */
-  TString fDataType;            // see above
+  /** SubDetector Name e.g. MODULE */
+  Int_t   fSubDetector;         // see above
+
+  /** SubSubDetector Name e.g. PARTITION */
+  Int_t   fSubSubDetector;      // see above
 
   ClassDef( AliHLTHOMERSourceDesc, 0 )
 };