vtkObjectBaseHashMap.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * $Id: vtkObjectBaseHashMap.h,v 1.3 2005/06/24 23:17:16 xpxqx Exp $
 *
 * Copyright (c) 2005 Sean McInerney
 * All rights reserved.
 *
 * See Copyright.txt or http://vtkcontainers.sourceforge.net/Copyright.html
 * for details.
 *
 *    This software is distributed WITHOUT ANY WARRANTY; without even 
 *    the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
 *    PURPOSE.  See the above copyright notice for more information.
 *
 */
#ifndef VTK_OBJECT_BASE_HASH_MAP_H_
#  define VTK_OBJECT_BASE_HASH_MAP_H_
#  include "vtkAssociativeContainer.h"
#  include "vtkObjectBaseHashMapIterator.h" // Covariant return type.

class vtkObjectBaseHashMapInternal;

class VTK_CONTAINERS_EXPORT vtkObjectBaseHashMap
  : public vtkAssociativeContainer
{
public:
  static vtkObjectBaseHashMap* New (void);
  vtkTypeRevisionMacro (vtkObjectBaseHashMap, vtkAssociativeContainer);
  void PrintSelf (ostream&, vtkIndent);

  virtual vtkIdType     GetSize (void) const;
  virtual int           IsEmpty (void) const;
  virtual vtkIdType     GetMaxSize (void) const;
  virtual int           Clear (void);

  virtual int           Swap (vtkObjectBaseHashMap*  container);

  virtual int           Copy (vtkObjectBaseHashMap* container);

  vtkIdType             GetCapacity (void) const;

  int                   GetCheckUnique (void) const;
  void                  SetCheckUnique (int a);
  int                   GetCheckCase (void) const;
  void                  SetCheckCase (int a);
  vtkObjectBase*        Find (const char*       key) const;

  int                   Insert (const char*     key,
                                vtkObjectBase*  item);

  int                   Erase (const char*      key);

  const char*           FindKey (const vtkObjectBase* item);

  const char*           FindNextKey (void);

  vtkObjectBase*        Front (void) const;

  virtual int           Front (const char*    & key,
                               vtkObjectBase* & item) const;

  vtkObjectBase*        Back (void) const;

  virtual int           Back (const char*    &  key,
                              vtkObjectBase* &  item) const;
  vtkObjectBaseHashMapIterator* CreateIterator (void);

protected:
  vtkObjectBaseHashMap (void);
  ~vtkObjectBaseHashMap();

  void  ReportReferences (vtkGarbageCollector*);

private:
  //BTX
  vtkObjectBaseHashMapInternal* Internal;

  friend class vtkObjectBaseHashMapIterator;

  int Swap (vtkAssociativeContainer* a)
    { return this->Swap(static_cast<vtkObjectBaseHashMap*>(a)); }
  int Copy (vtkAssociativeContainer* a)
    { return this->Copy(static_cast<vtkObjectBaseHashMap*>(a)); }
  //ETX

private:
  vtkObjectBaseHashMap (const vtkObjectBaseHashMap&);
  void operator= (const vtkObjectBaseHashMap&);
};

#endif /* VTK_OBJECT_BASE_HASH_MAP_H_ */
/*
 * End of: $Id: vtkObjectBaseHashMap.h,v 1.3 2005/06/24 23:17:16 xpxqx Exp $
 *
 */

---