+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice */
+
// $Id$
-// Category: basic
-//
-// Class AliMpPadIteratorPtr
-// --------------------------
-// Pointer to the virtual pad iterator;
-// enables to allocate the virtual pad iterator on stack.
-// Usage:
-// AliMpVIndexed* myIndexed = MyIndexed()
-// MVIterator& it = *AliMpPadIteratorPtr(myIndexed->CreateIterator());
-//
-// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+// $MpId: AliMpPadIteratorPtr.h,v 1.7 2006/05/24 13:58:07 ivana Exp $
+
+/// \ingroup basic
+/// \class AliMpPadIteratorPtr
+/// \brief A pointer to the virtual pad iterator;
+///
+/// It enables to allocate the virtual pad iterator on stack.
+/// Usage: \n
+/// AliMpVIndexed* myIndexed = MyIndexed(); \n
+/// MVIterator& it = *AliMpPadIteratorPtr(myIndexed->CreateIterator()); \n
+///
+/// \author David Guez, Ivana Hrivnacova; IPN Orsay
#ifndef ALI_MP_PAD_ITERATOR_PTR_H
#define ALI_MP_PAD_ITERATOR_PTR_H
#include <TObject.h>
-#include "AliMpVPadIterator.h"
+class AliMpVPadIterator;
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:
- // disallow copy and assignment to avoid
- // multiple deletion of fIterator
+ /// Not implemented
AliMpPadIteratorPtr(const AliMpPadIteratorPtr& right);
+ /// Not implemented
AliMpPadIteratorPtr& operator=(const AliMpPadIteratorPtr& right);
-
+ // copy and assignment are disallowed to avoid
+ // multiple deletion of fIterator
+
// data members
- AliMpVPadIterator* fIterator; //The pad iterator
+ AliMpVPadIterator* fIterator; ///< The pad iterator
ClassDef(AliMpPadIteratorPtr,1) // Pointer to abstract pad iterator
};