]> Creatis software - gdcm.git/blobdiff - src/gdcmDictSet.cxx
ENH: Refactor some code
[gdcm.git] / src / gdcmDictSet.cxx
index 99b890200da1d523d2590459992389715e78b44b..d6a2fb7f4ca03158e8215045337ee51c9d4e2408 100644 (file)
-// gdcmDictEntry
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDictSet.cxx,v $
+  Language:  C++
+  Date:      $Date: 2004/08/01 02:39:09 $
+  Version:   $Revision: 1.34 $
+                                                                                
+  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.htm 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 "gdcmDictSet.h"
-#include "gdcmUtil.h"
+#include "gdcmDebug.h"
 #include <fstream>
 #include <stdlib.h>  // For getenv
 
-#define PUB_DICT_NAME     "DicomV3Dict"
-#ifndef PUB_DICT_PATH
-#  define PUB_DICT_PATH     "../Dicts/"
-#endif
-#define PUB_DICT_FILENAME "dicomV3.dic"
-
+//-----------------------------------------------------------------------------
+// Constructor / Destructor
 /** 
  * \ingroup gdcmDictSet
- * \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.
+ * \brief   The Dictionnary Set obtained with this constructor simply
+ *          contains the Default Public dictionnary.
  */
-std::list<std::string> * gdcmDictSet::GetPubDictTagNames(void) {
-   std::list<std::string> * Result = new std::list<std::string>;
-   TagKeyHT entries = GetDefaultPubDict()->GetEntries();
-   
-   for (TagKeyHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){
-      Result->push_back( tag->second->GetName() );
-   }
-   return Result;
+gdcmDictSet::gdcmDictSet() 
+{
+   DictPath = BuildDictPath();
+   std::string pubDictFile(DictPath);
+   pubDictFile += PUB_DICT_FILENAME;
+   Dicts[PUB_DICT_NAME] = new gdcmDict(pubDictFile);
 }
 
-/** 
+/**
  * \ingroup gdcmDictSet
- * \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 od thhe 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.
+ * \brief  Destructor 
  */
-std::map<std::string, std::list<std::string> > * gdcmDictSet::GetPubDictTagNamesByCategory(void) {
-   std::map<std::string, std::list<std::string> > * Result = new std::map<std::string, std::list<std::string> >;
-   TagKeyHT entries = GetDefaultPubDict()->GetEntries();
+gdcmDictSet::~gdcmDictSet() 
+{
+   // Remove dictionnaries
+   for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) 
+   {
+      gdcmDict *entryToDelete = tag->second;
+      if ( entryToDelete )
+      {
+         delete entryToDelete;
+      }
+      tag->second = NULL;
+   }
+   Dicts.clear();
 
-   for (TagKeyHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){
-      (*Result)[tag->second->GetFourth()].push_back(tag->second->GetName());
+   // Remove virtual dictionnary entries
+   std::map<std::string,gdcmDictEntry *>::iterator it;
+   for(it = VirtualEntry.begin(); it != VirtualEntry.end(); ++it)
+   {
+      gdcmDictEntry *entry = it->second;
+      if ( entry )
+      {
+         delete entry;
+      }
+      it->second = NULL;
    }
-   return Result;
 }
 
+//-----------------------------------------------------------------------------
+// Print
 /**
  * \ingroup gdcmDictSet
- * \brief   Obtain from the GDCM_DICT_PATH environnement variable the
- *          path to directory containing the dictionnaries. When
- *          the environnement variable is absent the path is defaulted
- *          to "../Dicts/".
+ * \brief   Print, in an informal fashion, the list of all the dictionaries
+ *          contained is this gdcmDictSet, along with their respective content.
+ * @param   os Output stream used for printing.
  */
-std::string gdcmDictSet::BuildDictPath(void) {
-   std::string ResultPath;
-   const char* EnvPath = (char*)0;
-   EnvPath = getenv("GDCM_DICT_PATH");
-   if (EnvPath && (strlen(EnvPath) != 0)) {
-      ResultPath = EnvPath;
-      if (ResultPath[ResultPath.length() -1] != '/' )
-         ResultPath += '/';
-      dbg.Verbose(1, "gdcmDictSet::BuildDictPath:",
-                     "Dictionary path set from environnement");
-   } else
-      ResultPath = PUB_DICT_PATH;
-   return ResultPath;
+void gdcmDictSet::Print(std::ostream& os) 
+{
+   for (DictSetHT::iterator dict = Dicts.begin(); dict != Dicts.end(); ++dict)
+   {
+      os << "Printing dictionary " << dict->first << std::endl;
+      dict->second->Print(os);
+   }
 }
 
+//-----------------------------------------------------------------------------
+// Public
 /** 
  * \ingroup gdcmDictSet
- * \brief   The Dictionnary Set obtained with this constructor simply
- *          contains the Default Public dictionnary.
+ * \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.
  */
-gdcmDictSet::gdcmDictSet(void) {
-   DictPath = BuildDictPath();
-   std::string PubDictFile = DictPath + PUB_DICT_FILENAME;
-   Dicts[PUB_DICT_NAME] = new gdcmDict(PubDictFile);
+std::list<std::string> *gdcmDictSet::GetPubDictEntryNames() 
+{
+   return GetDefaultPubDict()->GetDictEntryNames();
 }
 
-gdcmDictSet::~gdcmDictSet() {
-   for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) {
-      gdcmDict* EntryToDelete = tag->second;
-      if ( EntryToDelete )
-         delete EntryToDelete;
-   }
-   Dicts.clear();
+/** 
+ * \ingroup gdcmDictSet
+ * \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> > *
+   gdcmDictSet::GetPubDictEntryNamesByCategory() 
+{
+   return GetDefaultPubDict()->GetDictEntryNamesByCategory();
 }
 
 /**
@@ -113,41 +139,114 @@ gdcmDictSet::~gdcmDictSet() {
  * @param   Name Symbolic name that be used as identifier of the newly 
  *          created dictionary.
  */
-void gdcmDictSet::LoadDictFromFile(std::string FileName, DictKey Name) {
-   gdcmDict *NewDict = new gdcmDict(FileName);
-   Dicts[Name] = NewDict;
-}
+gdcmDict *gdcmDictSet::LoadDictFromFile(std::string const & fileName, 
+                                        DictKey const & name) 
+{
+   gdcmDict *newDict = new gdcmDict(fileName);
+   AppendDict(newDict, name);
 
-/**
- * \ingroup gdcmDictSet
- * \brief   Print, in an informal fashion, the list of all the dictionaries
- *          contained is this gdcmDictSet, along with their respective content.
- * @param   os Output stream used for printing.
- */
-void gdcmDictSet::Print(std::ostream& os) {
-   for (DictSetHT::iterator dict = Dicts.begin(); dict != Dicts.end(); ++dict){
-      os << "Printing dictionary " << dict->first << std::endl;
-      dict->second->Print(os);
-   }
+   return newDict;
 }
 
 /**
  * \ingroup gdcmDictSet
  * \brief   Retrieve the specified dictionary (when existing) from this
  *          gdcmDictSet.
- * @param   DictName The synbolic name of the searched dictionary.
+ * @param   DictName The symbolic name of the searched dictionary.
  * \result  The retrieved dictionary.
  */
-gdcmDict * gdcmDictSet::GetDict(DictKey DictName) {
-   DictSetHT::iterator dict = Dicts.find(DictName);
-   return dict->second;
+gdcmDict *gdcmDictSet::GetDict(DictKey const & dictName) 
+{
+   DictSetHT::iterator dict = Dicts.find(dictName);
+   if(dict != Dicts.end())
+   {
+      return dict->second;
+   }
+   return NULL;
 }
 
 /**
- * \ingroup gdcmDictSet
  * \brief   Retrieve the default reference DICOM V3 public dictionary.
  * \result  The retrieved default dictionary.
  */
-gdcmDict * gdcmDictSet::GetDefaultPubDict() {
+gdcmDict *gdcmDictSet::GetDefaultPubDict() 
+{
    return GetDict(PUB_DICT_NAME);
 }
+
+/**
+ * \brief   Create a gdcmDictEntry which will be reference 
+ *          in no dictionnary
+ * @return  virtual entry
+ */
+gdcmDictEntry *gdcmDictSet::NewVirtualDictEntry(uint16_t group,
+                                                uint16_t element,
+                                                std::string vr,
+                                                std::string fourth,
+                                                std::string name)
+{
+   gdcmDictEntry* entry;
+   const std::string tag = gdcmDictEntry::TranslateToKey(group,element)
+                           + "#" + vr + "#" + fourth + "#" + name;
+   std::map<std::string,gdcmDictEntry *>::iterator it;
+   
+   it = VirtualEntry.find(tag);
+   if(it != VirtualEntry.end())
+   {
+      entry = it->second;
+   }
+   else
+   {
+      entry = new gdcmDictEntry(group, element, vr, fourth, name);
+      VirtualEntry[tag] = entry;
+   }
+
+   return entry;
+}
+
+/**
+ * \brief   Obtain from the GDCM_DICT_PATH environnement variable the
+ *          path to directory containing the dictionnaries. When
+ *          the environnement variable is absent the path is defaulted
+ *          to "../Dicts/".
+ * @return  path to directory containing the dictionnaries
+ */
+std::string gdcmDictSet::BuildDictPath() 
+{
+   std::string resultPath;
+   const char *envPath = 0;
+   envPath = getenv("GDCM_DICT_PATH");
+
+   if (envPath && (strlen(envPath) != 0)) 
+   {
+      resultPath = envPath;
+      if ( resultPath[resultPath.length()-1] != '/' )
+      {
+         resultPath += '/';
+      }
+      dbg.Verbose(1, "gdcmDictSet::BuildDictPath:",
+                     "Dictionary path set from environnement");
+   } 
+   else
+   {
+      resultPath = PUB_DICT_PATH;
+   }
+
+   return resultPath;
+}
+
+//-----------------------------------------------------------------------------
+// Protected
+bool gdcmDictSet::AppendDict(gdcmDict *newDict, DictKey const & name)
+{
+   Dicts[name] = newDict;
+
+   return true;   //FIXME
+}
+
+//-----------------------------------------------------------------------------
+// Private
+
+//-----------------------------------------------------------------------------
+
+