UtlHashBagIterator.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#ifndef _UtlHashBagIterator_h_
#define _UtlHashBagIterator_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "utl/UtlDefs.h"
#include "utl/UtlIterator.h"
#include "utl/UtlHashBag.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class UtlContainable ;

class UtlHashBagIterator : public UtlIterator
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */

   UtlHashBagIterator(const UtlHashBag& hashBag, UtlContainable* key = NULL);

    virtual ~UtlHashBagIterator();

/* ============================ MANIPULATORS ============================== */

    virtual UtlContainable*    operator()() ;

    virtual void reset() ; 

/* ============================ ACCESSORS ================================= */

    UtlContainable* key() const ;

/* ============================ INQUIRY =================================== */

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
    friend class UtlHashBag;
    
    virtual void removing(const UtlLink* node);


/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

    void init(const UtlHashBag& hashBag);
   
    UtlContainable* mpSubsetMatch; 
    unsigned        mSubsetHash;   
    
    size_t   mPosition;      
    UtlLink* mpCurrentLink;  
    bool     mLinkIsValid;   
    // no copy constructor
    UtlHashBagIterator(UtlHashBagIterator&);
} ;

/* ============================ INLINE METHODS ============================ */

#endif    // _UtlHashBagIterator_h_