]> Creatis software - gdcm.git/blobdiff - src/gdcmDict.cxx
* src/gdcmDictSet.h : set the method BuildDictPath in public
[gdcm.git] / src / gdcmDict.cxx
index 70768a0d0afd73d23c7f86ddb242e67f6bbb3ce9..25de9bba0d7bd277b6c53caa0bc34d37a1c6893a 100644 (file)
 // gdcmDict.cxx
 
-#include <fstream>
-#include "gdcm.h"
+#include "gdcmDict.h"
 #include "gdcmUtil.h"
+#include <fstream>
 
-gdcmDict::gdcmDict(const char* FileName) {
-       std::ifstream from(FileName);
-       dbg.Error(!from, "gdcmDict::gdcmDict: can't open dictionary", FileName);
-       guint16 group, element;
+/**
+ * \ingroup gdcmDict
+ * \brief   Construtor
+ * @param   FileName from which to build the dictionary.
+ */
+gdcmDict::gdcmDict(std::string & FileName) {
+   std::ifstream from(FileName.c_str());
+   dbg.Error(!from, "gdcmDict::gdcmDict: can't open dictionary",
+                    FileName.c_str());
+   guint16 group, element;
        // CLEANME : use defines for all those constants
-       char buff[1024];
-       TagKey key, vr, fourth, name;
-       while (!from.eof()) {
-               from >> hex >> group >> element;
-               eatwhite(from);
-               from.getline(buff, 256, ' ');
-               vr = buff;
-               eatwhite(from);
-               from.getline(buff, 256, ' ');
-               fourth = buff;
-               from.getline(buff, 256, '\n');
-               name = buff;
-               gdcmDictEntry * newEntry = new gdcmDictEntry(group, element,
-                                                        vr, fourth, name);
-               entries[gdcmDictEntry::TranslateToKey(group, element)] = newEntry;
-       }
+   char buff[1024];
+   TagKey key;
+   TagName vr;
+   TagName fourth;
+   TagName name;
+
+   while (!from.eof()) {
+      from >> std::hex >> group >> element;
+      eatwhite(from);
+      from.getline(buff, 256, ' ');
+      vr = buff;
+      eatwhite(from);
+      from.getline(buff, 256, ' ');
+      fourth = buff;
+      from.getline(buff, 256, '\n');
+      name = buff;
+      gdcmDictEntry * newEntry = new gdcmDictEntry(group, element,
+                                                  vr, fourth, name);
+      // FIXME: use AddNewEntry
+      NameHt[name] = newEntry;
+      KeyHt[gdcmDictEntry::TranslateToKey(group, element)] = newEntry;
+   }
    from.close();
 }
 
-void gdcmDict::Print(ostream& os) {
-       for (TagHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){
-       os << "Tag : ";
-       os << "(" << hex << tag->second->GetGroup() << ',';
-       os << hex << tag->second->GetElement() << ") = " << dec;
-       os << tag->second->GetVR() << ", ";
-       os << tag->second->GetFourth() << ", ";
-       os << tag->second->GetName() << "."  << endl;
-    }
+/**
+ * \ingroup gdcmDict
+ * \brief   
+ */
+gdcmDict::~gdcmDict() {
+   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) {
+      gdcmDictEntry* EntryToDelete = tag->second;
+      if ( EntryToDelete )
+         delete EntryToDelete;
+   }
+   KeyHt.clear();
+   // Since AddNewEntry adds symetrical in both KeyHt and NameHT we can
+   // assume all the pointed gdcmDictEntries are already cleaned-up when
+   // we cleaned KeyHt.
+   NameHt.clear();
 }
 
-// renvoie une ligne de Dictionnaire Dicom à partir de (numGroup, numElement)
+/**
+ * \ingroup gdcmDict
+ * \brief   
+ * @param   os
+ */
+void gdcmDict::Print(std::ostream& os) {
+   PrintByKey(os);
+}
 
-gdcmDictEntry * gdcmDict::GetTag(guint32 group, guint32 element) {
-       TagKey key = gdcmDictEntry::TranslateToKey(group, element);
-       if ( ! entries.count(key))
-               return (gdcmDictEntry*)0; 
-       if (entries.count(key) > 1)
-               dbg.Verbose(0, "gdcmDict::GetTag", 
-                           "multiple entries for this key (FIXME) !");
-       return entries.find(key)->second;
+/**
+ * \ingroup gdcmDict
+ * \brief   Print all the dictionary entries contained in this dictionary.
+ *          Entries will be sorted by tag i.e. the couple (group, element).
+ * @param   os The output stream to be written to.
+ */
+void gdcmDict::PrintByKey(std::ostream& os) {
+   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag){
+      os << "Tag : ";
+      os << "(" << std::hex << tag->second->GetGroup() << ',';
+      os << std::hex << tag->second->GetElement() << ") = " << std::dec;
+      os << tag->second->GetVR() << ", ";
+      os << tag->second->GetFourth() << ", ";
+      os << tag->second->GetName() << "."  << std::endl;
+   }
 }
 
+/**
+ * \ingroup gdcmDict
+ * \brief   Print all the dictionary entries contained in this dictionary.
+ *          Entries will be sorted by the name of the dictionary entries.
+ * @param   os The output stream to be written to.
+ */
+void gdcmDict::PrintByName(std::ostream& os) {
+   for (TagNameHT::iterator tag = NameHt.begin(); tag != NameHt.end(); ++tag){
+      os << "Tag : ";
+      os << tag->second->GetName() << ",";
+      os << tag->second->GetVR() << ", ";
+      os << tag->second->GetFourth() << ", ";
+      os << "(" << std::hex << tag->second->GetGroup() << ',';
+      os << std::hex << tag->second->GetElement() << ") = " << std::dec << std::endl;
+   }
+}
 
-int gdcmDict::ReplaceEntry(gdcmDictEntry* NewEntry) {
+/**
+ * \ingroup gdcmDict
+ * \brief   Get the dictionnary entry identified by a given tag (group,element)
+ * @param   group   group of the entry to be found
+ * @param   element element of the entry to be found
+ * @return  the corresponding dictionnary entry when existing, NULL otherwise
+ */
+gdcmDictEntry * gdcmDict::GetTagByNumber(guint16 group, guint16 element) {
+   TagKey key = gdcmDictEntry::TranslateToKey(group, element);
+   if ( ! KeyHt.count(key))
+      return (gdcmDictEntry*)0; 
+   return KeyHt.find(key)->second;
+}
 
-       // au cas ou la NewEntry serait incomplete
-       // Question : cela peut-il se produire ?
-       //
-       // --> NON : voir constructeur
-       //TagKey key;
-       //key = NewEntry->GetKey();
-       //if (key =="") {
-       //      NewEntry->gdcmDictEntry::SetKey(
-       //                      gdcmDictEntry::TranslateToKey(NewEntry->GetGroup(), NewEntry->GetElement())
-       //                      );
-       //}
-       
-       entries.erase (NewEntry->gdcmDictEntry::GetKey());
-       entries[ NewEntry->GetKey()] = NewEntry;
-       return (1);
-       // Question : Dans quel cas ça peut planter ?
+/**
+ * \ingroup gdcmDict
+ * \brief   Get the dictionnary entry identified by it's name.
+ * @param   name element of the ElVal to modify
+ * @return  the corresponding dictionnary entry when existing, NULL otherwise
+ */
+gdcmDictEntry * gdcmDict::GetTagByName(TagName name) {
+   if ( ! NameHt.count(name))
+      return (gdcmDictEntry*)0; 
+   return NameHt.find(name)->second;
 }
 
-int gdcmDict::AddNewEntry(gdcmDictEntry* NewEntry) {
+/**
+ * \ingroup gdcmDict
+ * \brief   
+ * @param   NewEntry
+ * @return  
+ */
+int gdcmDict::ReplaceEntry(gdcmDictEntry* NewEntry) {
+   if ( RemoveEntry(NewEntry->gdcmDictEntry::GetKey()) ) {
+       KeyHt[ NewEntry->GetKey()] = NewEntry;
+       return (1);
+   } 
+   return (0);
+}
 
-       TagKey key;
-       key = NewEntry->GetKey();
+/**
+ * \ingroup gdcmDict
+ * \brief   
+ * @param   NewEntry
+ * @return  
+ */
+ int gdcmDict::AddNewEntry(gdcmDictEntry* NewEntry) {
+   TagKey key;
+   key = NewEntry->GetKey();
        
-       if(entries.count(key) >= 1) {
-               printf("gdcmDict::AddNewEntry %s deja present\n", key.c_str());
-               return(0);
-       } else {
-               entries[NewEntry->GetKey()] = NewEntry;
-               return(1);
-       }
-       }
-
-
-int gdcmDict::RemoveEntry(TagKey key) {        
-       if(entries.count(key) == 1) {
-               entries.erase(key);
-               return (1);
-       } else {
-               printf("gdcmDict::RemoveEntry %s non trouve\n", key.c_str());
-               return (0);
-       }
+   if(KeyHt.count(key) == 1) {
+      dbg.Verbose(1, "gdcmDict::AddNewEntry already present", key.c_str());
+      return(0);
+   } else {
+      KeyHt[NewEntry->GetKey()] = NewEntry;
+      return(1);
+   }
 }
 
+/**
+ * \ingroup gdcmDict
+ * \brief   
+ * @param   key
+ * @return  
+ */
+int gdcmDict::RemoveEntry(TagKey key) {
+   if(KeyHt.count(key) == 1) {
+      gdcmDictEntry* EntryToDelete = KeyHt.find(key)->second;
+      if ( EntryToDelete )
+         delete EntryToDelete;
+      KeyHt.erase(key);
+      return (1);
+   } else {
+      dbg.Verbose(1, "gdcmDict::RemoveEntry unfound entry", key.c_str());
+      return (0);
+  }
+}
 
+/**
+ * \ingroup gdcmDict
+ * \brief   
+ * @param   group 
+ * @param   element
+ * @return  
+ */
 int gdcmDict::RemoveEntry (guint16 group, guint16 element) {
-
        return( RemoveEntry(gdcmDictEntry::TranslateToKey(group, element)) );
 }