#include "AliMUONDataDigitIterator.h"
#include "TString.h"
-//
-// A wrapper to various iterators used to loop over
-// objects handled by AliMUONData, like sdigits, digits, rawclusters,
-// and so on.
-//
-// Currently only implemented for digits, as a proof-of-principle.
-//
+/// \class AliMUONDataIterator
+/// A wrapper to various iterators used to loop over
+/// objects handled by AliMUONData, like sdigits, digits, rawclusters,
+/// and so on.
+/// Currently only implemented for digits, as a proof-of-principle.
+///
+/// \author Laurent Aphecetche
+
+/// \cond CLASSIMP
+ClassImp(AliMUONDataIterator)
+/// \endcond
namespace
{
}
}
-ClassImp(AliMUONDataIterator)
-
//_____________________________________________________________________________
AliMUONDataIterator::AliMUONDataIterator()
:
TObject(),
fIterator(0x0)
{
+/// Default constructor
}
//_____________________________________________________________________________
TObject(),
fIterator(0x0)
{
+/// Standard constructor
+
TString opt(onWhatToIterate);
opt.ToLower();
if ( opt.Contains("digit") || opt.Contains("d") )
//_____________________________________________________________________________
AliMUONDataIterator::~AliMUONDataIterator()
{
+/// Destructor
+
delete fIterator;
}
TObject*
AliMUONDataIterator::Next()
{
- if (!fIterator) return fIterator->Next();
+/// Set iterator to the next element
+
+ if (fIterator) return fIterator->Next();
return 0x0;
}
//_____________________________________________________________________________
Bool_t
AliMUONDataIterator::Remove()
-{
- if (!fIterator) return fIterator->Remove();
+{
+/// Remove current element
+
+ if (fIterator) return fIterator->Remove();
return kFALSE;
}
void
AliMUONDataIterator::Reset()
{
- if (!fIterator) fIterator->Reset();
+/// Reset
+
+ if (fIterator) fIterator->Reset();
}