]> Creatis software - gdcm.git/blobdiff - src/gdcmDict.cxx
STYLE: Fix some comment also rework the include stuff
[gdcm.git] / src / gdcmDict.cxx
index 8662d1513c4e2901bb85f18edac83bc0e6a3eeeb..027ce31a3653d6d097ad19863e5eb863c166d62b 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDict.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/10/18 02:17:06 $
-  Version:   $Revision: 1.46 $
+  Date:      $Date: 2005/01/14 11:28:30 $
+  Version:   $Revision: 1.63 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 
 namespace gdcm 
 {
-
+void FillDefaultDataDict(Dict *d);
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \brief   Construtor
+ * \brief   Constructor
+ */
+Dict::Dict(void)
+{
+   Filename="";
+}
+
+/**
+ * \brief   Constructor
  * @param   filename from which to build the dictionary.
  */
-Dict::Dict(std::string const & filename)
+Dict::Dict(std::string const &filename)
 {
    uint16_t group;
    uint16_t element;
    TagName vr;
-   TagName fourth;
+   TagName vm;
    TagName name;
 
    std::ifstream from( filename.c_str() );
-   dbg.Error(!from, "Dict::Dict: can't open dictionary",
-                    filename.c_str());
-
-   while (!from.eof())
+   if( !from )
    {
-      from >> std::hex;
-      from >> group;
-      from >> element;
-      from >> vr;
-      from >> fourth;
-      from >> std::ws;  //remove white space
-      std::getline(from, name);
-
-      DictEntry * newEntry = new DictEntry(group, element, vr, fourth, name);
-      AddNewEntry(newEntry);
+      gdcmVerboseMacro( "Can't open dictionary" << filename.c_str());
+      // Using default embeded one:
+      FillDefaultDataDict( this );
    }
-   from.close();
+   else
+   {
+      while (!from.eof())
+      {
+         from >> std::hex;
+         from >> group;
+         from >> element;
+         from >> vr;
+         from >> vm;
+         from >> std::ws;  //remove white space
+         std::getline(from, name);
+   
+         const DictEntry newEntry(group, element, vr, vm, name);
+         AddNewEntry(newEntry);
+      }
 
-   Filename = filename;
+      Filename = filename;
+      from.close();
+   }
 }
 
 /**
@@ -68,19 +82,7 @@ Dict::Dict(std::string const & filename)
  */
 Dict::~Dict()
 {
-   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
-   {
-      DictEntry* entryToDelete = tag->second;
-      if ( entryToDelete )
-      {
-         delete entryToDelete;
-      }
-   }
-   // Since AddNewEntry adds symetrical in both KeyHt and NameHT we can
-   // assume all the pointed DictEntries are already cleaned-up when
-   // we cleaned KeyHt.
-   KeyHt.clear();
-   NameHt.clear();
+   ClearEntry();
 }
 
 //-----------------------------------------------------------------------------
@@ -93,76 +95,53 @@ Dict::~Dict()
 void Dict::Print(std::ostream &os)
 {
    os << "Dict file name : " << Filename << std::endl;
-   PrintByKey(os);
-}
-
-/**
- * \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 Dict::PrintByKey(std::ostream &os)
-{
    std::ostringstream s;
 
    for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
    {
       s << "Entry : ";
-      s << "(" << std::hex << std::setw(4) << tag->second->GetGroup() << ',';
-      s << std::hex << std::setw(4) << tag->second->GetElement() << ") = "
+      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;
+      s << tag->second.GetVR() << ", ";
+      s << tag->second.GetVM() << ", ";
+      s << tag->second.GetName() << "."  << std::endl;
    }
    os << s.str();
 }
 
+
+//-----------------------------------------------------------------------------
+// Public
 /**
- * \brief   Print all the dictionary entries contained in this dictionary.
- *          Entries will be sorted by the name of the dictionary entries.
- * \warning AVOID USING IT : the name IS NOT an identifier; 
- *                           unpredictable result
- * @param   os The output stream to be written to.
+ * \ingroup Dict
+ * \brief   Remove all Dicom Dictionary Entries
  */
-void Dict::PrintByName(std::ostream& os)
+void Dict::ClearEntry()
 {
-   std::ostringstream s;
-
-   for (TagNameHT::iterator tag = NameHt.begin(); tag != NameHt.end(); ++tag)
-   {
-      s << "Entry : ";
-      s << tag->second->GetName() << ",";
-      s << tag->second->GetVR() << ", ";
-      s << tag->second->GetFourth() << ", ";
-      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();
+   // we assume all the pointed DictEntries are already cleaned-up
+   // when we clean KeyHt.
+   KeyHt.clear();
 }
 
-//-----------------------------------------------------------------------------
-// Public
 /**
  * \ingroup Dict
  * \brief  adds a new Dicom Dictionary Entry 
  * @param   newEntry entry to add 
  * @return  false if Dicom Element already exists
  */
-bool Dict::AddNewEntry(DictEntry *newEntry) 
+bool Dict::AddNewEntry(DictEntry const &newEntry) 
 {
-   TagKey key = newEntry->GetKey();
+   const TagKey &key = newEntry.GetKey();
 
    if(KeyHt.count(key) == 1)
    {
-      dbg.Verbose(1, "Dict::AddNewEntry already present", key.c_str());
+      gdcmVerboseMacro( "Already present" << key.c_str());
       return false;
    } 
    else 
    {
-      KeyHt[newEntry->GetKey()] = newEntry;
-      NameHt[newEntry->GetName()] = newEntry;
+      KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
       return true;
    }
 }
@@ -173,12 +152,11 @@ bool Dict::AddNewEntry(DictEntry *newEntry)
  * @param   newEntry new entry (overwrites any previous one with same tag)
  * @return  false if Dicom Element doesn't exist
  */
-bool Dict::ReplaceEntry(DictEntry *newEntry)
+bool Dict::ReplaceEntry(DictEntry const &newEntry)
 {
-   if ( RemoveEntry(newEntry->DictEntry::GetKey()) )
+   if ( RemoveEntry(newEntry.GetKey()) )
    {
-       KeyHt[newEntry->GetKey()] = newEntry;
-       NameHt[newEntry->GetName()] = newEntry;
+       KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
        return true;
    } 
    return false;
@@ -191,24 +169,18 @@ bool Dict::ReplaceEntry(DictEntry *newEntry)
  * @param   key (group|element)
  * @return  false if Dicom Dictionary Entry doesn't exist
  */
-bool Dict::RemoveEntry(TagKey key) 
+bool Dict::RemoveEntry (TagKey const &key) 
 {
-   if(KeyHt.count(key) == 1) 
+   TagKeyHT::const_iterator it = KeyHt.find(key);
+   if(it != KeyHt.end()) 
    {
-      DictEntry* entryToDelete = KeyHt.find(key)->second;
-
-      if ( entryToDelete )
-      {
-         NameHt.erase(entryToDelete->GetName());
-         delete entryToDelete;
-      }
-
       KeyHt.erase(key);
+
       return true;
    } 
    else 
    {
-      dbg.Verbose(1, "Dict::RemoveEntry unfound entry", key.c_str());
+      gdcmVerboseMacro( "Unfound entry" << key.c_str());
       return false;
   }
 }
@@ -217,45 +189,29 @@ bool Dict::RemoveEntry(TagKey key)
  * \brief  removes an already existing Dicom Dictionary Entry, 
  *          identified by its group,element number
  * @param   group   Dicom group number of the Dicom Element
- * @param   element Dicom element number of the Dicom Element
+ * @param   elem Dicom element number of the Dicom Element
  * @return  false if Dicom Dictionary Entry doesn't exist
  */
-bool Dict::RemoveEntry (uint16_t group, uint16_t element)
+bool Dict::RemoveEntry (uint16_t group, uint16_t elem)
 {
-   return RemoveEntry(DictEntry::TranslateToKey(group, element));
-}
-
-/**
- * \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
- */
-DictEntry* Dict::GetDictEntryByName(TagName const & name)
-{
-   if ( !NameHt.count(name))
-   {
-      return 0;
-   }
-   return NameHt.find(name)->second;
+   return RemoveEntry(DictEntry::TranslateToKey(group, elem));
 }
 
 /**
  * \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
+ * @param   elem element of the entry to be found
  * @return  the corresponding dictionnary entry when existing, NULL otherwise
  */
-DictEntry* Dict::GetDictEntryByNumber(uint16_t group, uint16_t element)
+DictEntry *Dict::GetDictEntry(uint16_t group, uint16_t elem)
 {
-   TagKey key = DictEntry::TranslateToKey(group, element);
-   if ( !KeyHt.count(key) )
+   TagKey key = DictEntry::TranslateToKey(group, elem);
+   TagKeyHT::iterator it = KeyHt.find(key);
+   if ( it == KeyHt.end() )
    {
       return 0;
    }
-   return KeyHt.find(key)->second;
+   return &(it->second);
 }
 
 /** 
@@ -264,15 +220,20 @@ DictEntry* Dict::GetDictEntryByNumber(uint16_t group, uint16_t element)
  * \sa      DictSet::GetPubDictTagNamesByCategory
  * @return  A list of all entries of the public dicom dictionnary.
  */
-EntryNamesList* Dict::GetDictEntryNames() 
-{
-   EntryNamesList *result = new EntryNamesList;
-   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
-   {
-      result->push_back( tag->second->GetName() );
-   }
-   return result;
-}
+
+ // Probabely useless
+  
+//EntryNamesList *Dict::GetDictEntryNames() 
+//{
+//   EntryNamesList *result = new EntryNamesList;
+//   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
+//   {
+//      result->push_back( tag->second.GetName() );
+//   }
+//   return result;
+//}
 
 /** 
  * \ingroup Dict
@@ -298,16 +259,46 @@ EntryNamesList* Dict::GetDictEntryNames()
  *          corresponding values are lists of all the dictionnary entries
  *          among that group.
  */
-EntryNamesByCatMap *Dict::GetDictEntryNamesByCategory() 
+ // Probabely useless
+//EntryNamesByCatMap *Dict::GetDictEntryNamesByCategory() 
+//{
+//   EntryNamesByCatMap *result = new EntryNamesByCatMap;
+//
+//   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
+//   {
+//      (*result)[tag->second.GetFourth()].push_back(tag->second.GetName());
+//   }
+//
+//   return result;
+//}
+
+/**
+ * \brief   Initialise the visit of the Hash table (KeyHt)
+ */
+void Dict::InitTraversal()
 {
-   EntryNamesByCatMap *result = new EntryNamesByCatMap;
+   ItKeyHt = KeyHt.begin();
+}
 
-   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
+/**
+ * \brief   Get the next entry whil visiting the Hash table (KeyHt)
+ * \return  The next DictEntry if found, otherwhise NULL
+ */
+DictEntry *Dict::GetNextEntry()
+{
+   if (ItKeyHt != KeyHt.end())
    {
-      (*result)[tag->second->GetFourth()].push_back(tag->second->GetName());
-   }
+      DictEntry *tmp = &(ItKeyHt->second);
+      ++ItKeyHt;
 
-   return result;
+      return tmp;
+   }
+   else
+   {
+      return NULL;
+   }
 }
 
 //-----------------------------------------------------------------------------