From f5671fc357babd23eb22665ca6f7588f8c611425 Mon Sep 17 00:00:00 2001 From: ivana Date: Thu, 15 Mar 2007 22:51:18 +0000 Subject: [PATCH] Updated/added comments for Doxygen --- MUON/mapping/AliMpArea.h | 3 ++ MUON/mapping/AliMpConnection.cxx | 2 +- MUON/mapping/AliMpConnection.h | 15 ++++++++++ MUON/mapping/AliMpConstants.cxx | 5 ++-- MUON/mapping/AliMpConstants.h | 7 ++++- MUON/mapping/AliMpDEManager.h | 3 ++ MUON/mapping/AliMpFiles.h | 6 ++-- MUON/mapping/AliMpGraphContext.cxx | 4 +-- MUON/mapping/AliMpGraphContext.h | 18 +++++++++++- MUON/mapping/AliMpHelper.cxx | 36 +++++++++++------------ MUON/mapping/AliMpIntPair.h | 12 ++++++++ MUON/mapping/AliMpMotif.h | 2 ++ MUON/mapping/AliMpMotifMap.h | 12 ++++++++ MUON/mapping/AliMpMotifPainter.h | 2 ++ MUON/mapping/AliMpMotifPosition.h | 6 ++++ MUON/mapping/AliMpMotifReader.h | 5 ++++ MUON/mapping/AliMpMotifSpecial.h | 4 +++ MUON/mapping/AliMpMotifType.cxx | 9 +++--- MUON/mapping/AliMpMotifType.h | 12 ++++---- MUON/mapping/AliMpNeighboursPadIterator.h | 7 ++++- MUON/mapping/AliMpPad.h | 18 ++++++++++++ MUON/mapping/AliMpPadIteratorPtr.h | 7 +++-- MUON/mapping/AliMpPadPair.h | 2 ++ MUON/mapping/AliMpPadRow.h | 2 ++ MUON/mapping/AliMpRow.h | 7 +++++ MUON/mapping/AliMpRowPainter.h | 4 ++- MUON/mapping/AliMpRowSegment.h | 2 ++ MUON/mapping/AliMpRowSegmentPainter.h | 2 ++ MUON/mapping/AliMpRowSegmentRSpecial.h | 3 +- MUON/mapping/AliMpSector.h | 17 +++++++++-- MUON/mapping/AliMpSectorPainter.cxx | 8 ++--- MUON/mapping/AliMpSectorPainter.h | 2 ++ MUON/mapping/AliMpSectorReader.cxx | 4 +-- MUON/mapping/AliMpSectorReader.h | 4 ++- MUON/mapping/AliMpSectorSegmentation.cxx | 2 ++ MUON/mapping/AliMpSectorSegmentation.h | 11 +++++-- MUON/mapping/AliMpSegmentation.h | 3 ++ MUON/mapping/AliMpStringObjMap.cxx | 2 +- MUON/mapping/AliMpStringObjMap.h | 2 ++ MUON/mapping/AliMpSubZone.cxx | 2 +- MUON/mapping/AliMpSubZone.h | 4 +++ MUON/mapping/AliMpSubZonePainter.cxx | 8 ++--- MUON/mapping/AliMpSubZonePainter.h | 2 ++ MUON/mapping/AliMpVIndexed.h | 5 ++++ MUON/mapping/AliMpVMotif.h | 13 +++++++- MUON/mapping/AliMpVPadIterator.h | 5 ++++ MUON/mapping/AliMpVPadRowSegment.h | 8 +++++ MUON/mapping/AliMpVPainter.h | 19 ++++++++++++ MUON/mapping/AliMpVRowSegment.h | 31 +++++++++++++++++++ MUON/mapping/AliMpVRowSegmentSpecial.h | 30 ++++++++++++++++++- MUON/mapping/AliMpVSegmentation.h | 22 ++++++++++---- MUON/mapping/AliMpZone.h | 5 ++++ MUON/mapping/AliMpZonePainter.h | 2 ++ 53 files changed, 358 insertions(+), 70 deletions(-) diff --git a/MUON/mapping/AliMpArea.h b/MUON/mapping/AliMpArea.h index f8f054e430c..83c5b8ef84d 100755 --- a/MUON/mapping/AliMpArea.h +++ b/MUON/mapping/AliMpArea.h @@ -58,8 +58,11 @@ ostream& operator << (ostream &stream,const AliMpArea& area); // inline functions + /// Return position inline TVector2 AliMpArea::Position() const { return fPosition; } + /// Return dimensions inline TVector2 AliMpArea::Dimensions() const { return fDimensions; } + /// Return validity inline Bool_t AliMpArea::IsValid() const { return fValidity; } #endif //ALI_MP_AREA_H diff --git a/MUON/mapping/AliMpConnection.cxx b/MUON/mapping/AliMpConnection.cxx index db6e5c317aa..99439103ba4 100755 --- a/MUON/mapping/AliMpConnection.cxx +++ b/MUON/mapping/AliMpConnection.cxx @@ -61,6 +61,6 @@ AliMpConnection::AliMpConnection() //_____________________________________________________________________________ AliMpConnection::~AliMpConnection() { -// +/// Destructor AliDebug(1,Form("this=%p")); } diff --git a/MUON/mapping/AliMpConnection.h b/MUON/mapping/AliMpConnection.h index 3cfb4da552e..578a41b7261 100755 --- a/MUON/mapping/AliMpConnection.h +++ b/MUON/mapping/AliMpConnection.h @@ -29,22 +29,35 @@ class AliMpConnection : public TObject // methods + // // accessors + // + /// Return Berg connector number Int_t GetBergNum() const {return fBergNum;} + /// Return kapton connector number Int_t GetKaptonNum() const {return fKaptonNum;} + /// Return Gassiplex channel number Int_t GetGassiNum() const {return fGassiNum;} + /// Return pad number Int_t GetPadNum() const {return fPadNum;} + /// Return the motif type which contains this connection AliMpMotifType *GetOwner() const {return fOwner;} void SetGassiNum(Int_t n) { fGassiNum = n; } AliMpIntPair LocalIndices() const; TString PadName() const; + + // // modifiers + // + /// Set the motif type which contains this connection void SetOwner(AliMpMotifType *owner) {fOwner=owner;} private: + /// Not implemented AliMpConnection(const AliMpConnection& right); + /// Not implemented AliMpConnection& operator=(const AliMpConnection& right); // data members @@ -59,9 +72,11 @@ class AliMpConnection : public TObject // inline functions + /// Return the pad number converted to a name inline TString AliMpConnection::PadName() const { return fOwner->PadName(fPadNum); } + /// Return the local indices of this pad in the motif inline AliMpIntPair AliMpConnection::LocalIndices() const { return fOwner->FindLocalIndicesByConnection(this);} diff --git a/MUON/mapping/AliMpConstants.cxx b/MUON/mapping/AliMpConstants.cxx index 37db106330e..fc57fb29aca 100755 --- a/MUON/mapping/AliMpConstants.cxx +++ b/MUON/mapping/AliMpConstants.cxx @@ -75,8 +75,7 @@ Bool_t AliMpConstants::IsEqual(const TVector2& v1, const TVector2& v2) Int_t AliMpConstants::ManuMask(AliMp::PlaneType planeType) { - // - // The manuIDs get an offset if they are in the non-bending plane - // +/// The manuIDs get an offset if they are in the non-bending plane + return ( planeType == AliMp::kNonBendingPlane ) ? fgkNonBendingManuMask : 0; } diff --git a/MUON/mapping/AliMpConstants.h b/MUON/mapping/AliMpConstants.h index 8449f171738..93afc7e5cec 100755 --- a/MUON/mapping/AliMpConstants.h +++ b/MUON/mapping/AliMpConstants.h @@ -37,7 +37,7 @@ class AliMpConstants : public TObject static Int_t ManuMask(AliMp::PlaneType planeType); private: - // unused derived functions + /// unused derived functions virtual Bool_t IsEqual(const TObject*) const { return true; } // static data members @@ -54,10 +54,15 @@ class AliMpConstants : public TObject // inline functions + /// Return the length precision for tests inline Double_t AliMpConstants::LengthTolerance() { return fgkLengthTolerance;} + /// Return the step in length used to move from a geometric border inline Double_t AliMpConstants::LengthStep() { return fgkLengthStep;} + /// Return global pad indices start value inline Int_t AliMpConstants::StartPadIndex() { return fgkStartPadIndex;} + /// Return number of chambers inline Int_t AliMpConstants::NofChambers() { return fgkNofChambers;} + /// Return number of geometry modules inline Int_t AliMpConstants::NofGeomModules() { return fgkNofGeomModules;} #endif //ALI_MP_CONSTANTS_H diff --git a/MUON/mapping/AliMpDEManager.h b/MUON/mapping/AliMpDEManager.h index a5d79c3c8e5..e25476b099a 100644 --- a/MUON/mapping/AliMpDEManager.h +++ b/MUON/mapping/AliMpDEManager.h @@ -51,8 +51,11 @@ class AliMpDEManager : public TObject { static Int_t GetNofDEInChamber(Int_t chamberId, Bool_t warn = true); private: + /// Not implemented AliMpDEManager(); + /// Not implemented AliMpDEManager(const AliMpDEManager& rhs); + /// Not implemented AliMpDEManager& operator=(const AliMpDEManager& rhs); // static data members diff --git a/MUON/mapping/AliMpFiles.h b/MUON/mapping/AliMpFiles.h index 304d01a2808..2412fb8992e 100755 --- a/MUON/mapping/AliMpFiles.h +++ b/MUON/mapping/AliMpFiles.h @@ -85,11 +85,13 @@ class AliMpFiles : public TObject static void SetTopPath(const TString& topPath); private: + /// Not implemented AliMpFiles(); + /// Not implemented AliMpFiles(const AliMpFiles& right); - - // operators + /// Not implemented AliMpFiles& operator=(const AliMpFiles& right); + // methods static TString GetTop(); static TString PlaneDataDir(AliMp::StationType station, AliMp::PlaneType plane); diff --git a/MUON/mapping/AliMpGraphContext.cxx b/MUON/mapping/AliMpGraphContext.cxx index c7b75e27a5e..c11bf0e86ee 100755 --- a/MUON/mapping/AliMpGraphContext.cxx +++ b/MUON/mapping/AliMpGraphContext.cxx @@ -115,8 +115,8 @@ void AliMpGraphContext::RealToPad(const TVector2 &position, TVector2 &padPosition, TVector2 &padDimensions) const { - // Transform the real area (position,dimensions) to - // its equivalent pad area + /// Transform the real area (position,dimensions) to + /// its equivalent pad area padPosition = RealToPad(position); padDimensions = diff --git a/MUON/mapping/AliMpGraphContext.h b/MUON/mapping/AliMpGraphContext.h index c50cba0efee..94d79c6d702 100755 --- a/MUON/mapping/AliMpGraphContext.h +++ b/MUON/mapping/AliMpGraphContext.h @@ -33,9 +33,11 @@ class AliMpGraphContext : public TObject { public: #ifdef WITH_STL + /// GraphContextVector type typedef std::vector GraphContextVector; #endif #ifdef WITH_ROOT + /// GraphContextVector type typedef TObjArray GraphContextVector; #endif @@ -44,19 +46,33 @@ class AliMpGraphContext : public TObject void Pop(); static AliMpGraphContext *Instance(); + // // set methods - + // + /// Set position of the pad area where to draw void SetPadPosition(const TVector2 &position){fPadPosition=position;} + /// Set dimensions of the pad area where to draw void SetPadDimensions(const TVector2 &dimensions){fPadDimensions=dimensions;} + /// Set position of the real area where to draw void SetRealPosition(const TVector2 &position){fRealPosition=position;} + /// Set dimensions of the real area where to draw void SetRealDimensions(const TVector2 &dimensions){fRealDimensions=dimensions;} + /// Set color to use void SetColor(Int_t color){fColor=color;} + // // get methods + // + + /// Return position of the pad area where to draw TVector2 GetPadPosition() const {return fPadPosition;} + /// Return dimensions of the pad area where to draw TVector2 GetPadDimensions() const {return fPadDimensions;} + /// Return position of the real area where to draw TVector2 GetRealPosition() const{return fRealPosition;} + /// Return dimensions of the real area where to draw TVector2 GetRealDimensions() const{return fRealDimensions;} + /// Return color to use Int_t GetColor() const {return fColor;} //methods diff --git a/MUON/mapping/AliMpHelper.cxx b/MUON/mapping/AliMpHelper.cxx index 4003d89890b..28b0dacdb36 100644 --- a/MUON/mapping/AliMpHelper.cxx +++ b/MUON/mapping/AliMpHelper.cxx @@ -37,27 +37,27 @@ ClassImp(AliMpHelper) //_____________________________________________________________________________ AliMpHelper::AliMpHelper() : TObject() { - // - // Default (empty) ctor. - // + /// + /// Default (empty) ctor. + /// } //_____________________________________________________________________________ AliMpHelper::~AliMpHelper() { - // - // Dtor. - // + /// + /// Dtor. + /// } //_____________________________________________________________________________ void AliMpHelper::DecodeName(const char* name, char sep, TArrayI& theList) { - // - // From a string of the form "i-j;k;l;m-n" returns an integer array - // containing all the integers from i to j, then k, l and then from m to - // n. - // + /// + /// From a string of the form "i-j;k;l;m-n" returns an integer array + /// containing all the integers from i to j, then k, l and then from m to + /// n. + /// theList.Set(0); TString str(name); @@ -99,10 +99,10 @@ void AliMpHelper::GetRange(const char* cstr, Int_t& begin, Int_t& end, Int_t& incr, Int_t& n) { - // - // From a string of the form "m-n" returns a range (begin,end), - // its ordering (incr=+-1) and its size (abs(begin-end)+1) - // + /// + /// From a string of the form "m-n" returns a range (begin,end), + /// its ordering (incr=+-1) and its size (abs(begin-end)+1) + /// TString str(cstr); incr = 1; @@ -132,9 +132,9 @@ AliMpHelper::GetRange(const char* cstr, Int_t& begin, Int_t& end, //_____________________________________________________________________________ TString AliMpHelper::Normalize(const char* line) { - // - // Remove multiple blanks, and blanks in the begining/end. - // + /// + /// Remove multiple blanks, and blanks in the begining/end. + /// TString rv(line); if ( rv.Length() <= 0 ) return TString(); diff --git a/MUON/mapping/AliMpIntPair.h b/MUON/mapping/AliMpIntPair.h index 69a5057a91a..63d237d23d2 100755 --- a/MUON/mapping/AliMpIntPair.h +++ b/MUON/mapping/AliMpIntPair.h @@ -35,16 +35,28 @@ class AliMpIntPair : public TObject void operator += (const AliMpIntPair& op); void operator -= (const AliMpIntPair& op); + // // static get methods + // + /// Return invalid pair static AliMpIntPair Invalid() {return AliMpIntPair();} + // // get methods + // + /// Return first value Int_t GetFirst() const {return fFirst;} + /// Return second value Int_t GetSecond() const {return fSecond;} + /// Return validity Bool_t IsValid() const {return fValidity;} + // // set methods + // + /// Set first value void SetFirst(Int_t ix) {fFirst=ix; fValidity=true; } + /// Set second value void SetSecond(Int_t iy) {fSecond=iy; fValidity=true;} void Set(Int_t ix, Int_t iy) { fFirst=ix; fSecond=iy; fValidity=true; } diff --git a/MUON/mapping/AliMpMotif.h b/MUON/mapping/AliMpMotif.h index 0d5160ae661..7b6d1a4abdf 100755 --- a/MUON/mapping/AliMpMotif.h +++ b/MUON/mapping/AliMpMotif.h @@ -50,9 +50,11 @@ class AliMpMotif : public AliMpVMotif // inline functions + /// Return 1 as the number of pad dimensions inline Int_t AliMpMotif::GetNofPadDimensions() const { return 1; } + /// Return the pad dimensions inline TVector2 AliMpMotif::GetPadDimensions(Int_t /*i*/) const { return fPadDimensions; } diff --git a/MUON/mapping/AliMpMotifMap.h b/MUON/mapping/AliMpMotifMap.h index 0a0402d6fab..4934d7faca1 100755 --- a/MUON/mapping/AliMpMotifMap.h +++ b/MUON/mapping/AliMpMotifMap.h @@ -49,19 +49,31 @@ class AliMpMotifMap : public TObject { public: #ifdef WITH_STL + /// Motif map type typedef std::map MotifMap; + /// Motif map iterator type typedef MotifMap::const_iterator MotifMapIterator; + /// Motif type map type typedef std::map MotifTypeMap; + /// Motif type map iterator type typedef MotifTypeMap::const_iterator MotifTypeMapIterator; + /// Motif position map to int type typedef std::map MotiPositionMap; + /// Motif position map to int iterator type typedef MotiPositionMap::const_iterator MotifPositionMapIterator; + /// Motif position map to int pair type typedef std::map MotifPositionMap2; + /// Motif position map to int pair iterator type typedef MotifPositionMap2::const_iterator MotifPositionMap2Iterator; #endif #ifdef WITH_ROOT + /// Motif map type typedef AliMpExMap MotifMap; + /// Motif type map type typedef AliMpExMap MotifTypeMap; + /// Motif position map to int type typedef AliMpExMap MotifPositionMap; + /// Motif position map to int pair iterator type typedef AliMpExMap MotifPositionMap2; #endif diff --git a/MUON/mapping/AliMpMotifPainter.h b/MUON/mapping/AliMpMotifPainter.h index 2abf6dc965d..97430164f49 100755 --- a/MUON/mapping/AliMpMotifPainter.h +++ b/MUON/mapping/AliMpMotifPainter.h @@ -32,7 +32,9 @@ class AliMpMotifPainter : public AliMpVPainter virtual TVector2 GetDimensions() const; private: + /// Not implemented AliMpMotifPainter(const AliMpMotifPainter& right); + /// Not implemented AliMpMotifPainter& operator = (const AliMpMotifPainter& right); void PaintContour(Option_t* option, Bool_t fill); diff --git a/MUON/mapping/AliMpMotifPosition.h b/MUON/mapping/AliMpMotifPosition.h index 3aea38be987..3a608cd82cd 100755 --- a/MUON/mapping/AliMpMotifPosition.h +++ b/MUON/mapping/AliMpMotifPosition.h @@ -47,7 +47,9 @@ class AliMpMotifPosition : public AliMpVIndexed void Print(Option_t* option="") const; private: + /// Not implemented AliMpMotifPosition(const AliMpMotifPosition& right); + /// Not implemented AliMpMotifPosition& operator = (const AliMpMotifPosition& right); // methods @@ -61,15 +63,19 @@ class AliMpMotifPosition : public AliMpVIndexed // inline functions +/// Return motif position ID = manu id inline Int_t AliMpMotifPosition::GetID() const { return fID; } +/// Return motif inline AliMpVMotif* AliMpMotifPosition::GetMotif() const { return fMotif; } +/// Return position inline TVector2 AliMpMotifPosition::Position() const { return fPosition; } +/// Return dimensions inline TVector2 AliMpMotifPosition::Dimensions() const { return fMotif->Dimensions(); } diff --git a/MUON/mapping/AliMpMotifReader.h b/MUON/mapping/AliMpMotifReader.h index 5e80049d650..70b653bc3d5 100644 --- a/MUON/mapping/AliMpMotifReader.h +++ b/MUON/mapping/AliMpMotifReader.h @@ -43,10 +43,13 @@ class AliMpMotifReader : public TObject { public: #ifdef WITH_STL + /// Map of int pair to string typedef std::map > PadMapType; + /// Map of int pair to string iterator typedef PadMapType::iterator PadMapTypeIterator; #endif #ifdef WITH_ROOT + /// Map of int pair to string typedef TExMap PadMapType; #endif @@ -63,7 +66,9 @@ class AliMpMotifReader : public TObject TString MotifSpecialName(const TString& motifID, Double_t scale); private: + /// Not implemented AliMpMotifReader(const AliMpMotifReader& right); + /// Not implemented AliMpMotifReader& operator = (const AliMpMotifReader& right); // data members diff --git a/MUON/mapping/AliMpMotifSpecial.h b/MUON/mapping/AliMpMotifSpecial.h index c922068b829..b41dba161be 100755 --- a/MUON/mapping/AliMpMotifSpecial.h +++ b/MUON/mapping/AliMpMotifSpecial.h @@ -35,11 +35,15 @@ class AliMpMotifSpecial : public AliMpVMotif { public: #ifdef WITH_STL + /// Dimensions map type typedef std::vector< TVector2 > DimensionsMap; + /// Dimensions map iterator type typedef std::vector< TVector2 > DimensionsMap2; #endif #ifdef WITH_ROOT + /// Dimensions map type typedef AliMpExMap DimensionsMap; + /// Dimensions map iterator type typedef TObjArray DimensionsMap2; #endif diff --git a/MUON/mapping/AliMpMotifType.cxx b/MUON/mapping/AliMpMotifType.cxx index 14835c7a8c9..f7757d175de 100755 --- a/MUON/mapping/AliMpMotifType.cxx +++ b/MUON/mapping/AliMpMotifType.cxx @@ -45,7 +45,6 @@ AliMpMotifType::AliMpMotifType(const TString &id) fID(id), fNofPadsX(0), fNofPadsY(0), - fVerboseLevel(0), #ifdef WITH_STL fConnections() #endif @@ -53,7 +52,10 @@ AliMpMotifType::AliMpMotifType(const TString &id) fConnections(true) #endif { - /// Standard constructor + /// Standard constructor \n + /// Please note that id should be of the form %s for station 1,2, + // %s-%e-%e for station345 and %sx%e for stationTrigger + AliDebug(1,Form("this=%p id=%s",this,id.Data())); } @@ -63,7 +65,6 @@ AliMpMotifType::AliMpMotifType() fID(""), fNofPadsX(0), fNofPadsY(0), - fVerboseLevel(0), fConnections() { /// Default constructor @@ -76,7 +77,6 @@ AliMpMotifType::AliMpMotifType(const AliMpMotifType& rhs) fID(""), fNofPadsX(0), fNofPadsY(0), - fVerboseLevel(0), fConnections() { /// Copy constructor @@ -115,7 +115,6 @@ AliMpMotifType::Copy(TObject& object) const mt.fID = fID; mt.fNofPadsX = fNofPadsX; mt.fNofPadsY = fNofPadsY; - mt.fVerboseLevel = fVerboseLevel; mt.fConnections = fConnections; } diff --git a/MUON/mapping/AliMpMotifType.h b/MUON/mapping/AliMpMotifType.h index 86f931235a0..9b636fa46bc 100755 --- a/MUON/mapping/AliMpMotifType.h +++ b/MUON/mapping/AliMpMotifType.h @@ -35,17 +35,17 @@ class AliMpMotifType : public TObject { public: #ifdef WITH_STL + /// Connection map type typedef std::map< AliMpIntPair, AliMpConnection* > ConnectionMap; + /// Connection map iterator type typedef ConnectionMap::const_iterator ConnectionMapCIterator; #endif #ifdef WITH_ROOT + /// Connection map type typedef AliMpExMap ConnectionMap; #endif public: - /** Please note that id should be of the form %s for station 1,2, - %s-%e-%e for station345 and %sx%e for stationTrigger - */ AliMpMotifType(const TString &id); AliMpMotifType(const AliMpMotifType& rhs); AliMpMotifType& operator=(const AliMpMotifType& rhs); @@ -73,11 +73,13 @@ class AliMpMotifType : public TObject // set methods void SetNofPads(Int_t nofPadsX, Int_t nofPadY); - void SetVerboseLevel(Int_t level){fVerboseLevel=level;} // get methods + /// Return unique motif ID TString GetID() const {return fID;} + /// Return number of pads in x direction Int_t GetNofPadsX() const {return fNofPadsX;} + /// Return number of pads in y direction Int_t GetNofPadsY() const {return fNofPadsY;} Int_t GetNofPads() const; @@ -104,7 +106,6 @@ class AliMpMotifType : public TObject TString fID; ///< unique motif ID Int_t fNofPadsX; ///< number of pads in x direction Int_t fNofPadsY; ///< number of pads in y direction - Int_t fVerboseLevel; ///< verbose level ConnectionMap fConnections; ///< Map (ix,iy) of connections ClassDef(AliMpMotifType,1) // Motif type @@ -112,6 +113,7 @@ class AliMpMotifType : public TObject // inline functions +/// Return true if the motif conatins all pads inline Bool_t AliMpMotifType::IsFull() const { return GetNofPads() == fNofPadsX*fNofPadsY; } diff --git a/MUON/mapping/AliMpNeighboursPadIterator.h b/MUON/mapping/AliMpNeighboursPadIterator.h index 31626132d67..40d2bed5ec1 100755 --- a/MUON/mapping/AliMpNeighboursPadIterator.h +++ b/MUON/mapping/AliMpNeighboursPadIterator.h @@ -34,12 +34,17 @@ class AliMpNeighboursPadIterator : public AliMpVPadIterator { public: #ifdef WITH_STL + /// Pad vector type typedef std::vector PadVector; + /// Pad set type typedef std::set PadSet; + /// Pad set iterator type typedef PadSet::const_iterator PadSetCIterator; #endif #ifdef WITH_ROOT + /// Pad vector type typedef TObjArray PadVector; + /// Pad set type typedef TObjArray PadSet; #endif @@ -64,7 +69,7 @@ class AliMpNeighboursPadIterator : public AliMpVPadIterator private: // static members - static const UInt_t fgkInvalidIndex; // invalid index number + static const UInt_t fgkInvalidIndex; ///< invalid index number // private methods Bool_t IsNeighbour(const AliMpPad& pad) const; diff --git a/MUON/mapping/AliMpPad.h b/MUON/mapping/AliMpPad.h index f12a91ff6fc..d1085187c60 100755 --- a/MUON/mapping/AliMpPad.h +++ b/MUON/mapping/AliMpPad.h @@ -31,9 +31,11 @@ class AliMpPad : public TObject { public: #ifdef WITH_STL + /// Int pair vector type typedef std::vector IntPairVector; #endif #ifdef WITH_ROOT + /// Int pair vector type typedef TClonesArray IntPairVector; #endif @@ -45,26 +47,42 @@ class AliMpPad : public TObject AliMpPad(const AliMpPad& src); virtual ~AliMpPad(); + // // operators + // Bool_t operator == (const AliMpPad& pos2) const; Bool_t operator != (const AliMpPad& pos2) const; AliMpPad& operator = (const AliMpPad& src) ; + // // methods + // void PrintOn(ostream& out) const; virtual void Print(const char* /*option*/ = "") const; + // // static get methods + // + /// Return invalid pad static AliMpPad Invalid() {return AliMpPad();} + // // set methods + // Bool_t AddLocation(const AliMpIntPair& location, Bool_t warn = true); + // // get methods + // + /// Return pad location AliMpIntPair GetLocation() const {return fLocation;} + /// Return pad indices AliMpIntPair GetIndices() const {return fIndices;} + /// Return the pad position (in cm) TVector2 Position() const {return fPosition ;} + /// Return the pad dimensions (in cm) TVector2 Dimensions() const {return fDimensions;} + /// Return validity Bool_t IsValid() const {return fValidity ;} Int_t GetNofLocations() const; diff --git a/MUON/mapping/AliMpPadIteratorPtr.h b/MUON/mapping/AliMpPadIteratorPtr.h index c3d6713d925..7024df5d058 100755 --- a/MUON/mapping/AliMpPadIteratorPtr.h +++ b/MUON/mapping/AliMpPadIteratorPtr.h @@ -26,16 +26,17 @@ class AliMpPadIteratorPtr : public TObject { public: AliMpPadIteratorPtr(AliMpVPadIterator* it); - // AliMpPadIteratorPtr(const AliMpPadIteratorPtr& right); --> private virtual ~AliMpPadIteratorPtr(); + /// Operator -> AliMpVPadIterator* operator->() { return fIterator; } + /// Operator * AliMpVPadIterator& operator*() { return *fIterator; } private: + /// Not implemented AliMpPadIteratorPtr(const AliMpPadIteratorPtr& right); - - // operators + /// Not implemented AliMpPadIteratorPtr& operator=(const AliMpPadIteratorPtr& right); // copy and assignment are disallowed to avoid // multiple deletion of fIterator diff --git a/MUON/mapping/AliMpPadPair.h b/MUON/mapping/AliMpPadPair.h index 2059cc99ae0..f38cddfe11d 100644 --- a/MUON/mapping/AliMpPadPair.h +++ b/MUON/mapping/AliMpPadPair.h @@ -46,7 +46,9 @@ class AliMpPadPair : public TObject // inline functions + /// Return the first pad inline AliMpPad AliMpPadPair::GetFirst() const { return fPadFirst; } + /// Return the second pad inline AliMpPad AliMpPadPair::GetSecond() const { return fPadSecond; } diff --git a/MUON/mapping/AliMpPadRow.h b/MUON/mapping/AliMpPadRow.h index 19c50a81c48..8c9b725d795 100755 --- a/MUON/mapping/AliMpPadRow.h +++ b/MUON/mapping/AliMpPadRow.h @@ -34,9 +34,11 @@ class AliMpPadRow : public TObject { public: #ifdef WITH_STL + /// Pad row segment vector type typedef std::vector PadRowSegmentVector; #endif #ifdef WITH_ROOT + /// Pad row segment vector type typedef TObjArray PadRowSegmentVector; #endif diff --git a/MUON/mapping/AliMpRow.h b/MUON/mapping/AliMpRow.h index 7ccf27db565..3a197c6c1c2 100755 --- a/MUON/mapping/AliMpRow.h +++ b/MUON/mapping/AliMpRow.h @@ -36,9 +36,11 @@ class AliMpRow : public AliMpVIndexed { public: #ifdef WITH_STL + /// Row segment vector type typedef std::vector RowSegmentVector; #endif #ifdef WITH_ROOT + /// Row segment vector type typedef TList RowSegmentVector; #endif @@ -72,7 +74,9 @@ class AliMpRow : public AliMpVIndexed AliMpMotifMap* GetMotifMap() const; private: + /// Not implemented AliMpRow(const AliMpRow& right); + /// Not implemented AliMpRow& operator = (const AliMpRow& right); // methods @@ -92,7 +96,10 @@ class AliMpRow : public AliMpVIndexed // inline functions +/// Return row ID inline UInt_t AliMpRow::GetID() const { return fID; } + +/// Return the motif map associated with its sector inline AliMpMotifMap* AliMpRow::GetMotifMap() const { return fMotifMap; } #endif //ALI_MP_ROW_H diff --git a/MUON/mapping/AliMpRowPainter.h b/MUON/mapping/AliMpRowPainter.h index c11f0b43845..2a83bc6ef08 100755 --- a/MUON/mapping/AliMpRowPainter.h +++ b/MUON/mapping/AliMpRowPainter.h @@ -31,10 +31,12 @@ class AliMpRowPainter : public AliMpVPainter virtual TVector2 GetDimensions() const; private: + /// Not implemented AliMpRowPainter(const AliMpRowPainter& right); + /// Not implemented AliMpRowPainter& operator = (const AliMpRowPainter& right); - AliMpRow *fRow; ///< the row to paint + AliMpRow *fRow; ///< the row to paint ClassDef(AliMpRowPainter,1) // Row painter }; diff --git a/MUON/mapping/AliMpRowSegment.h b/MUON/mapping/AliMpRowSegment.h index 5de60644fe3..eef81f52c0b 100755 --- a/MUON/mapping/AliMpRowSegment.h +++ b/MUON/mapping/AliMpRowSegment.h @@ -57,7 +57,9 @@ class AliMpRowSegment : public AliMpVRowSegment virtual Int_t GetMotifPositionId(Int_t i) const; private: + /// Not implemented AliMpRowSegment(const AliMpRowSegment& right); + /// Not implemented AliMpRowSegment& operator = (const AliMpRowSegment& right); // methods diff --git a/MUON/mapping/AliMpRowSegmentPainter.h b/MUON/mapping/AliMpRowSegmentPainter.h index 4bffafb64a9..4a95bc898e4 100755 --- a/MUON/mapping/AliMpRowSegmentPainter.h +++ b/MUON/mapping/AliMpRowSegmentPainter.h @@ -31,7 +31,9 @@ class AliMpRowSegmentPainter : public AliMpVPainter virtual TVector2 GetDimensions() const; private: + /// Not implemented AliMpRowSegmentPainter(const AliMpRowSegmentPainter& right); + /// Not implemented AliMpRowSegmentPainter& operator = (const AliMpRowSegmentPainter& right); AliMpVRowSegment *fRowSegment; ///< the row segment to draw diff --git a/MUON/mapping/AliMpRowSegmentRSpecial.h b/MUON/mapping/AliMpRowSegmentRSpecial.h index 099b6accabf..16d7d76949e 100644 --- a/MUON/mapping/AliMpRowSegmentRSpecial.h +++ b/MUON/mapping/AliMpRowSegmentRSpecial.h @@ -30,7 +30,8 @@ class AliMpRowSegmentRSpecial : public AliMpVRowSegmentSpecial virtual ~AliMpRowSegmentRSpecial(); // methods - virtual void UpdatePadsOffset() {} + /// Nothing to be done for outer segments + virtual void UpdatePadsOffset() {} virtual Double_t LeftBorderX() const; virtual Double_t RightBorderX() const; diff --git a/MUON/mapping/AliMpSector.h b/MUON/mapping/AliMpSector.h index b4bfd0fbd78..1f6e08f7f6e 100755 --- a/MUON/mapping/AliMpSector.h +++ b/MUON/mapping/AliMpSector.h @@ -44,11 +44,15 @@ class AliMpSector : public TNamed { public: #ifdef WITH_STL + /// Row vector type typedef std::vector RowVector; + /// Zone vector type typedef std::vector ZoneVector; #endif #ifdef WITH_ROOT + /// Row vector type typedef TObjArray RowVector; + /// Zone vector type typedef TObjArray ZoneVector; #endif @@ -103,7 +107,9 @@ class AliMpSector : public TNamed private: + /// Not implemented AliMpSector(const AliMpSector& right); + /// Not implemented AliMpSector& operator = (const AliMpSector& right); // methods @@ -120,34 +126,39 @@ class AliMpSector : public TNamed TVector2 fOffset; ///< sector position ZoneVector fZones; ///< zones RowVector fRows; ///< rows - AliMpMotifMap* fMotifMap; ///< motif map - AliMp::Direction fDirection;///< the direction of constant pad size + AliMpMotifMap* fMotifMap; ///< motif map + AliMp::Direction fDirection; ///< the direction of constant pad size TVector2 fMinPadDimensions; ///< minimum pad dimensions TVector2 fMaxPadDimensions; ///< miximum pad dimensions AliMpIntPair fMaxPadIndices; ///< maximum pad indices Int_t fNofPads; ///< total number of pads - ClassDef(AliMpSector,1) // Sector }; // inline functions +/// Return the direction of constant pad size inline AliMp::Direction AliMpSector::GetDirection() const { return fDirection; } +/// Return minimum pad dimensions inline TVector2 AliMpSector::GetMinPadDimensions() const { return fMinPadDimensions; } +/// Return maxmum pad dimensions inline TVector2 AliMpSector::GetMaxPadDimensions() const { return fMaxPadDimensions; } +/// Return maximum pad indices inline AliMpIntPair AliMpSector::GetMaxPadIndices() const { return fMaxPadIndices; } +/// Return total number of pads inline Int_t AliMpSector::GetNofPads() const { return fNofPads; } +/// Return the motif map inline AliMpMotifMap* AliMpSector::GetMotifMap() const { return fMotifMap; } diff --git a/MUON/mapping/AliMpSectorPainter.cxx b/MUON/mapping/AliMpSectorPainter.cxx index 32ae360f173..150febe4d41 100755 --- a/MUON/mapping/AliMpSectorPainter.cxx +++ b/MUON/mapping/AliMpSectorPainter.cxx @@ -62,7 +62,7 @@ AliMpSectorPainter::~AliMpSectorPainter() //_______________________________________________________________________ void AliMpSectorPainter::DumpObject() { -//// Draw the owned object +/// Draw the owned object fSector->Dump(); } @@ -70,7 +70,7 @@ void AliMpSectorPainter::DumpObject() //_______________________________________________________________________ TVector2 AliMpSectorPainter::GetPosition() const { -//// Get the owned object's position +/// Get the owned object's position if (fSector->GetNofRows()<1) return TVector2(0.,0.); AliMpRow* row = fSector->GetRow(0); @@ -99,7 +99,7 @@ TVector2 AliMpSectorPainter::GetPosition() const //_______________________________________________________________________ TVector2 AliMpSectorPainter::GetDimensions() const { -//// Get the owned object's dimensions +/// Get the owned object's dimensions if (fSector->GetNofRows()<1) return TVector2(0.,0.); AliMpRow* row = fSector->GetRow(0); @@ -197,7 +197,7 @@ void AliMpSectorPainter::Draw(Option_t *option) //_______________________________________________________________________ void AliMpSectorPainter::Paint(Option_t* /*option*/) { -//// Paint the object +/// Paint the object AliMpGraphContext *gr = AliMpGraphContext::Instance(); if (!fSector) return; diff --git a/MUON/mapping/AliMpSectorPainter.h b/MUON/mapping/AliMpSectorPainter.h index 540a793f702..9ca8dacaf25 100755 --- a/MUON/mapping/AliMpSectorPainter.h +++ b/MUON/mapping/AliMpSectorPainter.h @@ -31,7 +31,9 @@ class AliMpSectorPainter : public AliMpVPainter virtual TVector2 GetDimensions() const; private: + /// Not implemented AliMpSectorPainter(const AliMpSectorPainter& right); + /// Not implemented AliMpSectorPainter& operator = (const AliMpSectorPainter& right); AliMpSector *fSector; ///< the sector to draw diff --git a/MUON/mapping/AliMpSectorReader.cxx b/MUON/mapping/AliMpSectorReader.cxx index 3d5ab3bbabc..d00a666672f 100755 --- a/MUON/mapping/AliMpSectorReader.cxx +++ b/MUON/mapping/AliMpSectorReader.cxx @@ -79,7 +79,7 @@ AliMpSectorReader::AliMpSectorReader(AliMp::StationType station, fSector(0), fMotifReader(new AliMpMotifReader(station, plane)) { -// Standard constructor +/// Standard constructor } //_____________________________________________________________________________ @@ -90,7 +90,7 @@ AliMpSectorReader::AliMpSectorReader() fSector(0), fMotifReader(0) { -// Default constructor +/// Default constructor } //_____________________________________________________________________________ diff --git a/MUON/mapping/AliMpSectorReader.h b/MUON/mapping/AliMpSectorReader.h index 1c33f85560d..71b99a10858 100755 --- a/MUON/mapping/AliMpSectorReader.h +++ b/MUON/mapping/AliMpSectorReader.h @@ -45,8 +45,10 @@ class AliMpSectorReader : public TObject AliMpSector* BuildSector(); private: + /// Not implemented AliMpSectorReader(const AliMpSectorReader& right); - AliMpSectorReader& operator = (const AliMpSectorReader& right); + /// Not implemented + AliMpSectorReader& operator = (const AliMpSectorReader& right); // methods void ReadSectorData(ifstream& in); diff --git a/MUON/mapping/AliMpSectorSegmentation.cxx b/MUON/mapping/AliMpSectorSegmentation.cxx index 0885fd2d2e9..8e461de99c0 100755 --- a/MUON/mapping/AliMpSectorSegmentation.cxx +++ b/MUON/mapping/AliMpSectorSegmentation.cxx @@ -667,6 +667,8 @@ Bool_t AliMpSectorSegmentation::CircleTest(const AliMpIntPair& indices) const void AliMpSectorSegmentation::Print(Option_t* opt) const { +/// Print the sector + fkSector->Print(opt); } diff --git a/MUON/mapping/AliMpSectorSegmentation.h b/MUON/mapping/AliMpSectorSegmentation.h index 719b745ff96..7c4bdfa29b5 100755 --- a/MUON/mapping/AliMpSectorSegmentation.h +++ b/MUON/mapping/AliMpSectorSegmentation.h @@ -41,11 +41,15 @@ class AliMpSectorSegmentation : public AliMpVSegmentation { public: #ifdef WITH_STL + /// Pad dimensions map type typedef std::map PadDimensionsMap; + /// Pad dimensions map iterator type typedef PadDimensionsMap::const_iterator PadDimensionsMapCIterator; #endif #ifdef WITH_ROOT + /// Pad dimensions map type typedef TExMap PadDimensionsMap; + /// Pad dimensions map iterator type typedef TExMapIter PadDimensionsMapCIterator; #endif @@ -99,12 +103,14 @@ class AliMpSectorSegmentation : public AliMpVSegmentation TVector2 Dimensions() const; private: + /// Not implemented AliMpSectorSegmentation(const AliMpSectorSegmentation& right); + /// Not implemented AliMpSectorSegmentation& operator = (const AliMpSectorSegmentation& right); #ifdef WITH_ROOT - static const Double_t fgkS1; // the separators used for conversion - static const Double_t fgkS2; // of TVector2 to Long_t + static const Double_t fgkS1; ///< the separators used for conversion + static const Double_t fgkS2; ///< of TVector2 to Long_t // methods Long_t GetIndex(const TVector2& vector2) const; @@ -139,6 +145,7 @@ class AliMpSectorSegmentation : public AliMpVSegmentation // inline functions +/// Return the sector inline const AliMpSector* AliMpSectorSegmentation::GetSector() const { return fkSector; } diff --git a/MUON/mapping/AliMpSegmentation.h b/MUON/mapping/AliMpSegmentation.h index 2ccd3fee7ab..8cef7285848 100644 --- a/MUON/mapping/AliMpSegmentation.h +++ b/MUON/mapping/AliMpSegmentation.h @@ -63,8 +63,11 @@ class AliMpSegmentation : public TObject { Bool_t warn = true) const; private: + /// Not implemented AliMpSegmentation(); + /// Not implemented AliMpSegmentation(const AliMpSegmentation& rhs); + /// Not implemented AliMpSegmentation& operator=(const AliMpSegmentation& rhs); AliMpVSegmentation* CreateMpSegmentation( diff --git a/MUON/mapping/AliMpStringObjMap.cxx b/MUON/mapping/AliMpStringObjMap.cxx index fcbd6108217..ae9a3e8d1b8 100644 --- a/MUON/mapping/AliMpStringObjMap.cxx +++ b/MUON/mapping/AliMpStringObjMap.cxx @@ -127,7 +127,7 @@ void AliMpStringObjMap::Print(const char* /*option*/) const //______________________________________________________________________________ void AliMpStringObjMap::Print(const TString& key, ofstream& out) const { -// Prints the map elements +/// Special printing for (Int_t i=0; i RowSegmentVector; #endif #ifdef WITH_ROOT + /// Row segment vector type typedef TList RowSegmentVector; #endif @@ -54,7 +56,9 @@ class AliMpSubZone : public TObject AliMpVMotif* GetMotif() const; private: + /// Not implemented AliMpSubZone(const AliMpSubZone& right); + /// Not implemented AliMpSubZone& operator = (const AliMpSubZone& right); // data members diff --git a/MUON/mapping/AliMpSubZonePainter.cxx b/MUON/mapping/AliMpSubZonePainter.cxx index 8ab76d80c09..a77689c8ddd 100755 --- a/MUON/mapping/AliMpSubZonePainter.cxx +++ b/MUON/mapping/AliMpSubZonePainter.cxx @@ -94,7 +94,7 @@ Int_t AliMpSubZonePainter::DistancetoPrimitive(Int_t x, Int_t y) //_______________________________________________________________________ void AliMpSubZonePainter::DumpObject() { - //// Draw the owned object + /// Draw the owned object fSubZone->Dump(); } @@ -102,7 +102,7 @@ void AliMpSubZonePainter::DumpObject() //_______________________________________________________________________ TVector2 AliMpSubZonePainter::GetPosition() const { - //// Get the owned object's position + /// Get the owned object's position if (fSubZone->GetNofRowSegments()<1) return TVector2(0.,0.); AliMpVRowSegment* seg = fSubZone->GetRowSegment(0); @@ -131,7 +131,7 @@ TVector2 AliMpSubZonePainter::GetPosition() const //_______________________________________________________________________ TVector2 AliMpSubZonePainter::GetDimensions() const { - //// Get the owned object's dimensions + /// Get the owned object's dimensions if (fSubZone->GetNofRowSegments()<1) return TVector2(0.,0.); AliMpVRowSegment* seg = fSubZone->GetRowSegment(0); @@ -199,7 +199,7 @@ void AliMpSubZonePainter::Draw(Option_t *option) //_______________________________________________________________________ void AliMpSubZonePainter::Paint(Option_t *option) { -//// Paint the object +/// Paint the object AliMpGraphContext *gr = AliMpGraphContext::Instance(); if (!fSubZone) return; diff --git a/MUON/mapping/AliMpSubZonePainter.h b/MUON/mapping/AliMpSubZonePainter.h index cc29775e81e..3bcac230900 100755 --- a/MUON/mapping/AliMpSubZonePainter.h +++ b/MUON/mapping/AliMpSubZonePainter.h @@ -33,7 +33,9 @@ class AliMpSubZonePainter : public AliMpVPainter virtual Int_t DistancetoPrimitive(Int_t x, Int_t y); private: + /// Not implemented AliMpSubZonePainter(const AliMpSubZonePainter& right); + /// Not implemented AliMpSubZonePainter& operator = (const AliMpSubZonePainter& right); AliMpSubZone *fSubZone; ///< the subzone to draw diff --git a/MUON/mapping/AliMpVIndexed.h b/MUON/mapping/AliMpVIndexed.h index 263240d0a27..9d81452beae 100755 --- a/MUON/mapping/AliMpVIndexed.h +++ b/MUON/mapping/AliMpVIndexed.h @@ -27,6 +27,7 @@ class AliMpVIndexed : public TObject virtual ~AliMpVIndexed(); // methods + /// Create iterator over this element virtual AliMpVPadIterator* CreateIterator() const = 0; virtual AliMpIntPair GlobalIndices(const AliMpIntPair& localIndices) const; @@ -50,15 +51,19 @@ class AliMpVIndexed : public TObject // inline functions +/// Set low indices limit inline void AliMpVIndexed::SetLowIndicesLimit(const AliMpIntPair& limit) { fLowIndicesLimit = limit; } +/// Set high indices limit inline void AliMpVIndexed::SetHighIndicesLimit(const AliMpIntPair& limit) { fHighIndicesLimit = limit; } +/// Return low indices limit inline AliMpIntPair AliMpVIndexed::GetLowIndicesLimit() const { return fLowIndicesLimit; } +/// Return high indices limit inline AliMpIntPair AliMpVIndexed::GetHighIndicesLimit() const { return fHighIndicesLimit; } diff --git a/MUON/mapping/AliMpVMotif.h b/MUON/mapping/AliMpVMotif.h index a78e8dced84..6bdaf9b7c6e 100755 --- a/MUON/mapping/AliMpVMotif.h +++ b/MUON/mapping/AliMpVMotif.h @@ -31,21 +31,29 @@ class AliMpVMotif : public TObject // Access methods AliMpMotifType *GetMotifType() const; TString GetID() const; + /// Return the number of pad dimensions virtual Int_t GetNofPadDimensions() const=0; + /// Return the i-th pad dimensions virtual TVector2 GetPadDimensions(Int_t i) const=0; + /// Return the dimensions of the pad specified by localIndices virtual TVector2 GetPadDimensions(const AliMpIntPair& localIndices) const=0; // Geometry + /// Return dimensions virtual TVector2 Dimensions() const=0; // Other methods AliMpConnection *FindConnectionByLocalPos(const TVector2& localPos) const; virtual void Print(Option_t *option) const; - virtual TVector2 PadPositionLocal(const AliMpIntPair& localIndices) const=0; + /// Return local position of the pad specified by local indices + virtual TVector2 PadPositionLocal(const AliMpIntPair& localIndices) const=0; + /// Return local indices of the pad specified by local position virtual AliMpIntPair PadIndicesLocal(const TVector2& localPos) const=0; private: + /// Not implemented AliMpVMotif(const AliMpVMotif& right); + /// Not implemented AliMpVMotif& operator = (const AliMpVMotif& right); // data members @@ -57,7 +65,10 @@ class AliMpVMotif : public TObject // inline functions +/// Return the motif type inline AliMpMotifType* AliMpVMotif::GetMotifType() const {return fMotifType;} + +/// Return the motif identifier inline TString AliMpVMotif::GetID() const {return fID;} #endif //ALI_MP_V_MOTIF_H diff --git a/MUON/mapping/AliMpVPadIterator.h b/MUON/mapping/AliMpVPadIterator.h index 121a69781ba..cbb31035c3e 100755 --- a/MUON/mapping/AliMpVPadIterator.h +++ b/MUON/mapping/AliMpVPadIterator.h @@ -28,10 +28,15 @@ class AliMpVPadIterator : public TObject AliMpVPadIterator& operator = (const AliMpVPadIterator& right); // methods + /// Set iterator to the first pad virtual void First() = 0; + /// Set iterator to the next pad virtual void Next() = 0; + /// Is iterator done virtual Bool_t IsDone() const = 0; + /// Return current pad virtual AliMpPad CurrentItem() const = 0; + /// Invalidate iterator ( virtual void Invalidate() = 0; ClassDef(AliMpVPadIterator,1) // abstract pad iterator diff --git a/MUON/mapping/AliMpVPadRowSegment.h b/MUON/mapping/AliMpVPadRowSegment.h index 491b10b0a68..c248a84d7b2 100755 --- a/MUON/mapping/AliMpVPadRowSegment.h +++ b/MUON/mapping/AliMpVPadRowSegment.h @@ -28,7 +28,11 @@ class AliMpVPadRowSegment : public TObject virtual ~AliMpVPadRowSegment(); // methods + /// Return the x coordinate of the left border + /// in the global coordinate system. virtual Double_t LeftBorderX() const = 0; + /// Return the x coordinate of the right border + /// in the global coordinate system. virtual Double_t RightBorderX() const = 0; virtual Double_t HalfSizeY() const; @@ -36,16 +40,20 @@ class AliMpVPadRowSegment : public TObject virtual AliMpPadRow* GetPadRow() const; virtual AliMpMotif* GetMotif() const; virtual Int_t GetMotifPositionId() const; + /// Return number of pads Int_t GetNofPads() const {return fNofPads;} // set methods void SetOffsetX(Double_t offsetX); protected: + /// Return the x position of the right/left border Double_t GetOffsetX() const { return fOffsetX; } private: + /// Not implemented AliMpVPadRowSegment(const AliMpVPadRowSegment& right); + /// Not implemented AliMpVPadRowSegment& operator = (const AliMpVPadRowSegment& right); // data members diff --git a/MUON/mapping/AliMpVPainter.h b/MUON/mapping/AliMpVPainter.h index 146a30fcf6f..16c7bce4c18 100755 --- a/MUON/mapping/AliMpVPainter.h +++ b/MUON/mapping/AliMpVPainter.h @@ -25,23 +25,38 @@ class AliMpVPainter : public TObject virtual ~AliMpVPainter(); void DumpObject() const; // *MENU* + /// Paint the associated object virtual void Paint(Option_t *option)=0; virtual TObject* Clone(const char* newname="") const; virtual TObject* DrawClone(Option_t* option) const; // *MENU* + // // get methods + // + /// Return the position inside the graphics pad TVector2 GetPadPosition() const {return fPadPosition;} + /// Return the dimensions inside the graphics pad TVector2 GetPadDimensions() const {return fPadDimensions;} + /// Return the color Int_t GetColor() const {return fColor;} + // // set methods + // + /// Set the position inside the graphics pad void SetPadPosition(const TVector2 &padPosition){fPadPosition=padPosition;} + /// Set the dimensions inside the graphics pad void SetPadDimension(const TVector2 &padDimensions){fPadDimensions=padDimensions;} + /// Set the color void SetColor(Int_t color){fColor=color;} + // // methods + // Bool_t IsInside(const TVector2 &point,const TVector2& pos,const TVector2& dim); + /// Return the owned object's position virtual TVector2 GetPosition() const=0; + /// Return the owned object's dimensions virtual TVector2 GetDimensions() const=0; void InitGraphContext(); void PaintWholeBox(Bool_t fill=kTRUE); @@ -51,11 +66,15 @@ class AliMpVPainter : public TObject static AliMpVPainter *CreatePainter(TObject *object); protected: + /// Not implemented void AddPainter(AliMpVPainter *painter); + /// Not implemented AliMpVPainter *DrawObject(TObject *object,Option_t *option=""); private: + /// Not implemented AliMpVPainter(const AliMpVPainter& right); + /// Not implemented AliMpVPainter& operator = (const AliMpVPainter& right); Int_t fColor; ///< color diff --git a/MUON/mapping/AliMpVRowSegment.h b/MUON/mapping/AliMpVRowSegment.h index 45bf39d4532..ab3f7a0ba7f 100755 --- a/MUON/mapping/AliMpVRowSegment.h +++ b/MUON/mapping/AliMpVRowSegment.h @@ -27,32 +27,63 @@ class AliMpVRowSegment : public AliMpVIndexed AliMpVRowSegment(); virtual ~AliMpVRowSegment(); + // // methods + // + + /// Return the x coordinate of the left border in the global coordinate system. virtual Double_t LeftBorderX() const = 0; + /// Return the x coordinate of the right border in the global coordinate system. virtual Double_t RightBorderX() const = 0; + /// Return the half size in y of this row segment. virtual Double_t HalfSizeY() const = 0; virtual AliMpVPadIterator* CreateIterator() const; + // // find methods + // + + /// Find the motif in the given positions virtual AliMpVMotif* FindMotif(const TVector2& position) const = 0; + /// Find the motif position Id in the given positions virtual Int_t FindMotifPositionId(const TVector2& position) const = 0; + /// Has the motif position with the given Id ? virtual Bool_t HasMotifPosition(Int_t motifPositionId) const = 0; + /// Return the coordinates of the motif specified with the given motif position Id virtual TVector2 MotifCenter(Int_t motifPositionId) const = 0; + // // geometry + // + + /// Return the position of the row segment centre. virtual TVector2 Position() const = 0; + /// Return the dimensions the row segment centre. virtual TVector2 Dimensions() const = 0; + // // set methods + // + + /// Calculate offset virtual void SetOffset(const TVector2& offset) = 0; + /// Set global indices limits. virtual void SetGlobalIndices(AliMpRow* rowBefore) = 0; + /// Set global indices to i-th motif position and returns next index in x. virtual Int_t SetIndicesToMotifPosition(Int_t i, const AliMpIntPair& indices) = 0; + // // get methods + // + + /// Return the row.which this row segment belongs to virtual AliMpRow* GetRow() const = 0; + /// Return the number of motifs in this this row segment. virtual Int_t GetNofMotifs() const = 0; + /// Return the i-th motif of this row segment. virtual AliMpVMotif* GetMotif(Int_t i) const = 0; + /// Return the i-th motif position Id of this row segment. virtual Int_t GetMotifPositionId(Int_t i) const = 0; ClassDef(AliMpVRowSegment,1) //Row segment diff --git a/MUON/mapping/AliMpVRowSegmentSpecial.h b/MUON/mapping/AliMpVRowSegmentSpecial.h index 0ac26873166..4c7c7c80893 100644 --- a/MUON/mapping/AliMpVRowSegmentSpecial.h +++ b/MUON/mapping/AliMpVRowSegmentSpecial.h @@ -38,13 +38,19 @@ class AliMpVRowSegmentSpecial : public AliMpVRowSegment { public: #ifdef WITH_STL + /// Pad row vector type typedef std::vector PadRowVector; + /// Motif vector type typedef std::vector MotifVector; + /// Motif position Id vector type typedef std::vector MotifPositionIdVector; #endif #ifdef WITH_ROOT + /// Pad row vector type typedef TObjArray PadRowVector; + /// Motif vector type typedef TObjArray MotifVector; + /// Motif position Id vector type typedef TArrayI MotifPositionIdVector; #endif @@ -53,31 +59,49 @@ class AliMpVRowSegmentSpecial : public AliMpVRowSegment AliMpVRowSegmentSpecial(); virtual ~AliMpVRowSegmentSpecial(); + // // methods + // void AddPadRow(AliMpPadRow* padRow); void UpdateMotifVector(); + /// Update pads offset virtual void UpdatePadsOffset() = 0; + /// Return the x coordinate of the left border in the global coordinate system. virtual Double_t LeftBorderX() const = 0; + /// Return the x coordinate of the right border in the global coordinate system. virtual Double_t RightBorderX() const= 0; + /// Return the half size in y of this row segment. virtual Double_t HalfSizeY() const; + // // find methods + // virtual AliMpVMotif* FindMotif(const TVector2& position) const; virtual Int_t FindMotifPositionId(const TVector2& position) const; virtual Bool_t HasMotifPosition(Int_t motifPositionId) const; virtual TVector2 MotifCenter(Int_t motifPositionId) const; + // // geometry + // + /// Return the position of the row segment centre. virtual TVector2 Position() const = 0; virtual TVector2 Dimensions() const; + // // set methods + // + /// Calculate offset virtual void SetOffset(const TVector2& /*offset*/) {} + /// Set global indices limits. virtual void SetGlobalIndices(AliMpRow* rowBefore) = 0; + /// Set global indices to i-th motif position and returns next index in x. virtual Int_t SetIndicesToMotifPosition(Int_t i, const AliMpIntPair& indices) = 0; + // // get methods + // virtual AliMpRow* GetRow() const; virtual Int_t GetNofMotifs() const; virtual AliMpVMotif* GetMotif(Int_t i) const; @@ -85,6 +109,7 @@ class AliMpVRowSegmentSpecial : public AliMpVRowSegment protected: // methods + /// Return the coordinates of the motif specified with the given motif position Id \n virtual TVector2 MotifCenterSlow(Int_t motifPositionId) const = 0; AliMpPadRow* FindPadRow(Double_t y) const; AliMpVPadRowSegment* FindPadRowSegment(Int_t motifPositionId) const; @@ -98,12 +123,14 @@ class AliMpVRowSegmentSpecial : public AliMpVRowSegment Double_t GetOffsetX() const; private: + /// Not implemented AliMpVRowSegmentSpecial(const AliMpVRowSegmentSpecial& right); + /// Not implemented AliMpVRowSegmentSpecial& operator = (const AliMpVRowSegmentSpecial& right); #ifdef WITH_ROOT // static data members - static const Int_t fgkMaxNofMotifPositionIds; // dimension of fMotifPositionIds + static const Int_t fgkMaxNofMotifPositionIds; ///< dimension of fMotifPositionIds #endif // data members @@ -123,6 +150,7 @@ class AliMpVRowSegmentSpecial : public AliMpVRowSegment // inline functions +/// Return the x position of the border that touches a standard row segment inline Double_t AliMpVRowSegmentSpecial::GetOffsetX() const { return fOffsetX; } diff --git a/MUON/mapping/AliMpVSegmentation.h b/MUON/mapping/AliMpVSegmentation.h index 6ec6a6bfaf4..41719289728 100644 --- a/MUON/mapping/AliMpVSegmentation.h +++ b/MUON/mapping/AliMpVSegmentation.h @@ -39,23 +39,27 @@ class AliMpVSegmentation : public TObject virtual ~AliMpVSegmentation(); // factory methods - /// Create a pad iterator over the given area + /// Create iterator over pads in the given area virtual AliMpVPadIterator* CreateIterator(const AliMpArea& area) const = 0; - + /// Create a pad iterator over the whole area virtual AliMpVPadIterator* CreateIterator() const = 0; - /** Fills the array with the pads that are neighbours of pad. Returns - the number of neighbours. */ + /// Fill the array with the pads that are neighbours of pad. Returns + /// the number of neighbours. virtual Int_t GetNeighbours(const AliMpPad& pad, TObjArray& neighbours, Bool_t includeSelf=kFALSE, Bool_t includeVoid=kFALSE) const = 0; - // methods + // methods + // + /// Find pad by location virtual AliMpPad PadByLocation(const AliMpIntPair& location, Bool_t warning = true) const = 0; + /// Find pad by indices virtual AliMpPad PadByIndices (const AliMpIntPair& indices, Bool_t warning = true) const = 0; + /// Find pad by position virtual AliMpPad PadByPosition(const TVector2& position, Bool_t warning = true) const = 0; @@ -64,17 +68,23 @@ class AliMpVSegmentation : public TObject virtual AliMpPadPair PadsLeft(const AliMpPad& pad) const; virtual AliMpPadPair PadsRight(const AliMpPad& pad) const; + /// Return maximum pad index in X direction virtual Int_t MaxPadIndexX() const = 0; + /// Return maximum pad index in Y direction virtual Int_t MaxPadIndexY() const = 0; + /// Return the number of pads in the detection element virtual Int_t NofPads() const = 0; + /// Return true if the pad with given indices exists virtual Bool_t HasPad(const AliMpIntPair& indices) const = 0; + /// Fill the given array with the electronic card IDs virtual void GetAllElectronicCardIDs(TArrayI& ecn) const = 0; + /// Return the plane type virtual AliMp::PlaneType PlaneType() const = 0; - /// Gives the half-sizes (in cm) of the underlying detection element. + /// Return the half-sizes of the detection element virtual TVector2 Dimensions() const = 0; private: diff --git a/MUON/mapping/AliMpZone.h b/MUON/mapping/AliMpZone.h index a8895a01a2b..dfc05123e5d 100755 --- a/MUON/mapping/AliMpZone.h +++ b/MUON/mapping/AliMpZone.h @@ -36,9 +36,11 @@ class AliMpZone : public TObject { public: #ifdef WITH_STL + /// Sub zone vector type typedef std::vector SubZoneVector; #endif #ifdef WITH_ROOT + /// Sub zone vector type typedef TObjArray SubZoneVector; #endif @@ -73,12 +75,15 @@ class AliMpZone : public TObject // inline functions +/// Set pad dimensions inline void AliMpZone::SetPadDimensions(const TVector2& padDimensions) { fPadDimensions = padDimensions; } +/// Return ID inline UInt_t AliMpZone::GetID() const { return fID; } +/// Return pad dimensions inline TVector2 AliMpZone::GetPadDimensions() const { return fPadDimensions;} diff --git a/MUON/mapping/AliMpZonePainter.h b/MUON/mapping/AliMpZonePainter.h index 487387094c2..5eb2b95086b 100755 --- a/MUON/mapping/AliMpZonePainter.h +++ b/MUON/mapping/AliMpZonePainter.h @@ -34,7 +34,9 @@ class AliMpZonePainter : public AliMpVPainter virtual Int_t DistancetoPrimitive(Int_t x, Int_t y); private: + /// Not implemented AliMpZonePainter(const AliMpZonePainter& right); + /// Not implemented AliMpZonePainter& operator = (const AliMpZonePainter& right); AliMpZone *fZone; ///< the zone to draw -- 2.39.3