Program: gdcm
Module: $RCSfile: gdcmDict.cxx,v $
Language: C++
- Date: $Date: 2005/01/07 12:29:17 $
- Version: $Revision: 1.56 $
+ Date: $Date: 2005/01/18 14:28:32 $
+ Version: $Revision: 1.68 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
void FillDefaultDataDict(Dict *d);
//-----------------------------------------------------------------------------
// Constructor / Destructor
+/**
+ * \brief Constructor
+ */
+Dict::Dict( )
+{
+ Filename="";
+}
+
/**
* \brief Constructor
* @param filename from which to build the dictionary.
std::ifstream from( filename.c_str() );
if( !from )
{
- dbg.Verbose(2,"Dict::Dict: can't open dictionary", filename.c_str());
+ gdcmVerboseMacro( "Can't open dictionary" << filename.c_str());
// Using default embeded one:
FillDefaultDataDict( this );
}
}
Filename = filename;
+ from.close();
}
- from.close();
}
/**
*/
Dict::~Dict()
{
- // we assume all the pointed DictEntries are already cleaned-up
- // when we clean KeyHt.
- KeyHt.clear();
+ ClearEntry();
}
//-----------------------------------------------------------------------------
* \brief Print all the dictionary entries contained in this dictionary.
* Entries will be sorted by tag i.e. the couple (group, element).
* @param os The output stream to be written to.
+ * @param indent indent
*/
-void Dict::Print(std::ostream &os)
+void Dict::Print(std::ostream &os, std::string const & )
{
os << "Dict file name : " << Filename << std::endl;
- PrintByKey(os);
-}
-
-/**
- * \brief Print all the dictionary entries contained in this dictionary.
- * Entries will be sorted by tag i.e. the couple (group, element).
- * @param os The output stream to be written to.
- */
-void Dict::PrintByKey(std::ostream &os)
-{
std::ostringstream s;
for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
os << s.str();
}
+
//-----------------------------------------------------------------------------
// Public
/**
- * \ingroup Dict
+ * \brief Remove all Dicom Dictionary Entries
+ */
+void Dict::ClearEntry()
+{
+ // we assume all the pointed DictEntries are already cleaned-up
+ // when we clean KeyHt.
+ KeyHt.clear();
+}
+
+/**
* \brief adds a new Dicom Dictionary Entry
* @param newEntry entry to add
* @return false if Dicom Element already exists
if(KeyHt.count(key) == 1)
{
- dbg.Verbose(1, "Dict::AddNewEntry already present", key.c_str());
+ gdcmVerboseMacro( "Already present" << key.c_str());
return false;
}
else
}
/**
- * \ingroup Dict
* \brief replaces an already existing Dicom Element by a new one
* @param newEntry new entry (overwrites any previous one with same tag)
* @return false if Dicom Element doesn't exist
}
/**
- * \ingroup Dict
* \brief removes an already existing Dicom Dictionary Entry,
* identified by its Tag
* @param key (group|element)
TagKeyHT::const_iterator it = KeyHt.find(key);
if(it != KeyHt.end())
{
- const DictEntry& entryToDelete = it->second;
KeyHt.erase(key);
return true;
}
else
{
- dbg.Verbose(1, "Dict::RemoveEntry unfound entry", key.c_str());
+ gdcmVerboseMacro( "Unfound entry" << key.c_str());
return false;
}
}
}
/**
- * \brief Get the dictionnary entry identified by a given tag (group,element)
+ * \brief Get the dictionary entry identified by a given tag (group,element)
* @param group group of the entry to be found
* @param elem element of the entry to be found
- * @return the corresponding dictionnary entry when existing, NULL otherwise
+ * @return the corresponding dictionary entry when existing, NULL otherwise
*/
-DictEntry *Dict::GetDictEntryByNumber(uint16_t group, uint16_t elem)
+DictEntry *Dict::GetDictEntry(uint16_t group, uint16_t elem)
{
TagKey key = DictEntry::TranslateToKey(group, elem);
TagKeyHT::iterator it = KeyHt.find(key);
}
/**
- * \brief Consider all the entries of the public dicom dictionnary.
+ * \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 dictionnary.
+ * @return A list of all entries of the public dicom dictionary.
*/
//}
/**
- * \ingroup Dict
- * \brief Consider all the entries of the public dicom dictionnary.
+ * \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 dictionnary entries among that
+ * 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.
* 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
+ * (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' Dictionnary, that would be more friendly
- * than asking us to perform a line by line check of the dictionnary
+ * 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 dictionnary entries
+ * corresponding values are lists of all the dictionary entries
* among that group.
*/
// return result;
//}
+/**
+ * \brief Get the first entry while visiting the Dict entries
+ * \return The first DicEntry if found, otherwhise NULL
+ */
+DictEntry *Dict::GetFirstEntry()
+{
+ ItKeyHt = KeyHt.begin();
+ if( ItKeyHt != KeyHt.end() )
+ return &(ItKeyHt->second);
+ return NULL;
+}
+
+/**
+ * \brief Get the next entry while visiting the Hash table (KeyHt)
+ * \note : meaningfull only if GetFirstEntry already called
+ * \return The next DictEntry if found, otherwhise NULL
+ */
+DictEntry *Dict::GetNextEntry()
+{
+ gdcmAssertMacro (ItKeyHt != KeyHt.end());
+
+ {
+ ++ItKeyHt;
+ if (ItKeyHt != KeyHt.end())
+ return &(ItKeyHt->second);
+ }
+ return NULL;
+}
+
//-----------------------------------------------------------------------------
// Protected