+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmDictSet.cxx,v $
+ Language: C++
+ Date: $Date: 2005/01/23 10:12:33 $
+ Version: $Revision: 1.56 $
+
+ 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 "gdcm.h"
-#include "gdcmUtil.h"
-#define PUB_DICT_NAME "DicomV3Dict"
-#define PUB_DICT_PATH "../Dicts/"
-#define PUB_DICT_FILENAME "dicomV3.dic"
+namespace gdcm
+{
-gdcmDictSet::gdcmDictSet(void) {
- SetDictPath();
- if (! LoadDicomV3Dict())
- return;
+//-----------------------------------------------------------------------------
+// Constructor / Destructor
+/**
+ * \brief The Dictionary Set obtained with this constructor simply
+ * contains the Default Public dictionary.
+ */
+DictSet::DictSet()
+{
+ DictPath = BuildDictPath();
+ std::string pubDictFile(DictPath);
+ pubDictFile += PUB_DICT_FILENAME;
+ Dicts[PUB_DICT_NAME] = new Dict(pubDictFile);
}
-void gdcmDictSet::SetDictPath(void) {
- const char* EnvPath = (char*)0;
- EnvPath = getenv("GDCM_DICT_PATH");
- if (EnvPath && (strlen(EnvPath) != 0))
- DictPath = EnvPath;
- else
- DictPath = PUB_DICT_PATH;
+/**
+ * \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;
+ }
+ Dicts.clear();
+
+ // Remove virtual dictionary entries
+ VirtualEntry.clear();
}
-int gdcmDictSet::LoadDicomV3Dict(void) {
- if (dicts.count(PUB_DICT_NAME))
- return 1;
- return LoadDictFromFile(DictPath + PUB_DICT_FILENAME, PUB_DICT_NAME);
+//-----------------------------------------------------------------------------
+// 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);
+ }
}
-int gdcmDictSet::LoadDictFromFile(string FileName, DictKey Name) {
- gdcmDict *NewDict = new gdcmDict(FileName.c_str());
- dicts[Name] = NewDict;
+//-----------------------------------------------------------------------------
+// Public
+/**
+ * \brief Consider all the entries of the public dicom dictionary.
+ * Build all list of all the tag names of all those entries.
+ * \sa DictSet::GetPubDictTagNamesByCategory
+ * @return A list of all entries of the public dicom dictionary.
+ */
+
+// Probabely useless!
+
+//EntryNamesList *DictSet::GetPubDictEntryNames()
+//{
+// return GetDefaultPubDict()->GetDictEntryNames();
+//}
+
+/**
+ * \brief
+ * - Consider all the entries of the public dicom dictionary.
+ * - 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 dictionary entries among that
+ * group. Note that apparently the Dicom standard doesn't explicitely
+ * define a name (as a string) for each group.
+ * NO ! Dicom Standard explicitely doesn't define
+ * any name, for any 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 dictionary 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' Dictionary, that would be more friendly
+ * than asking us to perform a line by line check of the dictionary
+ * 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 dictionary entries
+ * among that group.
+ */
+
+
+// Probabely useless!
+
+//EntryNamesByCatMap *DictSet::GetPubDictEntryNamesByCategory()
+//{
+// return GetDefaultPubDict()->GetDictEntryNamesByCategory();
+//}
+
+/**
+ * \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.
+ */
+Dict *DictSet::LoadDictFromFile(std::string const & filename,
+ DictKey const & name)
+{
+ Dict *newDict = new Dict(filename);
+ AppendDict(newDict, name);
+
+ return newDict;
}
-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 Retrieve the specified dictionary (when existing) from this
+ * DictSet.
+ * @param dictName The symbolic name of the searched dictionary.
+ * \result The retrieved dictionary.
+ */
+Dict *DictSet::GetDict(DictKey const &dictName)
+{
+ DictSetHT::iterator dict = Dicts.find(dictName);
+ if(dict != Dicts.end())
+ {
+ return dict->second;
+ }
+ return NULL;
}
-gdcmDict * gdcmDictSet::GetDict(DictKey DictName) {
- DictSetHT::iterator dict = dicts.find(DictName);
- return dict->second;
+/**
+ * \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;
}
-gdcmDict * gdcmDictSet::GetDefaultPublicDict() {
- return GetDict(PUB_DICT_NAME);
+/**
+ * \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 = 0;
+ envPath = getenv("GDCM_DICT_PATH");
+
+ if (envPath && (strlen(envPath) != 0))
+ {
+ resultPath = envPath;
+ if ( resultPath[resultPath.length()-1] != '/' )
+ {
+ resultPath += '/';
+ }
+ gdcmVerboseMacro( "Dictionary path set from environnement");
+ }
+ else
+ {
+ resultPath = PUB_DICT_PATH;
+ }
+
+ return resultPath;
}
+
+
+/**
+ * \brief Get the first entry while visiting the DictSet
+ * \return The first Dict if found, otherwhise NULL
+ */
+Dict *DictSet::GetFirstEntry()
+{
+ ItDictHt = Dicts.begin();
+ if( ItDictHt != Dicts.end() )
+ return ItDictHt->second;
+ return NULL;
+}
+
+/**
+ * \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;
+}
+
+//-----------------------------------------------------------------------------
+// Protected
+
+/**
+ * \brief Adds a Dictionary to a DictSet
+ * \return always true
+ */
+bool DictSet::AppendDict(Dict *newDict, DictKey const &name)
+{
+ Dicts[name] = newDict;
+
+ return true;
+}
+
+//-----------------------------------------------------------------------------
+// Private
+
+//-----------------------------------------------------------------------------
+
+} // end namespace gdcm
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff