]> Creatis software - gdcm.git/blobdiff - src/gdcmDict.cxx
Modif to be RedHat 7.3 compliant (?!)
[gdcm.git] / src / gdcmDict.cxx
index 725d2d6c85d566f884de9b8acfc0a7f16fbad846..e15c5ded5402c9fd9b3a8e0054f91f29f888ac68 100644 (file)
@@ -2,7 +2,11 @@
 //-----------------------------------------------------------------------------
 #include "gdcmDict.h"
 #include "gdcmUtil.h"
+
 #include <fstream>
+#include <iostream>
+#include <iomanip>
+
 #ifdef GDCM_NO_ANSI_STRING_STREAM
 #  include <strstream>
 #  define  ostringstream ostrstream
  * @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;
    TagName vr;
    TagName fourth;
    TagName name;
 
+   std::ifstream from(FileName.c_str());
+   dbg.Error(!from, "gdcmDict::gdcmDict: can't open dictionary",
+                    FileName.c_str());
+
    while (!from.eof()) {
       from >> std::hex >> group >> element;
       eatwhite(from);
@@ -39,13 +42,14 @@ gdcmDict::gdcmDict(std::string & FileName) {
       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;
+      AddNewEntry(newEntry);
    }
    from.close();
+
+   filename=FileName;
 }
 
 /**
@@ -58,10 +62,11 @@ gdcmDict::~gdcmDict() {
       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.
+   KeyHt.clear();
    NameHt.clear();
 }
 
@@ -72,7 +77,8 @@ gdcmDict::~gdcmDict() {
  *          Entries will be sorted by tag i.e. the couple (group, element).
  * @param   os The output stream to be written to.
  */
-void gdcmDict::Print(std::ostream& os) {
+void gdcmDict::Print(std::ostream &os) {
+   os<<"Dict file name : "<<filename<<std::endl;
    PrintByKey(os);
 }
 
@@ -82,13 +88,13 @@ void gdcmDict::Print(std::ostream& os) {
  *          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::ostreamos) {
+void gdcmDict::PrintByKey(std::ostream &os) {
    std::ostringstream s;
 
    for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag){
-      s << "Tag : ";
-      s << "(" << std::hex << tag->second->GetGroup() << ',';
-      s << std::hex << tag->second->GetElement() << ") = " << std::dec;
+      s << "Entry : ";
+      s << "(" << std::hex << std::setw(4) << tag->second->GetGroup() << ',';
+      s << std::hex << std::setw(4) << tag->second->GetElement() << ") = " << std::dec;
       s << tag->second->GetVR() << ", ";
       s << tag->second->GetFourth() << ", ";
       s << tag->second->GetName() << "."  << std::endl;
@@ -108,12 +114,13 @@ void gdcmDict::PrintByName(std::ostream& os) {
    std::ostringstream s;
 
    for (TagNameHT::iterator tag = NameHt.begin(); tag != NameHt.end(); ++tag){
-      s << "Tag : ";
+      s << "Entry : ";
       s << tag->second->GetName() << ",";
       s << tag->second->GetVR() << ", ";
       s << tag->second->GetFourth() << ", ";
-      s << "(" << std::hex << tag->second->GetGroup() << ',';
-      s << std::hex << tag->second->GetElement() << ") = " << std::dec << std::endl;
+      s << "(" << std::hex << std::setw(4) << tag->second->GetGroup() << ',';
+      s << std::hex << std::setw(4) << tag->second->GetElement() << ") = ";
+      s << std::dec << std::endl;
    }
    os << s.str();
 }
@@ -126,15 +133,20 @@ void gdcmDict::PrintByName(std::ostream& os) {
  * @param   NewEntry 
  * @return  false if Dicom Element already existed
  */
- bool gdcmDict::AddNewEntry(gdcmDictEntry* NewEntry) {
+bool gdcmDict::AddNewEntry(gdcmDictEntry *NewEntry) 
+{
    TagKey key;
    key = NewEntry->GetKey();
        
-   if(KeyHt.count(key) == 1) {
+   if(KeyHt.count(key) == 1)
+   {
       dbg.Verbose(1, "gdcmDict::AddNewEntry already present", key.c_str());
       return(false);
-   } else {
+   } 
+   else 
+   {
       KeyHt[NewEntry->GetKey()] = NewEntry;
+      NameHt[NewEntry->GetName()] = NewEntry;
       return(true);
    }
 }
@@ -145,9 +157,10 @@ void gdcmDict::PrintByName(std::ostream& os) {
  * @param   NewEntry
  * @return  false if Dicom Element doesn't exist
  */
-bool gdcmDict::ReplaceEntry(gdcmDictEntryNewEntry) {
+bool gdcmDict::ReplaceEntry(gdcmDictEntry *NewEntry) {
    if ( RemoveEntry(NewEntry->gdcmDictEntry::GetKey()) ) {
-       KeyHt[ NewEntry->GetKey()] = NewEntry;
+       KeyHt[NewEntry->GetKey()] = NewEntry;
+       NameHt[NewEntry->GetName()] = NewEntry;
        return (true);
    } 
    return (false);
@@ -160,14 +173,23 @@ bool gdcmDict::ReplaceEntry(gdcmDictEntry* NewEntry) {
  * @param   key (group|element)
  * @return  false if Dicom Dictionary Entry doesn't exist
  */
-bool gdcmDict::RemoveEntry(TagKey key) {
-   if(KeyHt.count(key) == 1) {
+bool gdcmDict::RemoveEntry(TagKey key) 
+{
+   if(KeyHt.count(key) == 1) 
+   {
       gdcmDictEntry* EntryToDelete = KeyHt.find(key)->second;
+
       if ( EntryToDelete )
+      {
+         NameHt.erase(EntryToDelete->GetName());
          delete EntryToDelete;
+      }
+
       KeyHt.erase(key);
       return (true);
-   } else {
+   } 
+   else 
+   {
       dbg.Verbose(1, "gdcmDict::RemoveEntry unfound entry", key.c_str());
       return (false);
   }
@@ -186,6 +208,21 @@ bool gdcmDict::RemoveEntry (guint16 group, guint16 element) {
        return( RemoveEntry(gdcmDictEntry::TranslateToKey(group, element)) );
 }
 
+/**
+ * \ingroup gdcmDict
+ * \brief   Get the dictionnary entry identified by it's name.
+ * @param   name element of the ElVal to modify
+ * \warning : NEVER use it !
+ *            the 'name' IS NOT an identifier within the Dicom Dicom Dictionary
+ *            the name MAY CHANGE between two versions !
+ * @return  the corresponding dictionnary entry when existing, NULL otherwise
+ */
+gdcmDictEntry *gdcmDict::GetDictEntryByName(TagName name) {
+   if ( ! NameHt.count(name))
+      return NULL; 
+   return NameHt.find(name)->second;
+}
+
 /**
  * \ingroup gdcmDict
  * \brief   Get the dictionnary entry identified by a given tag (group,element)
@@ -193,26 +230,63 @@ bool gdcmDict::RemoveEntry (guint16 group, guint16 element) {
  * @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) {
+gdcmDictEntry *gdcmDict::GetDictEntryByNumber(guint16 group, guint16 element) {
    TagKey key = gdcmDictEntry::TranslateToKey(group, element);
    if ( ! KeyHt.count(key))
-      return (gdcmDictEntry*)0
+      return NULL
    return KeyHt.find(key)->second;
 }
 
-/**
+/** 
  * \ingroup gdcmDict
- * \brief   Get the dictionnary entry identified by it's name.
- * @param   name element of the ElVal to modify
- * \warning : NEVER use it !
- *            the 'name' IS NOT an identifier within the Dicom Dicom Dictionary
- *            the name MAY CHANGE between two versions !
- * @return  the corresponding dictionnary entry when existing, NULL otherwise
+ * \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.
  */
-gdcmDictEntry * gdcmDict::GetTagByName(TagName name) {
-   if ( ! NameHt.count(name))
-      return (gdcmDictEntry*)0; 
-   return NameHt.find(name)->second;
+std::list<std::string> *gdcmDict::GetDictEntryNames(void) 
+{
+   std::list<std::string> *Result = new std::list<std::string>;
+   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
+   {
+      Result->push_back( tag->second->GetName() );
+   }
+   return Result;
+}
+
+/** 
+ * \ingroup gdcmDict
+ * \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> > *gdcmDict::GetDictEntryNamesByCategory(void) 
+{
+   std::map<std::string, std::list<std::string> > *Result = new std::map<std::string, std::list<std::string> >;
+
+   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
+   {
+      (*Result)[tag->second->GetFourth()].push_back(tag->second->GetName());
+   }
+   return Result;
 }
 
 //-----------------------------------------------------------------------------