X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictSet.cxx;h=5554a8d02bc19bb5e2fdb2f1616edbfe64f9851e;hb=1d1824283002d1fcc3b8ff98170fc879c17f108f;hp=fd2c0108272922df7e9888d999e15b24b897a1ff;hpb=a7fd99a84f77ff929d8335e3a03c9945276e905f;p=gdcm.git diff --git a/src/gdcmDictSet.cxx b/src/gdcmDictSet.cxx index fd2c0108..5554a8d0 100644 --- a/src/gdcmDictSet.cxx +++ b/src/gdcmDictSet.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDictSet.cxx,v $ Language: C++ - Date: $Date: 2005/01/17 10:56:50 $ - Version: $Revision: 1.51 $ + Date: $Date: 2005/02/02 15:07:41 $ + Version: $Revision: 1.59 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -27,7 +27,6 @@ namespace gdcm //----------------------------------------------------------------------------- // Constructor / Destructor /** - * \ingroup DictSet * \brief The Dictionary Set obtained with this constructor simply * contains the Default Public dictionary. */ @@ -40,12 +39,11 @@ DictSet::DictSet() } /** - * \ingroup DictSet * \brief Destructor */ DictSet::~DictSet() { - // Remove dictionnaries + // Remove dictionaries for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) { Dict *entryToDelete = tag->second; @@ -61,79 +59,9 @@ DictSet::~DictSet() VirtualEntry.clear(); } -//----------------------------------------------------------------------------- -// 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, std::string const & ) -{ - for (DictSetHT::iterator dict = Dicts.begin(); dict != Dicts.end(); ++dict) - { - os << "Printing dictionary " << dict->first << std::endl; - dict->second->Print(os); - } -} - //----------------------------------------------------------------------------- // Public -/** - * \ingroup DictSet - * \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(); -//} - -/** - * \ingroup DictSet - * \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(); -//} - /** - * \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 @@ -141,8 +69,8 @@ void DictSet::Print(std::ostream &os, std::string const & ) * @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 *DictSet::LoadDictFromFile(std::string const &filename, + DictKey const &name) { Dict *newDict = new Dict(filename); AppendDict(newDict, name); @@ -151,7 +79,6 @@ Dict *DictSet::LoadDictFromFile(std::string const & filename, } /** - * \ingroup DictSet * \brief Retrieve the specified dictionary (when existing) from this * DictSet. * @param dictName The symbolic name of the searched dictionary. @@ -200,12 +127,39 @@ DictEntry *DictSet::NewVirtualDictEntry( uint16_t group, 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; +} + /** * \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 DictSet::BuildDictPath() { @@ -230,36 +184,12 @@ std::string DictSet::BuildDictPath() return resultPath; } - -/** - * \brief Initialise the visit of the Hash table (DictSetHT) - */ -void DictSet::InitTraversal() -{ - ItDictHt = Dicts.begin(); -} - -/** - * \brief Get the next entry while visiting the Hash table (DictSetHT) - * \return The next Dict if found, otherwhise NULL - */ -Dict *DictSet::GetNextEntry() -{ - if (ItDictHt != Dicts.end()) - { - Dict *tmp = ItDictHt->second; - ++ItDictHt; - - return tmp; - } - else - { - return NULL; - } -} - //----------------------------------------------------------------------------- // Protected +/** + * \brief Adds a Dictionary to a DictSet + * \return always true + */ bool DictSet::AppendDict(Dict *newDict, DictKey const &name) { Dicts[name] = newDict; @@ -271,5 +201,21 @@ bool DictSet::AppendDict(Dict *newDict, DictKey const &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