Bdb packages | Design docs | Source docs | Guidelines | Recent releases
	Search | Site Map .

                 

---

/CdbBdbShared/CdbBdbSDatabaseItr.hh

Go to the documentation of this file.

#ifndef CDBBDBSHARED_DATABASE_ITR_HH
#define CDBBDBSHARED_DATABASE_ITR_HH

#include "CdbBase/CdbDatabaseItr.hh"
#include "CdbBase/CdbPtrFwd.hh"

#include <string>

/// The internal implementation for the public iterators.
/**
  * This class provides the actual implementation of the corresponding
  * iterator interface. Currently it's a very trivial implementation
  * returning a default database name.
  *
  * @see CdbIItr
  * @see CdbIItr::InterfaceType
  * @see CdbIItr::ValueType
  * @see CdbDatabaseItr
  * @see CdbDatabase
  * @see CdbDatabasePtr
  */
class CdbBdbSDatabaseItr : public CdbDatabaseItr::InterfaceType {

private:

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

  /// The assignment operator (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbBdbSDatabaseItr& operator=( const CdbBdbSDatabaseItr& theItr );

protected:

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

public:

  /// The normal constructor
  /**
    * Non 0 smart pointer is expected.
    */
    CdbBdbSDatabaseItr( const CdbPtr& theParent );

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

  /// 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:

    CdbPtr _myParent;

    bool _isValid;
    bool _hasEverBeenAdvanced;

    std::string _value;
};

#endif  // CDBBDBSHARED_DATABASE_ITR_HH

 

---

BaBar Public Site | SLAC | News | Links | Who's Who | Contact Us

Page Owner: Jacek Becla
Last Update: October 04, 2002