Program: gdcm
Module: $RCSfile: gdcmDictSet.cxx,v $
Language: C++
- Date: $Date: 2005/01/17 10:56:50 $
- Version: $Revision: 1.51 $
+ 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
//-----------------------------------------------------------------------------
// Constructor / Destructor
/**
- * \ingroup DictSet
* \brief The Dictionary Set obtained with this constructor simply
* contains the Default Public dictionary.
*/
}
/**
- * \ingroup DictSet
* \brief Destructor
*/
DictSet::~DictSet()
{
- // Remove dictionnaries
+ // Remove dictionaries
for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag)
{
Dict *entryToDelete = tag->second;
//-----------------------------------------------------------------------------
// 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.
+ * @param indent Indentation string to be prepended during printing
*/
void DictSet::Print(std::ostream &os, std::string const & )
{
//-----------------------------------------------------------------------------
// 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
//}
/**
- * \ingroup DictSet
* \brief
* - Consider all the entries of the public dicom dictionary.
* - Build an hashtable whose keys are the names of the groups
//}
/**
- * \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
}
/**
- * \ingroup DictSet
* \brief Retrieve the specified dictionary (when existing) from this
* DictSet.
* @param dictName The symbolic name of the searched dictionary.
/**
* \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()
{
/**
- * \brief Initialise the visit of the Hash table (DictSetHT)
+ * \brief Get the first entry while visiting the DictSet
+ * \return The first Dict if found, otherwhise NULL
*/
-void DictSet::InitTraversal()
+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()
{
- if (ItDictHt != Dicts.end())
- {
- Dict *tmp = ItDictHt->second;
- ++ItDictHt;
-
- return tmp;
- }
- else
- {
- return NULL;
- }
+ 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;