X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictSet.cxx;h=a18a25faff4cb6b2b0395d29c63fc08a34da83e6;hb=1d69b92978803204089d270599133917d944c651;hp=814ca802e223811cb31c608db41defeedf6d7bda;hpb=1aa2bb207fb6b9ce78f35e7547dd4c770e516adb;p=gdcm.git diff --git a/src/gdcmDictSet.cxx b/src/gdcmDictSet.cxx index 814ca802..a18a25fa 100644 --- a/src/gdcmDictSet.cxx +++ b/src/gdcmDictSet.cxx @@ -1,51 +1,245 @@ +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDictSet.cxx,v $ + Language: C++ + Date: $Date: 2004/10/12 04:35:45 $ + Version: $Revision: 1.38 $ + + 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 #include // For getenv -#include "gdcm.h" -#include "gdcmUtil.h" +namespace gdcm +{ + +//----------------------------------------------------------------------------- +// Constructor / Destructor +/** + * \ingroup DictSet + * \brief The Dictionnary Set obtained with this constructor simply + * contains the Default Public dictionnary. + */ +DictSet::DictSet() +{ + DictPath = BuildDictPath(); + std::string pubDictFile(DictPath); + pubDictFile += PUB_DICT_FILENAME; + Dicts[PUB_DICT_NAME] = new Dict(pubDictFile); +} -#define PUB_DICT_NAME "DicomV3Dict" -#define PUB_DICT_PATH "../Dicts/" -#define PUB_DICT_FILENAME "dicomV3.dic" +/** + * \ingroup DictSet + * \brief Destructor + */ +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(); -gdcmDictSet::gdcmDictSet(void) { - SetDictPath(); - if (! LoadDicomV3Dict()) - return; + // Remove virtual dictionnary entries + std::map::iterator it; + for(it = VirtualEntry.begin(); it != VirtualEntry.end(); ++it) + { + DictEntry *entry = it->second; + if ( entry ) + { + delete entry; + } + it->second = NULL; + } } -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; +//----------------------------------------------------------------------------- +// Print +/** + * \ingroup DictSet + * \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. + */ +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); + } } -int gdcmDictSet::LoadDicomV3Dict(void) { - if (dicts.count(PUB_DICT_NAME)) - return 1; - return LoadDictFromFile(DictPath + PUB_DICT_FILENAME, PUB_DICT_NAME); +//----------------------------------------------------------------------------- +// Public +/** + * \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 DictSet::GetPubDictTagNamesByCategory + * @return A list of all entries of the public dicom dictionnary. + */ +std::list *DictSet::GetPubDictEntryNames() +{ + return GetDefaultPubDict()->GetDictEntryNames(); } -int gdcmDictSet::LoadDictFromFile(string FileName, DictKey Name) { - gdcmDict *NewDict = new gdcmDict(FileName.c_str()); - dicts[Name] = NewDict; - return 0; +/** + * \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 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 > * + DictSet::GetPubDictEntryNamesByCategory() +{ + return GetDefaultPubDict()->GetDictEntryNamesByCategory(); } -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); - } +/** + * \ingroup DictSet + * \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; } -gdcmDict * gdcmDictSet::GetDict(DictKey DictName) { - DictSetHT::iterator dict = dicts.find(DictName); - return dict->second; +/** + * \ingroup DictSet + * \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::GetDefaultPublicDict() { - return GetDict(PUB_DICT_NAME); +/** + * \brief Create a DictEntry which will be reference + * in no dictionnary + * @return virtual entry + */ +DictEntry *DictSet::NewVirtualDictEntry(uint16_t group, + uint16_t element, + std::string vr, + std::string fourth, + std::string name) +{ + DictEntry* entry; + const std::string tag = DictEntry::TranslateToKey(group,element) + + "#" + vr + "#" + fourth + "#" + name; + std::map::iterator it; + + it = VirtualEntry.find(tag); + if(it != VirtualEntry.end()) + { + entry = it->second; + } + else + { + entry = new DictEntry(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 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; +} + +//----------------------------------------------------------------------------- +// Protected +bool DictSet::AppendDict(Dict *newDict, DictKey const & name) +{ + Dicts[name] = newDict; + + return true; //FIXME +} + +//----------------------------------------------------------------------------- +// Private + +//----------------------------------------------------------------------------- + +} // end namespace gdcm