---

CdbBdbSCollectionIdItr.hh

Go to the documentation of this file.

#ifndef CDBBDBSHARED_COLLECTION_ID_ITR_HH
#define CDBBDBSHARED_COLLECTION_ID_ITR_HH

// File and Version Information:
//      $Id: CdbBdbSCollectionIdItr.hh,v 1.6 2003/08/13 23:36:20 gapon Exp $

#include "BdbUtil/Bdb.hh"

#include "CdbBase/CdbIItr.hh"
#include "CdbBase/CdbItr.hh"

#include "CdbBdbShared/CdbBdbSCollectionBte.hh"
#include "CdbBdbShared/CdbBdbSCollectionElementP.hh"

/// The internal implementation for the public iterator for elements of collections
/**
  * The iterator will return extract end return the identifiers of elements stored
  * in the collection.
  */
class CdbBdbSCollectionIdItr : public CdbIItr<d_UShort> {

public:

    typedef CdbIItr<d_UShort>::ValueType     ValueType;
    typedef CdbIItr<d_UShort>::InterfaceType InterfaceType;

private:

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

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

protected:

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

public:

  /// The normal constructor
  /**
    * Moste of the operations will be just forwarded
    * to the specified iterator.
    */
    CdbBdbSCollectionIdItr( const CdbItr< CdbBdbSCollectionBte >& theInputItr );

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

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

    CdbItr< CdbBdbSCollectionBte > _inputItr;   // The source of values.
    CdbBdbSCollectionBte           _inputValue; // Just a cache for the currently accessed value
};

#endif  // CDBBDBSHARED_COLLECTION_ID_ITR_HH

---