---

CdbBdbSAbsBtreeItr.hh

Go to the documentation of this file.

#ifndef CDBBDBSHARED_ABS_BTREE_ITR_HH
#define CDBBDBSHARED_ABS_BTREE_ITR_HH

// File and Version Information:
//      $Id: CdbBdbSAbsBtreeItr.hh,v 1.4 2002/09/23 22:41:06 gapon Exp $

#include "CdbBase/CdbIItr.hh"

//---------------------------------------------
// Forward declaration for the target B-tree --
//---------------------------------------------

template< class K,
          class FCP,
          class ORDER >
class CdbBdbSAbsBtree;

/// The internal implementation for the public iterator for B-tree keys
/**
  * This class provides the actual implementation of the B-tree browsing.
  * This class has the same template parameters as the B-tree class.
  *
  * DESIGN & IMPLEMENTATION NOTE:
  *
  *     Due to current design of the abstract B-tree class the current
  *     iterator's interface is type-intrusive. This may be solved later.
  *
  * @see CdbIItr
  * @see CdbBdbSAbsBtree
  */
template< class K,
          class FCP,
          class ORDER >
class CdbBdbSAbsBtreeItr : public CdbIItr<K> {

public:

    typedef typename CdbIItr<K>::ValueType     ValueType;
    typedef typename CdbIItr<K>::InterfaceType InterfaceType;

private:

  /// The default constructor (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbBdbSAbsBtreeItr( );

  /// The assignment operator (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbBdbSAbsBtreeItr& operator=( const CdbBdbSAbsBtreeItr<K,FCP,ORDER>& theItr );

protected:

  /// The copy constructor
  /**
    * The only reason why we have it implemented is because it's needed
    * to implement the clone method.
    *
    * @see CdbBdbSAbsBtreeItr::clone()
    */
    CdbBdbSAbsBtreeItr( const CdbBdbSAbsBtreeItr<K,FCP,ORDER>& theItr );

public:

  /// The normal constructor
  /**
    * Non 0 pointer is expected.
    */
    CdbBdbSAbsBtreeItr( const CdbBdbSAbsBtree<K,FCP,ORDER>* theTree );

  /// The destructor
  /**
    * Details...
    */
    virtual ~CdbBdbSAbsBtreeItr( );

  /// Reset an iterator to its initial state.
  /**
    * This implements the corresponding method of the base class.
    *
    * @see CdbIItr::reset
    * @see CdbStatus
    */
    virtual CdbStatus reset( );

  /// Advance an iterator to the next position.
  /**
    * This implements the corresponding method of the base class.
    *
    * @see CdbIItr::next()
    */
    virtual bool next( );

  /// Obtain the currently reffered value.
  /**
    * This implements the corresponding method of the base class.
    *
    * @see CdbIItr::value()
    * @see CdbIItr::ValueType
    *
    * @return the current value the iterator is set on
    */
    virtual ValueType value( );

  /// Check if an iterator is valid.
  /**
    * This implements the corresponding method of the base class.
    *
    * @see CdbIItr::isValid()
    */
    virtual bool isValid( );

  /// Make a clone of itself
  /**
    * @see CdbIItr::clone()
    */
    virtual InterfaceType* clone( ) const;

private:

  /// Keep searching the next element at the parent of current node
  /**
    * This is a recursive procedure, which will only return "true" if
    * an appropriate key is found and the iterator's context is set to point
    * onto that element.
    */
    bool backToParent( );

private:

    const CdbBdbSAbsBtree<K,FCP,ORDER>* _myTreePtr;

    bool _isValid;
    bool _hasEverBeenAdvanced;

    d_ULong                   _node;
    CdbBdbSBtreeNode<K,ORDER> _nodeValue;
    int                       _currentElement;
};

#ifdef    BABAR_COMP_INST
#include "CdbBdbShared/CdbBdbSAbsBtreeItr.cc"
#endif /* BABAR_COMP_INST */

#endif  // CDBBDBSHARED_ABS_BTREE_ITR_HH

---