]> Creatis software - gdcm.git/blobdiff - src/gdcmDictSet.cxx
Fix mistypings
[gdcm.git] / src / gdcmDictSet.cxx
index 518eb728deebc892d337aa7d1ef36aa6d573c582..b173a08846f7dfeec47b4e6a08a74b8d41c863e6 100644 (file)
-// gdcmDictEntry
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDictSet.cxx,v $
+  Language:  C++
+  Date:      $Date: 2007/05/23 14:18:09 $
+  Version:   $Revision: 1.78 $
+                                                                                
+  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.
+                                                                                
+=========================================================================*/
+
 #include "gdcmDictSet.h"
-#include "gdcmUtil.h"
+#include "gdcmDebug.h"
+#include "gdcmGlobal.h"
 #include <fstream>
 #include <stdlib.h>  // For getenv
+#include <stdio.h>   // For sprintf
 
-#define PUB_DICT_NAME     "DicomV3Dict"
-#ifndef PUB_DICT_PATH
-#  define PUB_DICT_PATH     "../Dicts/"
-#endif
-#define PUB_DICT_FILENAME "dicomV3.dic"
+namespace GDCM_NAME_SPACE 
+{
 
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /** 
- * \ingroup gdcmDictSet
- * \brief   The Dictionnary Set obtained with this constructor simply
- *          contains the Default Public dictionnary.
+ * \brief   The Dictionary Set obtained with this constructor simply
+ *          contains the Default Public dictionary.
  */
-gdcmDictSet::gdcmDictSet(void
+DictSet::DictSet(
 {
    DictPath = BuildDictPath();
-   std::string PubDictFile = DictPath + PUB_DICT_FILENAME;
-   Dicts[PUB_DICT_NAME] = new gdcmDict(PubDictFile);
+   std::string pubDictFile(DictPath);
+   pubDictFile += PUB_DICT_FILENAME;
+   Dicts[PUB_DICT_NAME] = Dict::New(pubDictFile);
+   // Stored redundantly to avoid at access HTable DictSet every time.
+   Global::DefaultPubDict = Dicts[PUB_DICT_NAME];
 }
 
 /**
- * \ingroup gdcmDictSet
  * \brief  Destructor 
  */
-gdcmDictSet::~gdcmDictSet() 
+DictSet::~DictSet() 
 {
-   // Remove dictionnaries
+   Global::DefaultPubDict = 0; // just a pointer!
+   // Remove dictionaries
    for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) 
    {
-      gdcmDict *EntryToDelete = tag->second;
-      if ( EntryToDelete )
-         delete EntryToDelete;
-      tag->second=NULL;
+      if ( tag->second )
+         tag->second->Delete();
    }
    Dicts.clear();
-
-   // Remove virtual dictionnary entries
-   std::map<std::string,gdcmDictEntry *>::iterator it;
-   for(it=virtualEntry.begin(); it!=virtualEntry.end(); ++it)
-   {
-      gdcmDictEntry *Entry = it->second;
-      if ( Entry )
-         delete Entry;
-      it->second=NULL;
-   }
-}
-
-//-----------------------------------------------------------------------------
-// Print
-/**
- * \ingroup gdcmDictSet
- * \brief   Print, in an informal fashion, the list of all the dictionaries
- *          contained is this gdcmDictSet, along with their respective content.
- * @param   os Output stream used for printing.
- */
-void gdcmDictSet::Print(std::ostream& os) 
-{
-   for (DictSetHT::iterator dict = Dicts.begin(); dict != Dicts.end(); ++dict)
-   {
-      os << "Printing dictionary " << dict->first << std::endl;
-      dict->second->Print(os);
-   }
 }
 
 //-----------------------------------------------------------------------------
 // Public
-/** 
- * \ingroup gdcmDictSet
- * \brief   Consider all the entries of the public dicom dictionnary. 
- *          Build all list of all the tag names of all those entries.
- * \sa      gdcmDictSet::GetPubDictTagNamesByCategory
- * @return  A list of all entries of the public dicom dictionnary.
- */
-std::list<std::string> *gdcmDictSet::GetPubDictEntryNames(void) 
-{
-   return(GetDefaultPubDict()->GetDictEntryNames());
-}
-
-/** 
- * \ingroup gdcmDictSet
- * \brief   Consider all the entries of the public dicom dictionnary.
- *          Build an hashtable whose keys are the names of the groups
- *          (fourth field in each line of dictionary) and whose corresponding
- *          values are lists of all the dictionnary entries among that
- *          group. Note that apparently the Dicom standard doesn't explicitely
- *          define a name (as a string) for each group.
- *          A typical usage of this method would be to enable a dynamic
- *          configuration of a Dicom file browser: the admin/user can
- *          select in the interface which Dicom tags should be displayed.
- * \warning Dicom *doesn't* define any name for any 'categorie'
- *          (the dictionnary fourth field was formerly NIH defined
- *           - and no longer he is-
- *           and will be removed when Dicom provides us a text file
- *           with the 'official' Dictionnary, that would be more friendly
- *           than asking us to perform a line by line check of the dictionnary
- *           at the beginning of each year to -try to- guess the changes)
- *           Therefore : please NEVER use that fourth field :-(
- * *
- * @return  An hashtable: whose keys are the names of the groups and whose
- *          corresponding values are lists of all the dictionnary entries
- *          among that group.
- */
-std::map<std::string, std::list<std::string> > *gdcmDictSet::GetPubDictEntryNamesByCategory(void) 
-{
-   return(GetDefaultPubDict()->GetDictEntryNamesByCategory());
-}
-
 /**
- * \ingroup gdcmDictSet
  * \brief   Loads a dictionary from a specified file, and add it
- *          to already the existing ones contained in this gdcmDictSet.
- * @param   FileName Absolute or relative filename containing the
+ *          to already the existing ones contained in this DictSet.
+ * @param   filename Absolute or relative filename containing the
  *          dictionary to load.
- * @param   Name Symbolic name that be used as identifier of the newly 
+ * @param   name Symbolic name that be used as identifier of the newly 
  *          created dictionary.
  */
-gdcmDict *gdcmDictSet::LoadDictFromFile(std::string FileName, DictKey Name) 
+Dict *DictSet::LoadDictFromFile(std::string const &filename, 
+                                DictKey const &name) 
 {
-   gdcmDict *NewDict = new gdcmDict(FileName);
-   AppendDict(NewDict,Name);
-   return(NewDict);
+   assert(Dicts.find(name)==Dicts.end());
+   ///\todo RemoveDict(name); when Dict already exist
+   Dict *newDict = Dict::New(filename);
+   Dicts[name] = newDict;
+
+   return newDict;
 }
 
 /**
- * \ingroup gdcmDictSet
  * \brief   Retrieve the specified dictionary (when existing) from this
- *          gdcmDictSet.
- * @param   DictName The symbolic name of the searched dictionary.
+ *          DictSet.
+ * @param   dictName The symbolic name of the searched dictionary.
  * \result  The retrieved dictionary.
  */
-gdcmDict *gdcmDictSet::GetDict(DictKey DictName) 
+Dict *DictSet::GetDict(DictKey const &dictName) 
 {
-   DictSetHT::iterator dict = Dicts.find(DictName);
-   if(dict!=Dicts.end())
+   DictSetHT::iterator dict = Dicts.find(dictName);
+   if ( dict != Dicts.end() )
+   {
       return dict->second;
+   }
    return NULL;
 }
 
 /**
- * \ingroup gdcmDictSet
- * \brief   Retrieve the default reference DICOM V3 public dictionary.
- * \result  The retrieved default dictionary.
+ * \brief   Get the first dictionary while visiting the DictSet
+ * \return  The first Dict if found, otherwhise NULL
  */
-gdcmDict *gdcmDictSet::GetDefaultPubDict() 
+Dict *DictSet::GetFirstDict()
 {
-   return GetDict(PUB_DICT_NAME);
+   ItDictHt = Dicts.begin();
+   if ( ItDictHt != Dicts.end() )
+      return ItDictHt->second;
+   return NULL;
 }
 
 /**
- * \ingroup gdcmDictSet
- * \brief   Create a gdcmDictEntry which will be reference 
- *          in no dictionnary
- * @return  virtual entry
+ * \brief   Get the next dictionary while visiting the Hash table (DictSetHT)
+ * \note : meaningfull only if GetFirstEntry already called
+ * \return  The next Dict if found, otherwhise NULL
  */
-gdcmDictEntry *gdcmDictSet::NewVirtualDictEntry(guint16 group, guint16 element,
-                                                std::string vr,std::string fourth,
-                                                std::string name)
+Dict *DictSet::GetNextDict()
 {
-   gdcmDictEntry *entry;
-   std::string tag=gdcmDictEntry::TranslateToKey(group,element)+"#"+vr+"#"+fourth+"#"+name;
-   std::map<std::string,gdcmDictEntry *>::iterator it;
-   
-   it=virtualEntry.find(tag);
-   if(it!=virtualEntry.end())
-   {
-      entry=it->second;
-   }
-   else
-   {
-      entry=new gdcmDictEntry(group,element,vr,fourth,name);
-      virtualEntry[tag]=entry;
-   }
-   return(entry);
+   gdcmAssertMacro (ItDictHt != Dicts.end());
+  
+   ++ItDictHt;
+   if ( ItDictHt != Dicts.end() )
+      return ItDictHt->second;
+   return NULL;
 }
 
 /**
- * \ingroup gdcmDictSet
  * \brief   Obtain from the GDCM_DICT_PATH environnement variable the
- *          path to directory containing the dictionnaries. When
+ *          path to directory containing the dictionaries. When
  *          the environnement variable is absent the path is defaulted
  *          to "../Dicts/".
- * @return  path to directory containing the dictionnaries
+ * @return  path to directory containing the dictionaries
  */
-std::string gdcmDictSet::BuildDictPath(void) 
+std::string DictSet::BuildDictPath()
 {
-   std::string ResultPath;
-   const char *EnvPath = (char*)0;
-   EnvPath = getenv("GDCM_DICT_PATH");
-   if (EnvPath && (strlen(EnvPath) != 0)) 
+   std::string resultPath;
+   const char *envPath = getenv("GDCM_DICT_PATH");
+
+   if (envPath && (strlen(envPath) != 0))
    {
-      ResultPath = EnvPath;
-      if (ResultPath[ResultPath.length() -1] != '/' )
-         ResultPath += '/';
-      dbg.Verbose(1, "gdcmDictSet::BuildDictPath:",
-                     "Dictionary path set from environnement");
-   } 
+      resultPath = envPath;
+      gdcmStaticWarningMacro( "Dictionary path set from environnement");
+   }
    else
-      ResultPath = PUB_DICT_PATH;
-   return ResultPath;
+   {
+      resultPath = PUB_DICT_PATH;
+   }
+   if ( resultPath.length() && resultPath[resultPath.length()-1] != '/' )
+   {
+      resultPath += '/';
+   }
+   return resultPath;
 }
 
 //-----------------------------------------------------------------------------
 // Protected
-bool gdcmDictSet::AppendDict(gdcmDict *NewDict,DictKey Name)
-{
-   Dicts[Name] = NewDict;
-   return(true);
-}
 
 //-----------------------------------------------------------------------------
 // Private
 
 //-----------------------------------------------------------------------------
+// Print
+/**
+ * \brief   Print, in an informal fashion, the list of all the dictionaries
+ *          contained is this DictSet, along with their respective content.
+ * @param   os Output stream used for printing.
+ * @param indent Indentation string to be prepended during printing
+ */
+void DictSet::Print(std::ostream &os, std::string const & )
+{
+   for (DictSetHT::iterator dict = Dicts.begin(); dict != Dicts.end(); ++dict)
+   {
+      os << "Printing dictionary " << dict->first << std::endl;
+      dict->second->Print(os);
+   }
+}
 
-
+//-----------------------------------------------------------------------------
+} // end namespace gdcm