]> Creatis software - gdcm.git/blobdiff - src/gdcmDict.cxx
Fix mistypings
[gdcm.git] / src / gdcmDict.cxx
index d867b3da2cf38ece7ec886a5eed9607cffa9f394..a314a91a09b4a7caf3cc91c850117da3d106c7f9 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDict.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/02/01 10:29:55 $
-  Version:   $Revision: 1.71 $
+  Date:      $Date: 2007/05/23 14:18:09 $
+  Version:   $Revision: 1.87 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #include <iostream>
 #include <iomanip>
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE
 {
 //-----------------------------------------------------------------------------
+/// \brief auto generated function, to fill up the Dicom Dictionnary,
+///       if relevant file is not found on user's disk
 void FillDefaultDataDict(Dict *d);
 
 //-----------------------------------------------------------------------------
@@ -45,37 +47,20 @@ Dict::Dict( )
  */
 Dict::Dict(std::string const &filename)
 {
-   uint16_t group;
-   uint16_t element;
-   TagName vr;
-   TagName vm;
-   TagName name;
-
+   gdcmDebugMacro( "in Dict::Dict, filename =[" << filename << "]" );
    std::ifstream from( filename.c_str() );
-   if( !from )
+   if ( !from )
    {
-      gdcmVerboseMacro( "Can't open dictionary" << filename.c_str());
+      gdcmWarningMacro( "Can't open dictionary" << filename.c_str());
       // Using default embeded one:
       FillDefaultDataDict( this );
    }
    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);
-         AddEntry(newEntry);
-      }
-
+   { 
+      gdcmDebugMacro( "in Dict::Dict, DoTheLoadingJob filename =[" 
+                    << filename << "]" );
+      DoTheLoadingJob(from);
       Filename = filename;
-      from.close();
    }
 }
 
@@ -89,14 +74,67 @@ Dict::~Dict()
 
 //-----------------------------------------------------------------------------
 // Public
+
 /**
- * \brief   Remove all Dicom Dictionary Entries
+ * \brief   Add all the entries held in a source dictionary
+ * \note it concerns only Private Dictionnary
+ * @param   filename from which to build the dictionary.
  */
-void Dict::ClearEntry()
+bool Dict::AddDict(std::string const &filename)
 {
-   // we assume all the pointed DictEntries are already cleaned-up
-   // when we clean KeyHt.
-   KeyHt.clear();
+   std::ifstream from( filename.c_str() );
+   if ( !from )
+   {
+      gdcmWarningMacro( "Can't open dictionary" << filename.c_str());
+      return false;
+   }
+   else
+   {
+      DoTheLoadingJob(from);
+      return true;
+   }
+}
+
+/**
+ * \brief   Removes from the current Dicom Dict all the entries held in a source dictionary
+ * \note it concerns only Private Dictionnary
+ * @param   filename from which we read the entries to remove.
+ */
+bool Dict::RemoveDict(std::string const &filename)
+{
+   std::ifstream from( filename.c_str() );
+   if ( !from )
+   {
+      gdcmWarningMacro( "Can't open dictionary" << filename.c_str());
+      return false;
+   }
+   else
+   {
+      uint16_t group;
+      uint16_t elem;
+      TagName vr;
+      TagName vm;
+      TagName name;
+
+      while ( true )
+      {
+         from >> std::hex;
+         from >> group;
+
+         if (from.eof())
+            break;
+
+         from >> elem;
+         from >> vr;
+         from >> vm;
+        // from >> std::ws;  //remove white space
+         std::getline(from, name);
+         RemoveEntry(group,elem);
+      }
+      from.close();
+      return true;
+   }
 }
 
 /**
@@ -104,36 +142,43 @@ void Dict::ClearEntry()
  * @param   newEntry entry to add 
  * @return  false if Dicom Element already exists
  */
-bool Dict::AddEntry(DictEntry const &newEntry) 
+bool Dict::AddEntry(DictEntry *newEntry) 
 {
-   const TagKey &key = newEntry.GetKey();
+   const TagKey &key = newEntry->GetKey();
 
-   if(KeyHt.count(key) == 1)
+   if ( KeyHt.count(key) == 1 )
    {
-      gdcmVerboseMacro( "Already present" << key.c_str());
+      gdcmErrorMacro( "Already present:" << key );
       return false;
    } 
    else 
    {
-      KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
+      newEntry->Register();
+      KeyHt.insert( TagKeyHT::value_type(key, newEntry));
       return true;
    }
 }
 
-/**
- * \brief  replaces an already existing Dicom Element by a new one
- * @param   newEntry new entry (overwrites any previous one with same tag)
- * @return  false if Dicom Element doesn't exist
+/*
+ * \ brief  replaces an already existing Dicom Element by a new one
+ * @ param   newEntry new entry (overwrites any previous one with same tag)
+ * @ return  false if Dicom Element doesn't exist
  */
-bool Dict::ReplaceEntry(DictEntry const &newEntry)
+ /* seems to be useless
+bool Dict::ReplaceEntry(DictEntry *newEntry) // seems to be useless
 {
-   if ( RemoveEntry(newEntry.GetKey()) )
+   const TagKey &key = newEntry->GetKey();
+   if ( RemoveEntry(key) )
    {
-       KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
-       return true;
+      newEntry->Register();
+      KeyHt.insert( TagKeyHT::value_type(key, newEntry));
+      return true;
    } 
    return false;
 }
+*/
 
 /**
  * \brief  removes an already existing Dicom Dictionary Entry,
@@ -141,18 +186,19 @@ bool Dict::ReplaceEntry(DictEntry const &newEntry)
  * @param   key (group|element)
  * @return  false if Dicom Dictionary Entry doesn't exist
  */
-bool Dict::RemoveEntry (TagKey const &key) 
+bool Dict::RemoveEntry(TagKey const &key) 
 {
    TagKeyHT::const_iterator it = KeyHt.find(key);
-   if(it != KeyHt.end()
+   if ( it != KeyHt.end() 
    {
-      KeyHt.erase(key);
+      it->second->Unregister(); // delete the entry
+      KeyHt.erase(key);         // remove pointer from HTable
 
       return true;
    } 
    else 
    {
-      gdcmVerboseMacro( "Unfound entry" << key.c_str());
+      gdcmWarningMacro( "Unfound entry" << key );
       return false;
   }
 }
@@ -164,15 +210,44 @@ bool Dict::RemoveEntry (TagKey const &key)
  * @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 elem)
+bool Dict::RemoveEntry(uint16_t group, uint16_t elem)
 {
    return RemoveEntry(DictEntry::TranslateToKey(group, elem));
 }
 
 /**
- * \brief   Get the dictionary entry identified by a given tag (group,element)
- * @param   group   group of the entry to be found
- * @param   elem element of the entry to be found
+ * \brief   Remove all Dicom Dictionary Entries
+ */
+void Dict::ClearEntry()
+{
+   // we assume all the pointed DictEntries are already cleaned-up
+   // when we clean KeyHt.
+   TagKeyHT::const_iterator it;
+
+   for(it = KeyHt.begin();it!=KeyHt.end();++it)
+      it->second->Unregister(); // delete the entry
+   KeyHt.clear();               // remove all the entries from HTable
+
+}
+
+/**
+ * \brief   Get the dictionary entry identified by a given tag ("group|element")
+ * @param   key   tag of the searched entry 
+ * @return  the corresponding dictionary entry when existing, NULL otherwise
+ */
+DictEntry *Dict::GetEntry(TagKey const &key)
+{
+   TagKeyHT::iterator it = KeyHt.find(key);
+   if ( it == KeyHt.end() )
+   {
+      return 0;
+   }
+   return it->second;
+}
+/**
+ * \brief   Get the dictionary entry identified by its "group" and "element")
+ * @param   group  Group number of the searched entry.
+ * @param   elem Element number of the searched entry.
  * @return  the corresponding dictionary entry when existing, NULL otherwise
  */
 DictEntry *Dict::GetEntry(uint16_t group, uint16_t elem)
@@ -183,7 +258,7 @@ DictEntry *Dict::GetEntry(uint16_t group, uint16_t elem)
    {
       return 0;
    }
-   return &(it->second);
+   return it->second;
 }
 
 /**
@@ -193,8 +268,8 @@ DictEntry *Dict::GetEntry(uint16_t group, uint16_t elem)
 DictEntry *Dict::GetFirstEntry()
 {
    ItKeyHt = KeyHt.begin();
-   if( ItKeyHt != KeyHt.end() )
-      return &(ItKeyHt->second);
+   if ( ItKeyHt != KeyHt.end() )
+      return ItKeyHt->second;
    return NULL;
 }
 
@@ -207,11 +282,9 @@ DictEntry *Dict::GetNextEntry()
 {
    gdcmAssertMacro (ItKeyHt != KeyHt.end());
 
-   {
-      ++ItKeyHt;
-      if (ItKeyHt != KeyHt.end())
-         return &(ItKeyHt->second);
-   }
+   ++ItKeyHt;
+   if (ItKeyHt != KeyHt.end())
+      return ItKeyHt->second;
    return NULL;
 }
 
@@ -220,7 +293,42 @@ DictEntry *Dict::GetNextEntry()
 
 //-----------------------------------------------------------------------------
 // Private
+/**
+ * \brief Add all the dictionary entries from an already open source file 
+ * @param from input stream to read from.
+ */
+void Dict::DoTheLoadingJob(std::ifstream &from)
+{
+   if (!from)
+      return;
+      
+   uint16_t group;
+   uint16_t elem;
+   VRKey vr;
+   TagName vm;
+   TagName name;
 
+   DictEntry *newEntry;
+   while ( true )
+   {
+      from >> std::hex;
+      from >> group;      
+      from >> elem;
+      from >> vr;
+      from >> vm;
+      from >> std::ws;  //remove white space
+      std::getline(from, name);
+      
+      if(from.eof()) {
+         break;
+      }
+      
+      newEntry = DictEntry::New(group, elem, vr, vm, name);
+      AddEntry(newEntry);
+      newEntry->Delete();
+   }
+   from.close();
+}
 //-----------------------------------------------------------------------------
 // Print
 /**
@@ -231,20 +339,23 @@ DictEntry *Dict::GetNextEntry()
  */
 void Dict::Print(std::ostream &os, std::string const & )
 {
-   os << "Dict file name : " << Filename << std::endl;
+   os << "Dict file name : [" << Filename << "]" << std::endl;
    std::ostringstream s;
 
    for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
-   {
+   {  
+std::cout << tag->second->GetKey() << " " << tag->second->GetName() 
+          << std::endl;
       s << "Entry : ";
-      s << "(" << std::hex << std::setw(4) << tag->second.GetGroup() << ',';
-      s << std::hex << std::setw(4) << tag->second.GetElement() << ") = "
+      s << "(" << tag->second->GetKey() << ") = "
         << std::dec;
-      s << tag->second.GetVR() << ", ";
-      s << tag->second.GetVM() << ", ";
-      s << tag->second.GetName() << "."  << std::endl;
+      s << tag->second->GetVR() << ", ";
+      s << tag->second->GetVM() << ", ";
+      s << tag->second->GetName() << "."  << std::endl;
+     
    }
    os << s.str();
+
 }
 
 //-----------------------------------------------------------------------------