Added comments for inline functions

[u/mrichter/AliRoot.git] / MUON / mapping / AliMpPadIteratorPtr.h

/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

// $Id$
// $MpId: AliMpPadIteratorPtr.h,v 1.6 2006/05/23 13:07:29 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
///
/// Authors: David Guez, Ivana Hrivnacova; IPN Orsay

#ifndef ALI_MP_PAD_ITERATOR_PTR_H
#define ALI_MP_PAD_ITERATOR_PTR_H

#include <TObject.h>

class AliMpVPadIterator;

class AliMpPadIteratorPtr : public TObject
{
  public:
    AliMpPadIteratorPtr(AliMpVPadIterator* it);
    // AliMpPadIteratorPtr(const AliMpPadIteratorPtr& right); --> private
    virtual ~AliMpPadIteratorPtr();
  
    AliMpVPadIterator* operator->() { return  fIterator; }
    AliMpVPadIterator& operator*()  { return *fIterator; }

  protected:
    AliMpPadIteratorPtr(const AliMpPadIteratorPtr& right);

    // operators
    AliMpPadIteratorPtr& operator=(const AliMpPadIteratorPtr& right);
        // copy and assignment are disallowed to avoid
        // multiple deletion of fIterator
    
  private:   
    // data members
    AliMpVPadIterator*  fIterator; ///< The pad iterator
     
  ClassDef(AliMpPadIteratorPtr,1) // Pointer to abstract pad iterator
};

#endif // ALI_MP_PAD_ITERATOR_PTR_H