/*=========================================================================
                                                                                
  Program:   gdcm
  Module:    $RCSfile: gdcmDictSet.h,v $
  Language:  C++
  Date:      $Date: 2004/10/12 04:35:45 $
  Version:   $Revision: 1.27 $
                                                                                
  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  l'Image). All rights reserved. See Doc/License.txt or
  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.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 notices for more information.
                                                                                
=========================================================================*/

#ifndef GDCMDICTSET_H
#define GDCMDICTSET_H

#include "gdcmDict.h"
#include <map>
#include <list>
namespace gdcm 
{

typedef std::string DictKey;
typedef std::map<DictKey, Dict*> DictSetHT;

//-----------------------------------------------------------------------------
/*
 * \defgroup DictSet
 * \brief  Container for managing a set of loaded dictionaries.
 * \note   Hopefully, sharing dictionaries should avoid
 * \par    reloading an already loaded dictionary (saving time)
 * \par    having many in memory representations of the same dictionary
 *        (saving memory).
 */
class GDCM_EXPORT DictSet
{
public:
   DictSet();
   ~DictSet();

   void Print(std::ostream& os);

   std::list<std::string>* GetPubDictEntryNames();
   std::map<std::string, std::list<std::string> > *
       GetPubDictEntryNamesByCategory();

   Dict* LoadDictFromFile( std::string const & fileName,
                               DictKey const & name );

   Dict* GetDict( DictKey const & DictName );

   /// \brief   Retrieve the default reference DICOM V3 public dictionary.
   Dict* GetDefaultPubDict() { return GetDict(PUB_DICT_NAME); };

   // \brief   Retrieve the virtual reference DICOM dictionary.
   // \warning : not end user intended
   // Dict* GetVirtualDict() { return &VirtualEntry; };

   DictEntry* NewVirtualDictEntry(uint16_t group, uint16_t element,
                                      std::string vr     = "Unknown",
                                      std::string fourth = "Unknown",
                                      std::string name   = "Unknown");

   static std::string BuildDictPath();

protected:
   bool AppendDict(Dict *NewDict, DictKey const & name);

private:
   /// Hash table of all dictionaries contained in this DictSet
   DictSetHT Dicts;
   /// Directory path to dictionaries
   std::string DictPath;
   /// H table for the on the fly created DictEntries  
   TagKeyHT VirtualEntry; 
};
} // end namespace gdcm

//-----------------------------------------------------------------------------
#endif