BaseMap.h

Go to the documentation of this file.

// -*-Mode: C++;-*-
// $Header: /Volumes/cvsrep/developer/OpenADFortTk/src/lib/support/BaseMap.h,v 1.4 2004/12/08 22:09:28 eraxxon Exp $

// * BeginCopyright *********************************************************
// *********************************************************** EndCopyright *

//***************************************************************************
//
// File:
//   $Source: /Volumes/cvsrep/developer/OpenADFortTk/src/lib/support/BaseMap.h,v $
//
// Purpose:
//   [The purpose of this file]
//
// Description:
//   [The set of functions, macros, etc. defined in the file]
//
//***************************************************************************

#ifndef BaseMap_H 
#define BaseMap_H

//************************** System Include Files ***************************

#include <map>

//*************************** User Include Files ****************************

#include "Diagnostics.h"

//************************** Forward Declarations ***************************

//***************************************************************************
// BaseMap
//***************************************************************************

namespace fortTkSupport {

// BaseMap: abstract map routines
// Note: FromTy and ToTy should be pointers (or unsigned integers)!
template <class FromTy, class ToTy>
class BaseMap : public std::map<FromTy, ToTy>
{
public:
  BaseMap() { }
  virtual ~BaseMap() { }
  
  // Find: Given x, find y if x --> y.
  virtual ToTy 
  Find(const FromTy x, bool mustFind = false) const
  {
    typename std::map<FromTy, ToTy>::const_iterator it = std::map<FromTy, ToTy>::find(x);
    ToTy y = (it == this->end()) ? 0 /*NULL*/ : (*it).second;
    
    if (mustFind && y == 0 /*NULL*/) {
      FORTTK_MSG(0,"BaseMap: Could not find entry for key '" << x << "' dumping map");
      Dump();
      FORTTK_DIE("BaseMap: Could not find entry for key '" << x << "'");
    }
    
    return y;
  }
  
  // Insert: insert the <x,y> pair in the map and return true; if
  // x is already a member, the operation fails and returns false.
  virtual bool 
  Insert(FromTy x, ToTy y) {
    pair<typename std::map<FromTy, ToTy>::iterator, bool> p = 
      insert(make_pair(x, y)); // std::map<FromTy, ToTy>::value_type
    return p.second;
  }
  
  // Dump: Dump that integer values in the map
  virtual void Dump(std::ostream& o = std::cerr) const {
    o << "{ Map (" << this << ")\n";
    for (typename std::map<FromTy, ToTy>::const_iterator it = this->begin(); 
         it != this->end(); ++it) {
      o << "(" << it->first << " --> " << it->second << ")\n";
    }
    o << "}\n";
    o.flush();
  }
  
  virtual void DDump() const {
    Dump(std::cerr);
  }

protected:
};

} // FortTk

//***************************************************************************

#endif