]> Creatis software - gdcm.git/blobdiff - src/gdcmDictSet.cxx
* src/gdcmDictGroupName.[h|cxx] : add a correlation between a group (number)
[gdcm.git] / src / gdcmDictSet.cxx
index 41a39c3f6ac9a2cb5b14fbb24e169a9216bde05e..8ec72b614d6ede6eefa1534915623f1493f6e9f9 100644 (file)
-// gdcmDictEntry
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDictSet.cxx,v $
+  Language:  C++
+  Date:      $Date: 2005/04/05 10:56:25 $
+  Version:   $Revision: 1.62 $
+                                                                                
+  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 "gdcmDebug.h"
 #include <fstream>
 #include <stdlib.h>  // For getenv
-#include "gdcmUtil.h"
-#include "gdcmDictSet.h"
-
-#define PUB_DICT_NAME     "DicomV3Dict"
-#ifndef PUB_DICT_PATH
-#  define PUB_DICT_PATH     "../Dicts/"
-#endif
-#define PUB_DICT_FILENAME "dicomV3.dic"
 
-string gdcmDictSet::DictPath = gdcmDictSet::BuildDictPath();
-gdcmDict* gdcmDictSet::DefaultPubDict = gdcmDictSet::LoadDefaultPubDict();
+namespace gdcm 
+{
 
+//-----------------------------------------------------------------------------
+// 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 Dictionary Set obtained with this constructor simply
+ *          contains the Default Public dictionary.
  */
-list<string> * gdcmDictSet::GetPubDictTagNames(void) {
-   list<string> * Result = new list<string>;
-   TagKeyHT entries = gdcmDictSet::DefaultPubDict->GetEntries();
-   
-   for (TagKeyHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){
-      Result->push_back( tag->second->GetName() );
+DictSet::DictSet() 
+{
+   DictPath = BuildDictPath();
+   std::string pubDictFile(DictPath);
+   pubDictFile += PUB_DICT_FILENAME;
+   Dicts[PUB_DICT_NAME] = new Dict(pubDictFile);
+}
+
+/**
+ * \brief  Destructor 
+ */
+DictSet::~DictSet() 
+{
+   // Remove dictionaries
+   for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) 
+   {
+      Dict *entryToDelete = tag->second;
+      if ( entryToDelete )
+      {
+         delete entryToDelete;
+      }
+      tag->second = NULL;
    }
-   return Result;
+   Dicts.clear();
+
+   // Remove virtual dictionary entries
+   VirtualEntry.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.
- * @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.
+//-----------------------------------------------------------------------------
+// Public
+/**
+ * \brief   Loads a dictionary from a specified file, and add it
+ *          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 
+ *          created dictionary.
  */
-map<string, list<string> > * gdcmDictSet::GetPubDictTagNamesByCategory(void) {
-   map<string, list<string> > * Result = new map<string, list<string> >;
-   TagKeyHT entries = gdcmDictSet::DefaultPubDict->GetEntries();
+Dict *DictSet::LoadDictFromFile(std::string const &filename, 
+                                DictKey const &name) 
+{
+   Dict *newDict = new Dict(filename);
+   AppendDict(newDict, name);
 
-   for (TagKeyHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){
-      (*Result)[tag->second->GetFourth()].push_back(tag->second->GetName());
-   }
-   return Result;
+   return newDict;
 }
 
 /**
- * \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   Retrieve the specified dictionary (when existing) from this
+ *          DictSet.
+ * @param   dictName The symbolic name of the searched dictionary.
+ * \result  The retrieved dictionary.
  */
-string gdcmDictSet::BuildDictPath(void) {
-   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;
+Dict *DictSet::GetDict(DictKey const &dictName) 
+{
+   DictSetHT::iterator dict = Dicts.find(dictName);
+   if(dict != Dicts.end())
+   {
+      return dict->second;
+   }
+   return NULL;
 }
 
-gdcmDict* gdcmDictSet::LoadDefaultPubDict(void) {
-   string PubDictFile = gdcmDictSet::DictPath + PUB_DICT_FILENAME;
-   return new gdcmDict(PubDictFile.c_str());
+/**
+ * \brief   Create a DictEntry which will be referenced 
+ *          in no dictionary
+ * @return  virtual entry
+ */
+DictEntry *DictSet::NewVirtualDictEntry( uint16_t group,
+                                         uint16_t element,
+                                         TagName vr,
+                                         TagName vm,
+                                         TagName name)
+{
+   DictEntry *entry;
+   const std::string tag = DictEntry::TranslateToKey(group,element)
+                           + "#" + vr + "#" + vm + "#" + name;
+   TagKeyHT::iterator it;
+   
+   it = VirtualEntry.find(tag);
+   if(it != VirtualEntry.end())
+   {
+      entry = &(it->second);
+   }
+   else
+   {
+      DictEntry ent(group, element, vr, vm, name);
+      VirtualEntry.insert(
+         std::map<TagKey, DictEntry>::value_type
+            (tag, ent));
+      entry = &(VirtualEntry.find(tag)->second);
+   }
+
+   return entry;
 }
 
-/** 
- * \ingroup gdcmDictSet
- * \brief   The Dictionnary Set obtained with this constructor simply
- *          contains the Default Public dictionnary.
+/**
+ * \brief   Get the first entry while visiting the DictSet
+ * \return  The first Dict if found, otherwhise NULL
  */
-gdcmDictSet::gdcmDictSet(void) {
-   dicts[PUB_DICT_NAME] = DefaultPubDict;
+Dict *DictSet::GetFirstEntry()
+{
+   ItDictHt = Dicts.begin();
+   if( ItDictHt != Dicts.end() )
+      return ItDictHt->second;
+   return NULL;
 }
 
-void gdcmDictSet::LoadDictFromFile(string FileName, DictKey Name) {
-   gdcmDict *NewDict = new gdcmDict(FileName.c_str());
-   dicts[Name] = NewDict;
+/**
+ * \brief   Get the next entry while visiting the Hash table (DictSetHT)
+ * \note : meaningfull only if GetFirstEntry already called
+ * \return  The next Dict if found, otherwhise NULL
+ */
+Dict *DictSet::GetNextEntry()
+{
+   gdcmAssertMacro (ItDictHt != Dicts.end());
+  
+   ++ItDictHt;
+   if ( ItDictHt != Dicts.end() )
+      return ItDictHt->second;
+   return NULL;
 }
 
-void gdcmDictSet::Print(ostream& os) {
-   for (DictSetHT::iterator dict = dicts.begin(); dict != dicts.end(); ++dict){
-      os << "Printing dictionary " << dict->first << " \n";
-      dict->second->Print(os);
+/**
+ * \brief   Obtain from the GDCM_DICT_PATH environnement variable the
+ *          path to directory containing the dictionaries. When
+ *          the environnement variable is absent the path is defaulted
+ *          to "../Dicts/".
+ * @return  path to directory containing the dictionaries
+ */
+std::string DictSet::BuildDictPath() 
+{
+   std::string resultPath;
+   const char *envPath;
+   envPath = getenv("GDCM_DICT_PATH");
+
+   if (envPath && (strlen(envPath) != 0)) 
+   {
+      resultPath = envPath;
+      gdcmWarningMacro( "Dictionary path set from environnement");
+   } 
+   else
+   {
+      resultPath = PUB_DICT_PATH;
    }
+   if ( resultPath[resultPath.length()-1] != '/' )
+   {
+      resultPath += '/';
+   }
+
+   return resultPath;
 }
 
-gdcmDict * gdcmDictSet::GetDict(DictKey DictName) {
-   DictSetHT::iterator dict = dicts.find(DictName);
-   return dict->second;
+//-----------------------------------------------------------------------------
+// Protected
+/**
+ * \brief   Adds a Dictionary to a DictSet
+ * \return  always true
+ */
+bool DictSet::AppendDict(Dict *newDict, DictKey const &name)
+{
+   Dicts[name] = newDict;
+
+   return true;
 }
 
-gdcmDict * gdcmDictSet::GetDefaultPubDict() {
-   return GetDict(PUB_DICT_NAME);
+//-----------------------------------------------------------------------------
+// Private
+
+//-----------------------------------------------------------------------------
+// Print
+/**
+ * \brief   Print, in an informal fashion, the list of all the dictionaries
+ *          contained is this DictSet, along with their respective content.
+ * @param   os Output stream used for printing.
+ * @param indent Indentation string to be prepended during printing
+ */
+void DictSet::Print(std::ostream &os, std::string const & )
+{
+   for (DictSetHT::iterator dict = Dicts.begin(); dict != Dicts.end(); ++dict)
+   {
+      os << "Printing dictionary " << dict->first << std::endl;
+      dict->second->Print(os);
+   }
 }
+
+//-----------------------------------------------------------------------------
+} // end namespace gdcm