X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictSet.cxx;h=8ec72b614d6ede6eefa1534915623f1493f6e9f9;hb=3a9e9df62b3198c4f93d1768074b6be828ac7308;hp=882344aeef27d64adc399083d7e3b3b4f851b66f;hpb=d569212ce5d0577c01b30796b288aafc2ae4fd9d;p=gdcm.git diff --git a/src/gdcmDictSet.cxx b/src/gdcmDictSet.cxx index 882344ae..8ec72b61 100644 --- a/src/gdcmDictSet.cxx +++ b/src/gdcmDictSet.cxx @@ -1,219 +1,221 @@ -// 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 #include // For getenv +namespace gdcm +{ + //----------------------------------------------------------------------------- // Constructor / Destructor /** - * \ingroup gdcmDictSet - * \brief The Dictionnary Set obtained with this constructor simply - * contains the Default Public dictionnary. + * \brief The Dictionary Set obtained with this constructor simply + * contains the Default Public dictionary. */ -gdcmDictSet::gdcmDictSet(void) +DictSet::DictSet() { DictPath = BuildDictPath(); - std::string PubDictFile(DictPath); - PubDictFile += PUB_DICT_FILENAME; /// MEMORY LEAK std::string::operator+= - Dicts[PUB_DICT_NAME] = new gdcmDict(PubDictFile); + std::string pubDictFile(DictPath); + pubDictFile += PUB_DICT_FILENAME; + Dicts[PUB_DICT_NAME] = new Dict(pubDictFile); } /** - * \ingroup gdcmDictSet * \brief Destructor */ -gdcmDictSet::~gdcmDictSet() +DictSet::~DictSet() { - // Remove dictionnaries + // Remove dictionaries for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) { - gdcmDict *EntryToDelete = tag->second; - if ( EntryToDelete ) - delete EntryToDelete; - tag->second=NULL; + Dict *entryToDelete = tag->second; + if ( entryToDelete ) + { + delete entryToDelete; + } + tag->second = NULL; } Dicts.clear(); - // Remove virtual dictionnary entries - std::map::iterator it; - for(it=virtualEntry.begin(); it!=virtualEntry.end(); ++it) - { - gdcmDictEntry *Entry = it->second; - if ( Entry ) - delete Entry; - it->second=NULL; - } -} - -//----------------------------------------------------------------------------- -// Print -/** - * \ingroup gdcmDictSet - * \brief Print, in an informal fashion, the list of all the dictionaries - * contained is this gdcmDictSet, 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) - { - os << "Printing dictionary " << dict->first << std::endl; - dict->second->Print(os); - } + // Remove virtual dictionary entries + VirtualEntry.clear(); } //----------------------------------------------------------------------------- // Public -/** - * \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. - */ -std::list *gdcmDictSet::GetPubDictEntryNames(void) -{ - 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' - * (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 > *gdcmDictSet::GetPubDictEntryNamesByCategory(void) -{ - return(GetDefaultPubDict()->GetDictEntryNamesByCategory()); -} - /** - * \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 + * 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. */ -gdcmDict *gdcmDictSet::LoadDictFromFile(std::string FileName, DictKey Name) +Dict *DictSet::LoadDictFromFile(std::string const &filename, + DictKey const &name) { - gdcmDict *NewDict = new gdcmDict(FileName); - AppendDict(NewDict,Name); - return(NewDict); + Dict *newDict = new Dict(filename); + AppendDict(newDict, name); + + return newDict; } /** - * \ingroup gdcmDictSet * \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) +Dict *DictSet::GetDict(DictKey const &dictName) { - DictSetHT::iterator dict = Dicts.find(DictName); - if(dict!=Dicts.end()) + 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. - */ -gdcmDict *gdcmDictSet::GetDefaultPubDict() -{ - return GetDict(PUB_DICT_NAME); -} - -/** - * \ingroup gdcmDictSet - * \brief Create a gdcmDictEntry which will be reference - * in no dictionnary + * \brief Create a DictEntry which will be referenced + * in no dictionary * @return virtual entry */ -gdcmDictEntry *gdcmDictSet::NewVirtualDictEntry(guint16 group, guint16 element, - std::string vr,std::string fourth, - std::string name) +DictEntry *DictSet::NewVirtualDictEntry( uint16_t group, + uint16_t element, + TagName vr, + TagName vm, + TagName name) { - gdcmDictEntry *entry; - std::string tag=gdcmDictEntry::TranslateToKey(group,element)+"#"+vr+"#"+fourth+"#"+name; - std::map::iterator it; + DictEntry *entry; + const std::string tag = DictEntry::TranslateToKey(group,element) + + "#" + vr + "#" + vm + "#" + name; + TagKeyHT::iterator it; - it=virtualEntry.find(tag); - if(it!=virtualEntry.end()) + it = VirtualEntry.find(tag); + if(it != VirtualEntry.end()) { - entry=it->second; + entry = &(it->second); } else { - entry=new gdcmDictEntry(group,element,vr,fourth,name); - virtualEntry[tag]=entry; + DictEntry ent(group, element, vr, vm, name); + VirtualEntry.insert( + std::map::value_type + (tag, ent)); + entry = &(VirtualEntry.find(tag)->second); } - return(entry); + + return entry; +} + +/** + * \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; } /** - * \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 dictionnaries + * @return path to directory containing the dictionaries */ -std::string gdcmDictSet::BuildDictPath(void) +std::string DictSet::BuildDictPath() { - std::string ResultPath; - const char *EnvPath = (char*)0; - EnvPath = getenv("GDCM_DICT_PATH"); - if (EnvPath && (strlen(EnvPath) != 0)) + std::string resultPath; + const char *envPath; + 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"); + resultPath = envPath; + gdcmWarningMacro( "Dictionary path set from environnement"); } else - ResultPath = PUB_DICT_PATH; - return ResultPath; + { + resultPath = PUB_DICT_PATH; + } + if ( resultPath[resultPath.length()-1] != '/' ) + { + resultPath += '/'; + } + + return resultPath; } //----------------------------------------------------------------------------- // Protected -bool gdcmDictSet::AppendDict(gdcmDict *NewDict,DictKey Name) +/** + * \brief Adds a Dictionary to a DictSet + * \return always true + */ +bool DictSet::AppendDict(Dict *newDict, DictKey const &name) { - Dicts[Name] = NewDict; - return(true); + Dicts[name] = newDict; + + return true; } //----------------------------------------------------------------------------- // 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