Program: gdcm
Module: $RCSfile: gdcmDict.cxx,v $
Language: C++
- Date: $Date: 2005/01/16 04:50:41 $
- Version: $Revision: 1.64 $
+ Date: $Date: 2007/05/23 14:18:09 $
+ Version: $Revision: 1.87 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#include <iostream>
#include <iomanip>
-namespace gdcm
+namespace GDCM_NAME_SPACE
{
+//-----------------------------------------------------------------------------
+/// \brief auto generated function, to fill up the Dicom Dictionnary,
+/// if relevant file is not found on user's disk
void FillDefaultDataDict(Dict *d);
+
//-----------------------------------------------------------------------------
// Constructor / Destructor
/**
* \brief Constructor
*/
-Dict::Dict(void)
+Dict::Dict( )
{
Filename="";
}
*/
Dict::Dict(std::string const &filename)
{
- uint16_t group;
- uint16_t element;
- TagName vr;
- TagName vm;
- TagName name;
-
+ gdcmDebugMacro( "in Dict::Dict, filename =[" << filename << "]" );
std::ifstream from( filename.c_str() );
- if( !from )
+ if ( !from )
{
- gdcmVerboseMacro( "Can't open dictionary" << filename.c_str());
+ gdcmWarningMacro( "Can't open dictionary" << filename.c_str());
// Using default embeded one:
FillDefaultDataDict( this );
}
else
- {
- while (!from.eof())
- {
- from >> std::hex;
- from >> group;
- from >> element;
- from >> vr;
- from >> vm;
- from >> std::ws; //remove white space
- std::getline(from, name);
-
- const DictEntry newEntry(group, element, vr, vm, name);
- AddNewEntry(newEntry);
- }
-
+ {
+ gdcmDebugMacro( "in Dict::Dict, DoTheLoadingJob filename =["
+ << filename << "]" );
+ DoTheLoadingJob(from);
Filename = filename;
- from.close();
}
}
}
//-----------------------------------------------------------------------------
-// Print
+// Public
+
/**
- * \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.
+ * \brief Add all the entries held in a source dictionary
+ * \note it concerns only Private Dictionnary
+ * @param filename from which to build the dictionary.
*/
-void Dict::Print(std::ostream &os, std::string const & )
+bool Dict::AddDict(std::string const &filename)
{
- os << "Dict file name : " << Filename << std::endl;
- std::ostringstream s;
-
- for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
+ std::ifstream from( filename.c_str() );
+ if ( !from )
{
- s << "Entry : ";
- s << "(" << std::hex << std::setw(4) << tag->second.GetGroup() << ',';
- s << std::hex << std::setw(4) << tag->second.GetElement() << ") = "
- << std::dec;
- s << tag->second.GetVR() << ", ";
- s << tag->second.GetVM() << ", ";
- s << tag->second.GetName() << "." << std::endl;
+ gdcmWarningMacro( "Can't open dictionary" << filename.c_str());
+ return false;
+ }
+ else
+ {
+ DoTheLoadingJob(from);
+ return true;
}
- os << s.str();
}
-
-//-----------------------------------------------------------------------------
-// Public
/**
- * \ingroup Dict
- * \brief Remove all Dicom Dictionary Entries
+ * \brief Removes from the current Dicom Dict all the entries held in a source dictionary
+ * \note it concerns only Private Dictionnary
+ * @param filename from which we read the entries to remove.
*/
-void Dict::ClearEntry()
+bool Dict::RemoveDict(std::string const &filename)
{
- // we assume all the pointed DictEntries are already cleaned-up
- // when we clean KeyHt.
- KeyHt.clear();
+ std::ifstream from( filename.c_str() );
+ if ( !from )
+ {
+ gdcmWarningMacro( "Can't open dictionary" << filename.c_str());
+ return false;
+ }
+ else
+ {
+ uint16_t group;
+ uint16_t elem;
+ TagName vr;
+ TagName vm;
+ TagName name;
+
+ while ( true )
+ {
+ from >> std::hex;
+ from >> group;
+
+ if (from.eof())
+ break;
+
+ from >> elem;
+ from >> vr;
+ from >> vm;
+ // from >> std::ws; //remove white space
+ std::getline(from, name);
+
+ RemoveEntry(group,elem);
+ }
+ from.close();
+ return true;
+ }
}
/**
- * \ingroup Dict
* \brief adds a new Dicom Dictionary Entry
* @param newEntry entry to add
* @return false if Dicom Element already exists
*/
-bool Dict::AddNewEntry(DictEntry const &newEntry)
+bool Dict::AddEntry(DictEntry *newEntry)
{
- const TagKey &key = newEntry.GetKey();
+ const TagKey &key = newEntry->GetKey();
- if(KeyHt.count(key) == 1)
+ if ( KeyHt.count(key) == 1 )
{
- gdcmVerboseMacro( "Already present" << key.c_str());
+ gdcmErrorMacro( "Already present:" << key );
return false;
}
else
{
- KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
+ newEntry->Register();
+ KeyHt.insert( TagKeyHT::value_type(key, newEntry));
return true;
}
}
-/**
- * \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
+/*
+ * \ 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
*/
-bool Dict::ReplaceEntry(DictEntry const &newEntry)
+
+ /* seems to be useless
+
+bool Dict::ReplaceEntry(DictEntry *newEntry) // seems to be useless
{
- if ( RemoveEntry(newEntry.GetKey()) )
+ const TagKey &key = newEntry->GetKey();
+ if ( RemoveEntry(key) )
{
- KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
- return true;
+ newEntry->Register();
+ KeyHt.insert( TagKeyHT::value_type(key, newEntry));
+ return true;
}
return false;
}
+*/
/**
- * \ingroup Dict
* \brief removes an already existing Dicom Dictionary Entry,
* identified by its Tag
* @param key (group|element)
* @return false if Dicom Dictionary Entry doesn't exist
*/
-bool Dict::RemoveEntry (TagKey const &key)
+bool Dict::RemoveEntry(TagKey const &key)
{
TagKeyHT::const_iterator it = KeyHt.find(key);
- if(it != KeyHt.end())
+ if ( it != KeyHt.end() )
{
- KeyHt.erase(key);
+ it->second->Unregister(); // delete the entry
+ KeyHt.erase(key); // remove pointer from HTable
return true;
}
else
{
- gdcmVerboseMacro( "Unfound entry" << key.c_str());
+ gdcmWarningMacro( "Unfound entry" << key );
return false;
}
}
* @param elem Dicom element number of the Dicom Element
* @return false if Dicom Dictionary Entry doesn't exist
*/
-bool Dict::RemoveEntry (uint16_t group, uint16_t elem)
+bool Dict::RemoveEntry(uint16_t group, uint16_t elem)
{
return RemoveEntry(DictEntry::TranslateToKey(group, elem));
}
/**
- * \brief Get the dictionnary 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
+ * \brief Remove all Dicom Dictionary Entries
*/
-DictEntry *Dict::GetDictEntry(uint16_t group, uint16_t elem)
+void Dict::ClearEntry()
+{
+ // we assume all the pointed DictEntries are already cleaned-up
+ // when we clean KeyHt.
+ TagKeyHT::const_iterator it;
+
+ for(it = KeyHt.begin();it!=KeyHt.end();++it)
+ it->second->Unregister(); // delete the entry
+ KeyHt.clear(); // remove all the entries from HTable
+
+}
+
+/**
+ * \brief Get the dictionary entry identified by a given tag ("group|element")
+ * @param key tag of the searched entry
+ * @return the corresponding dictionary entry when existing, NULL otherwise
+ */
+DictEntry *Dict::GetEntry(TagKey const &key)
{
- TagKey key = DictEntry::TranslateToKey(group, elem);
TagKeyHT::iterator it = KeyHt.find(key);
if ( it == KeyHt.end() )
{
return 0;
}
- return &(it->second);
+ return it->second;
}
-
-/**
- * \brief Consider all the entries of the public dicom dictionnary.
- * 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.
- */
-
-
- // Probabely useless
-
-
-//EntryNamesList *Dict::GetDictEntryNames()
-//{
-// EntryNamesList *result = new EntryNamesList;
-// for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
-// {
-// result->push_back( tag->second.GetName() );
-// }
-// return result;
-//}
-
-/**
- * \ingroup Dict
- * \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.
+/**
+ * \brief Get the dictionary entry identified by its "group" and "element")
+ * @param group Group number of the searched entry.
+ * @param elem Element number of the searched entry.
+ * @return the corresponding dictionary entry when existing, NULL otherwise
*/
-
- // Probabely useless
-
-//EntryNamesByCatMap *Dict::GetDictEntryNamesByCategory()
-//{
-// EntryNamesByCatMap *result = new EntryNamesByCatMap;
-//
-// for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
-// {
-// (*result)[tag->second.GetFourth()].push_back(tag->second.GetName());
-// }
-//
-// return result;
-//}
+DictEntry *Dict::GetEntry(uint16_t group, uint16_t elem)
+{
+ TagKey key = DictEntry::TranslateToKey(group, elem);
+ TagKeyHT::iterator it = KeyHt.find(key);
+ if ( it == KeyHt.end() )
+ {
+ return 0;
+ }
+ return it->second;
+}
/**
- * \brief Initialise the visit of the Hash table (KeyHt)
+ * \brief Get the first entry while visiting the Dict entries
+ * \return The first DicEntry if found, otherwhise NULL
*/
-void Dict::InitTraversal()
+DictEntry *Dict::GetFirstEntry()
{
ItKeyHt = KeyHt.begin();
+ if ( ItKeyHt != KeyHt.end() )
+ return ItKeyHt->second;
+ return NULL;
}
/**
- * \brief Get the next entry whil visiting the Hash table (KeyHt)
+ * \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()
{
- if (ItKeyHt != KeyHt.end())
- {
- DictEntry *tmp = &(ItKeyHt->second);
- ++ItKeyHt;
+ gdcmAssertMacro (ItKeyHt != KeyHt.end());
- return tmp;
- }
- else
- {
- return NULL;
- }
+ ++ItKeyHt;
+ if (ItKeyHt != KeyHt.end())
+ return ItKeyHt->second;
+ return NULL;
}
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
// Private
+/**
+ * \brief Add all the dictionary entries from an already open source file
+ * @param from input stream to read from.
+ */
+void Dict::DoTheLoadingJob(std::ifstream &from)
+{
+ if (!from)
+ return;
+
+ uint16_t group;
+ uint16_t elem;
+ VRKey vr;
+ TagName vm;
+ TagName name;
+ DictEntry *newEntry;
+ while ( true )
+ {
+ from >> std::hex;
+ from >> group;
+ from >> elem;
+ from >> vr;
+ from >> vm;
+ from >> std::ws; //remove white space
+ std::getline(from, name);
+
+ if(from.eof()) {
+ break;
+ }
+
+ newEntry = DictEntry::New(group, elem, vr, vm, name);
+ AddEntry(newEntry);
+ newEntry->Delete();
+ }
+ from.close();
+}
//-----------------------------------------------------------------------------
+// Print
+/**
+ * \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 Indentation string to be prepended during printing
+ */
+void Dict::Print(std::ostream &os, std::string const & )
+{
+ os << "Dict file name : [" << Filename << "]" << std::endl;
+ std::ostringstream s;
+
+ for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
+ {
+std::cout << tag->second->GetKey() << " " << tag->second->GetName()
+ << std::endl;
+ s << "Entry : ";
+ s << "(" << tag->second->GetKey() << ") = "
+ << std::dec;
+ s << tag->second->GetVR() << ", ";
+ s << tag->second->GetVM() << ", ";
+ s << tag->second->GetName() << "." << std::endl;
+
+ }
+ os << s.str();
+
+}
+//-----------------------------------------------------------------------------
} // end namespace gdcm
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff