]> Creatis software - gdcm.git/blobdiff - src/gdcmDict.cxx
ENH: Adding 'gdcm' namespace. Be nice with me this was a ~13000 lines patch. Also...
[gdcm.git] / src / gdcmDict.cxx
index 46edb403e836229cf88e29f171d4c5e9b11ff5db..bb6bd72eb67de471d3eee997c81c126abf696737 100644 (file)
@@ -1,5 +1,21 @@
-// gdcmDict.cxx
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDict.cxx,v $
+  Language:  C++
+  Date:      $Date: 2004/10/12 04:35:45 $
+  Version:   $Revision: 1.45 $
+                                                                                
+  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 "gdcmDict.h"
 #include "gdcmUtil.h"
 #include "gdcmDebug.h"
 #include <fstream>
 #include <iostream>
 #include <iomanip>
+namespace gdcm 
+{
 
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
  * \brief   Construtor
- * @param   FileName from which to build the dictionary.
+ * @param   filename from which to build the dictionary.
  */
-gdcmDict::gdcmDict(std::string & FileName) {
-   guint16 group, element;
-   char buff[1024];
+Dict::Dict(std::string const & filename)
+{
+   uint16_t group;
+   uint16_t element;
    TagName vr;
    TagName fourth;
    TagName name;
 
-   std::ifstream from(FileName.c_str());
-   dbg.Error(!from, "gdcmDict::gdcmDict: can't open dictionary",
-                    FileName.c_str());
+   std::ifstream from( filename.c_str() );
+   dbg.Error(!from, "Dict::Dict: can't open dictionary",
+                    filename.c_str());
 
-   while (!from.eof()) {
+   while (!from.eof())
+   {
       from >> std::hex;
       from >> group;          /// MEMORY LEAK in std::istream::operator>>
       from >> element;
       from >> vr;
       from >> fourth;
-      getline(from, name);    /// MEMORY LEAK in std::getline<>
+      from >> std::ws; // used to be eatwhite(from);
+      std::getline(from, name);    /// MEMORY LEAK in std::getline<>
 
-      gdcmDictEntry * newEntry = new gdcmDictEntry(group, element,
+      DictEntry * newEntry = new DictEntry(group, element,
                                                    vr, fourth, name);
       AddNewEntry(newEntry);
    }
    from.close();
 
-   filename=FileName;
+   Filename = filename;
 }
 
 /**
  * \brief  Destructor 
  */
-gdcmDict::~gdcmDict() {
-   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) {
-      gdcmDictEntry* EntryToDelete = tag->second;
-      if ( EntryToDelete )
-         delete EntryToDelete;
+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 gdcmDictEntries are already cleaned-up when
+   // assume all the pointed DictEntries are already cleaned-up when
    // we cleaned KeyHt.
    KeyHt.clear();
    NameHt.clear();
@@ -65,8 +90,9 @@ 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) {
-   os<<"Dict file name : "<<filename<<std::endl;
+void Dict::Print(std::ostream &os)
+{
+   os << "Dict file name : " << Filename << std::endl;
    PrintByKey(os);
 }
 
@@ -75,13 +101,16 @@ 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::ostream &os) {
+void Dict::PrintByKey(std::ostream &os)
+{
    std::ostringstream s;
 
-   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag){
+   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() << ") = " << std::dec;
+      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;
@@ -96,10 +125,12 @@ void gdcmDict::PrintByKey(std::ostream &os) {
  *                           unpredictable result
  * @param   os The output stream to be written to.
  */
-void gdcmDict::PrintByName(std::ostream& os) {
+void Dict::PrintByName(std::ostream& os)
+{
    std::ostringstream s;
 
-   for (TagNameHT::iterator tag = NameHt.begin(); tag != NameHt.end(); ++tag){
+   for (TagNameHT::iterator tag = NameHt.begin(); tag != NameHt.end(); ++tag)
+   {
       s << "Entry : ";
       s << tag->second->GetName() << ",";
       s << tag->second->GetVR() << ", ";
@@ -114,88 +145,87 @@ void gdcmDict::PrintByName(std::ostream& os) {
 //-----------------------------------------------------------------------------
 // Public
 /**
- * \ingroup gdcmDict
+ * \ingroup Dict
  * \brief  adds a new Dicom Dictionary Entry 
- * @param   NewEntry entry to add 
+ * @param   newEntry entry to add 
  * @return  false if Dicom Element already exists
  */
-bool gdcmDict::AddNewEntry(gdcmDictEntry *NewEntry) 
+bool Dict::AddNewEntry(DictEntry *newEntry) 
 {
-   TagKey key;
-   key = NewEntry->GetKey();
+   TagKey key = newEntry->GetKey();
 
    if(KeyHt.count(key) == 1)
    {
-      dbg.Verbose(1, "gdcmDict::AddNewEntry already present", key.c_str());
-      return(false);
+      dbg.Verbose(1, "Dict::AddNewEntry already present", key.c_str());
+      return false;
    } 
    else 
    {
-      KeyHt[NewEntry->GetKey()] = NewEntry;
-      NameHt[NewEntry->GetName()] = NewEntry;  /// MEMORY LEAK in
-                                               /// std::map<>::operator[]
-      return(true);
+      KeyHt[newEntry->GetKey()] = newEntry;
+      NameHt[newEntry->GetName()] = newEntry;
+      return true;
    }
 }
 
 /**
- * \ingroup gdcmDict
+ * \ingroup Dict
  * \brief  replaces an already existing Dicom Element by a new one
- * @param   NewEntry new entry (overwrites any previous one with same tag)
+ * @param   newEntry new entry (overwrites any previous one with same tag)
  * @return  false if Dicom Element doesn't exist
  */
-bool gdcmDict::ReplaceEntry(gdcmDictEntry *NewEntry) {
-   if ( RemoveEntry(NewEntry->gdcmDictEntry::GetKey()) ) {
-       KeyHt[NewEntry->GetKey()] = NewEntry;
-       NameHt[NewEntry->GetName()] = NewEntry;
-       return (true);
+bool Dict::ReplaceEntry(DictEntry *newEntry)
+{
+   if ( RemoveEntry(newEntry->DictEntry::GetKey()) )
+   {
+       KeyHt[newEntry->GetKey()] = newEntry;
+       NameHt[newEntry->GetName()] = newEntry;
+       return true;
    } 
-   return (false);
+   return false;
 }
 
 /**
- * \ingroup gdcmDict
+ * \ingroup Dict
  * \brief  removes an already existing Dicom Dictionary Entry,
  *         identified by its Tag
  * @param   key (group|element)
  * @return  false if Dicom Dictionary Entry doesn't exist
  */
-bool gdcmDict::RemoveEntry(TagKey key) 
+bool Dict::RemoveEntry(TagKey key) 
 {
    if(KeyHt.count(key) == 1) 
    {
-      gdcmDictEntry* EntryToDelete = KeyHt.find(key)->second;
+      DictEntry* entryToDelete = KeyHt.find(key)->second;
 
-      if ( EntryToDelete )
+      if ( entryToDelete )
       {
-         NameHt.erase(EntryToDelete->GetName());
-         delete EntryToDelete;
+         NameHt.erase(entryToDelete->GetName());
+         delete entryToDelete;
       }
 
       KeyHt.erase(key);
-      return (true);
+      return true;
    } 
    else 
    {
-      dbg.Verbose(1, "gdcmDict::RemoveEntry unfound entry", key.c_str());
-      return (false);
+      dbg.Verbose(1, "Dict::RemoveEntry unfound entry", key.c_str());
+      return false;
   }
 }
 
 /**
- * \ingroup gdcmDict
  * \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
  * @return  false if Dicom Dictionary Entry doesn't exist
  */
-bool gdcmDict::RemoveEntry (guint16 group, guint16 element) {
-       return( RemoveEntry(gdcmDictEntry::TranslateToKey(group, element)) );
+bool Dict::RemoveEntry (uint16_t group, uint16_t element)
+{
+   return RemoveEntry(DictEntry::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 !
@@ -203,45 +233,49 @@ bool gdcmDict::RemoveEntry (guint16 group, guint16 element) {
  *            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; 
+DictEntry* Dict::GetDictEntryByName(TagName name)
+{
+   if ( !NameHt.count(name))
+   {
+      return 0;
+   }
    return NameHt.find(name)->second;
 }
 
 /**
- * \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::GetDictEntryByNumber(guint16 group, guint16 element) {
-   TagKey key = gdcmDictEntry::TranslateToKey(group, element);
-   if ( ! KeyHt.count(key))
-      return NULL; 
+DictEntry* Dict::GetDictEntryByNumber(uint16_t group, uint16_t element)
+{
+   TagKey key = DictEntry::TranslateToKey(group, element);
+   if ( !KeyHt.count(key) )
+   {
+      return 0;
+   }
    return KeyHt.find(key)->second;
 }
 
 /** 
- * \ingroup gdcmDict
  * \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
+ * \sa      DictSet::GetPubDictTagNamesByCategory
  * @return  A list of all entries of the public dicom dictionnary.
  */
-std::list<std::string> *gdcmDict::GetDictEntryNames(void
+std::list<std::string>* Dict::GetDictEntryNames(
 {
-   std::list<std::string> *Result = new std::list<std::string>;
+   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() );
+      result->push_back( tag->second->GetName() );
    }
-   return Result;
+   return result;
 }
 
 /** 
- * \ingroup gdcmDict
+ * \ingroup Dict
  * \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
@@ -264,15 +298,16 @@ std::list<std::string> *gdcmDict::GetDictEntryNames(void)
  *          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> > *Dict::GetDictEntryNamesByCategory(void) 
 {
-   std::map<std::string, std::list<std::string> > *Result = new std::map<std::string, std::list<std::string> >;
+   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());
+      (*result)[tag->second->GetFourth()].push_back(tag->second->GetName());
    }
-   return Result;
+
+   return result;
 }
 
 //-----------------------------------------------------------------------------
@@ -282,3 +317,5 @@ std::map<std::string, std::list<std::string> > *gdcmDict::GetDictEntryNamesByCat
 // Private
 
 //-----------------------------------------------------------------------------
+
+} // end namespace gdcm