]> Creatis software - gdcm.git/blobdiff - src/gdcmDictSet.cxx
Coding Style + Doxygenation
[gdcm.git] / src / gdcmDictSet.cxx
index ce08aa50142d21fb238198ed7702901128d26a64..25a848e98e14e396bd57b1fd512f83f98971091d 100644 (file)
@@ -1,52 +1,78 @@
-// gdcmDictEntry
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDictSet.cxx,v $
+  Language:  C++
+  Date:      $Date: 2005/01/06 20:03:27 $
+  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 "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"
+namespace gdcm 
+{
 
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /** 
- * \ingroup gdcmDictSet
+ * \ingroup DictSet
  * \brief   The Dictionnary Set obtained with this constructor simply
  *          contains the Default Public dictionnary.
  */
-gdcmDictSet::gdcmDictSet(void) {
+DictSet::DictSet() 
+{
    DictPath = BuildDictPath();
-   std::string PubDictFile = DictPath + PUB_DICT_FILENAME;
-   Dicts[PUB_DICT_NAME] = new gdcmDict(PubDictFile);
+   std::string pubDictFile(DictPath);
+   pubDictFile += PUB_DICT_FILENAME;
+   Dicts[PUB_DICT_NAME] = new Dict(pubDictFile);
 }
 
 /**
- * \ingroup gdcmDictSet
+ * \ingroup DictSet
  * \brief  Destructor 
  */
-gdcmDictSet::~gdcmDictSet() {
-   for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) {
-      gdcmDict* EntryToDelete = tag->second;
-      if ( EntryToDelete )
-         delete EntryToDelete;
+DictSet::~DictSet() 
+{
+   // Remove dictionnaries
+   for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) 
+   {
+      Dict *entryToDelete = tag->second;
+      if ( entryToDelete )
+      {
+         delete entryToDelete;
+      }
+      tag->second = NULL;
    }
    Dicts.clear();
+
+   // Remove virtual dictionnary entries
+   VirtualEntry.clear();
 }
 
 //-----------------------------------------------------------------------------
 // Print
 /**
- * \ingroup gdcmDictSet
+ * \ingroup DictSet
  * \brief   Print, in an informal fashion, the list of all the dictionaries
- *          contained is this gdcmDictSet, along with their respective content.
+ *          contained is this DictSet, 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){
+void DictSet::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);
    }
@@ -55,120 +81,154 @@ void gdcmDictSet::Print(std::ostream& os) {
 //-----------------------------------------------------------------------------
 // Public
 /** 
- * \ingroup gdcmDictSet
+ * \ingroup DictSet
  * \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> * 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;
+EntryNamesList *DictSet::GetPubDictEntryNames() 
+{
+   return GetDefaultPubDict()->GetDictEntryNames();
 }
 
 /** 
- * \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'
+ * \ingroup DictSet
+ * \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 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 :-(
+ *          - 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::GetPubDictTagNamesByCategory(void) {
-   std::map<std::string, std::list<std::string> > * Result = new std::map<std::string, std::list<std::string> >;
-   TagKeyHT entries = GetDefaultPubDict()->GetEntries();
-
-   for (TagKeyHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){
-      (*Result)[tag->second->GetFourth()].push_back(tag->second->GetName());
-   }
-   return Result;
+EntryNamesByCatMap *DictSet::GetPubDictEntryNamesByCategory() 
+{
+   return GetDefaultPubDict()->GetDictEntryNamesByCategory();
 }
 
 /**
- * \ingroup gdcmDictSet
+ * \ingroup DictSet
  * \brief   Loads a dictionary from a specified file, and add it
- *          to already the existing ones contained in this gdcmDictSet.
- * @param   FileName Absolute or relative filename containing the
+ *          to already the existing ones contained in this DictSet.
+ * @param   filename Absolute or relative filename containing the
  *          dictionary to load.
- * @param   Name Symbolic name that be used as identifier of the newly 
+ * @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);
-   AppendDict(NewDict,Name);
+Dict *DictSet::LoadDictFromFile(std::string const & filename, 
+                                DictKey const & name) 
+{
+   Dict *newDict = new Dict(filename);
+   AppendDict(newDict, name);
+
+   return newDict;
 }
 
 /**
- * \ingroup gdcmDictSet
+ * \ingroup DictSet
  * \brief   Retrieve the specified dictionary (when existing) from this
- *          gdcmDictSet.
- * @param   DictName The symbolic name of the searched dictionary.
+ *          DictSet.
+ * @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;
+Dict *DictSet::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.
+ * \brief   Create a DictEntry which will be reference 
+ *          in no dictionnary
+ * @return  virtual entry
  */
-gdcmDict * gdcmDictSet::GetDefaultPubDict() {
-   return GetDict(PUB_DICT_NAME);
+DictEntry *DictSet::NewVirtualDictEntry( uint16_t group,
+                                         uint16_t element,
+                                         TagName vr,
+                                         TagName fourth,
+                                         TagName name)
+{
+   DictEntry *entry;
+   const std::string tag = DictEntry::TranslateToKey(group,element)
+                           + "#" + vr + "#" + fourth + "#" + name;
+   TagKeyHT::iterator it;
+   
+   it = VirtualEntry.find(tag);
+   if(it != VirtualEntry.end())
+   {
+      entry = &(it->second);
+   }
+   else
+   {
+      DictEntry ent(group, element, vr, fourth, name);
+      VirtualEntry.insert(
+         std::map<TagKey, DictEntry>::value_type
+            (tag, ent));
+      entry = &(VirtualEntry.find(tag)->second);
+   }
+
+   return entry;
 }
 
 /**
- * \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/".
- * @return path to directory containing the dictionnaries
+ * @return  path to directory containing the dictionnaries
  */
-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:",
+std::string DictSet::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, "DictSet::BuildDictPath:",
                      "Dictionary path set from environnement");
-   } else
-      ResultPath = PUB_DICT_PATH;
-   return ResultPath;
+   } 
+   else
+   {
+      resultPath = PUB_DICT_PATH;
+   }
+
+   return resultPath;
 }
 
 //-----------------------------------------------------------------------------
 // Protected
-bool gdcmDictSet::AppendDict(gdcmDict* NewDict,DictKey Name)
+bool DictSet::AppendDict(Dict *newDict, DictKey const &name)
 {
-   Dicts[Name] = NewDict;
-   return(true);
+   Dicts[name] = newDict;
+
+   return true;
 }
 
 //-----------------------------------------------------------------------------
@@ -176,4 +236,4 @@ bool gdcmDictSet::AppendDict(gdcmDict* NewDict,DictKey Name)
 
 //-----------------------------------------------------------------------------
 
-
+} // end namespace gdcm