X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictSet.cxx;h=7256c6b1dccaace89f9ea559a9e043b657453d6e;hb=3e82e8b67eddf5d4b95b6aa2a2e2615aced4c452;hp=99b890200da1d523d2590459992389715e78b44b;hpb=29bdd1e88a28b6267618f633f304e1154537ce7b;p=gdcm.git diff --git a/src/gdcmDictSet.cxx b/src/gdcmDictSet.cxx index 99b89020..7256c6b1 100644 --- a/src/gdcmDictSet.cxx +++ b/src/gdcmDictSet.cxx @@ -1,153 +1,221 @@ -// gdcmDictEntry +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDictSet.cxx,v $ + Language: C++ + Date: $Date: 2005/02/02 10:02:16 $ + Version: $Revision: 1.58 $ + + 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 #include // 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 - * \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. */ -std::list * gdcmDictSet::GetPubDictTagNames(void) { - std::list * Result = new std::list; - TagKeyHT entries = GetDefaultPubDict()->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. - * \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. +//----------------------------------------------------------------------------- +// 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. */ -std::map > * gdcmDictSet::GetPubDictTagNamesByCategory(void) { - std::map > * Result = new std::map >; - TagKeyHT entries = GetDefaultPubDict()->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 newDict; +} + +/** + * \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 Result; + return NULL; +} + +/** + * \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::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 + * 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 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; +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; } -/** - * \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) { - DictPath = BuildDictPath(); - std::string PubDictFile = DictPath + PUB_DICT_FILENAME; - Dicts[PUB_DICT_NAME] = new gdcmDict(PubDictFile); +Dict *DictSet::GetFirstEntry() +{ + ItDictHt = Dicts.begin(); + if( ItDictHt != Dicts.end() ) + return ItDictHt->second; + return NULL; } -gdcmDictSet::~gdcmDictSet() { - for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) { - gdcmDict* EntryToDelete = tag->second; - if ( EntryToDelete ) - delete EntryToDelete; - } - Dicts.clear(); +/** + * \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 /** - * \ingroup gdcmDictSet - * \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 - * dictionary to load. - * @param Name Symbolic name that be used as identifier of the newly - * created dictionary. + * \brief Adds a Dictionary to a DictSet + * \return always true */ -void gdcmDictSet::LoadDictFromFile(std::string FileName, DictKey Name) { - gdcmDict *NewDict = new gdcmDict(FileName); - Dicts[Name] = NewDict; +bool DictSet::AppendDict(Dict *newDict, DictKey const &name) +{ + Dicts[name] = newDict; + + return true; } +//----------------------------------------------------------------------------- +// Private + +//----------------------------------------------------------------------------- +// Print /** - * \ingroup gdcmDictSet * \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. + * @param indent Indentation string to be prepended during printing */ -void gdcmDictSet::Print(std::ostream& os) { - for (DictSetHT::iterator dict = Dicts.begin(); dict != Dicts.end(); ++dict){ +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); } } -/** - * \ingroup gdcmDictSet - * \brief Retrieve the specified dictionary (when existing) from this - * gdcmDictSet. - * @param DictName The synbolic name of the searched dictionary. - * \result The retrieved dictionary. - */ -gdcmDict * gdcmDictSet::GetDict(DictKey DictName) { - DictSetHT::iterator dict = Dicts.find(DictName); - return dict->second; -} - -/** - * \ingroup gdcmDictSet - * \brief Retrieve the default reference DICOM V3 public dictionary. - * \result The retrieved default dictionary. - */ -gdcmDict * gdcmDictSet::GetDefaultPubDict() { - return GetDict(PUB_DICT_NAME); -} +//----------------------------------------------------------------------------- +} // end namespace gdcm