Added comments.
authorrsilva <rsilva@f7af4fe6-9843-0410-8265-dc069ae4e863>
Mon, 23 Jul 2007 12:50:58 +0000 (12:50 +0000)
committerrsilva <rsilva@f7af4fe6-9843-0410-8265-dc069ae4e863>
Mon, 23 Jul 2007 12:50:58 +0000 (12:50 +0000)
STEER/AliSurveyPoint.cxx
STEER/AliSurveyPoint.h

index 9d30c49..85ad5c3 100644 (file)
@@ -15,7 +15,7 @@
 
 /////////////////////////////////////////////////////////////////////
 //                                                                 //
-//  class AliSurveyPoint                                                  //
+//  class AliSurveyPoint                                          //
 //  Retrieve and Convert survey data into ROOT Objects            //
 //                                                                 //
 /////////////////////////////////////////////////////////////////////
@@ -36,7 +36,7 @@ AliSurveyPoint::AliSurveyPoint():
   fType(' '),
   fTargetUsed(kTRUE)
 {
-  // constructor
+  // Constructor
   
 }
 
@@ -54,7 +54,7 @@ AliSurveyPoint::AliSurveyPoint(TString name, Float_t x, Float_t y,
   fType(type),
   fTargetUsed(Target)
 {
-  //constructor
+  // Constructor
   
 }
 
@@ -66,6 +66,7 @@ AliSurveyPoint::~AliSurveyPoint() {
 
 //_____________________________________________________________________________
 void AliSurveyPoint::PrintPoint() {
+  // Prints X, Y and Z coordinates of the point
   printf("Point Coordinates \"%s\": %f %f %f\n", (const char*) fPointName, fX, fY, fZ);
   return;
 }
index fd74dfa..36c3440 100644 (file)
@@ -23,30 +23,32 @@ class AliSurveyPoint: public TObject {
                  Char_t type, Bool_t Target);
   virtual ~AliSurveyPoint();
   
-  TString GetPointName() {return fPointName;};
-  Float_t GetX() {return fX;};
-  Float_t GetY() {return fY;};
-  Float_t GetZ() {return fZ;};
-  Float_t GetPrecisionX() {return fPrecisionX;};
-  Float_t GetPrecisionY() {return fPrecisionY;};
-  Float_t GetPrecisionZ() {return fPrecisionZ;};
-  Char_t GetType() {return fType;};
-  Bool_t GetTarget() {return fTargetUsed;};
-  
+  TString GetPointName() const {return fPointName;};
+  Float_t GetX() const {return fX;};
+  Float_t GetY() const {return fY;};
+  Float_t GetZ() const {return fZ;};
+  Float_t GetPrecisionX() const {return fPrecisionX;};
+  Float_t GetPrecisionY() const {return fPrecisionY;};
+  Float_t GetPrecisionZ() const {return fPrecisionZ;};
+  Char_t GetType() const {return fType;};
+  Bool_t GetTarget() const {return fTargetUsed;};
+
+  // Overwritten to enable the use of TObjArray::FindObject()
   virtual const char* GetName() const {return fPointName.Data();}; 
 
   void PrintPoint();
   
  private:
-  TString fPointName;
-  Float_t fX;
-  Float_t fY;
-  Float_t fZ;
-  Float_t fPrecisionX;
-  Float_t fPrecisionY;
-  Float_t fPrecisionZ;
-  Char_t fType;
-  Bool_t fTargetUsed;
+  TString fPointName; // Point name used by the survey group (TS/SU)
+  Float_t fX; // X Coordinate
+  Float_t fY; // Y Coordinate
+  Float_t fZ; // Z Coordinate
+  Float_t fPrecisionX; // Precision in the X axis
+  Float_t fPrecisionY; // Precision in the Y axis
+  Float_t fPrecisionZ; // Precision in the Z axis
+  Char_t fType; // Type of point: M(easured), T(ransformed)
+  Bool_t fTargetUsed; // Was a survey target used to measure this point?
+                      // If yes, the user must take that into account
   
   ClassDef(AliSurveyPoint, 1);
 };