X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDict.cxx;h=97d0eb7102d85d2e2944b3a3328bb38001990859;hb=a7b06006e972ee6ebc04f177a1461d4d5ae2089a;hp=e362675dab70de9f96474a486a4a66b59e597c93;hpb=5a6910a313a526514242a21b868c7186fca14168;p=gdcm.git diff --git a/src/gdcmDict.cxx b/src/gdcmDict.cxx index e362675d..97d0eb71 100644 --- a/src/gdcmDict.cxx +++ b/src/gdcmDict.cxx @@ -1,211 +1,261 @@ -// gdcmDict.cxx +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDict.cxx,v $ + Language: C++ + Date: $Date: 2005/05/11 15:01:47 $ + Version: $Revision: 1.75 $ + + 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 "gdcmDict.h" #include "gdcmUtil.h" +#include "gdcmDebug.h" + #include -#ifdef GDCM_NO_ANSI_STRING_STREAM -# include -# define ostringstream ostrstream -# else -# include -#endif +#include +#include + +namespace gdcm +{ +//----------------------------------------------------------------------------- +/// \brief auto generate 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( ) +{ + Filename=""; +} /** - * \ingroup gdcmDict - * \brief Construtor - * @param FileName from which to build the dictionary. + * \brief Constructor + * @param filename from which to build the dictionary. */ -gdcmDict::gdcmDict(std::string & FileName) { - std::ifstream from(FileName.c_str()); - dbg.Error(!from, "gdcmDict::gdcmDict: can't open dictionary", - FileName.c_str()); - guint16 group, element; - // CLEANME : use defines for all those constants - char buff[1024]; - TagKey key; +Dict::Dict(std::string const &filename) +{ + uint16_t group; + uint16_t element; TagName vr; - TagName fourth; + TagName vm; TagName name; - while (!from.eof()) { - from >> std::hex >> group >> element; - eatwhite(from); - from.getline(buff, 256, ' '); - vr = buff; - eatwhite(from); - from.getline(buff, 256, ' '); - fourth = buff; - from.getline(buff, 256, '\n'); - name = buff; - gdcmDictEntry * newEntry = new gdcmDictEntry(group, element, - vr, fourth, name); - // FIXME: use AddNewEntry - NameHt[name] = newEntry; - KeyHt[gdcmDictEntry::TranslateToKey(group, element)] = newEntry; + std::ifstream from( filename.c_str() ); + if( !from ) + { + 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); + AddEntry(newEntry); + } + + Filename = filename; + from.close(); } - from.close(); } /** - * \ingroup gdcmDict * \brief Destructor */ -gdcmDict::~gdcmDict() { - for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) { - gdcmDictEntry* EntryToDelete = tag->second; - if ( EntryToDelete ) - delete EntryToDelete; - } - KeyHt.clear(); - // Since AddNewEntry adds symetrical in both KeyHt and NameHT we can - // assume all the pointed gdcmDictEntries are already cleaned-up when - // we cleaned KeyHt. - NameHt.clear(); +Dict::~Dict() +{ + ClearEntry(); } +//----------------------------------------------------------------------------- +// 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 adds a new Dicom Dictionary Entry + * @param newEntry entry to add + * @return false if Dicom Element already exists */ -void gdcmDict::Print(std::ostream& os) { - PrintByKey(os); +bool Dict::AddEntry(DictEntry const &newEntry) +{ + const TagKey &key = newEntry.GetKey(); + + if(KeyHt.count(key) == 1) + { + gdcmWarningMacro( "Already present" << key.c_str()); + return false; + } + else + { + KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry)); + return true; + } } /** - * \ingroup gdcmDict - * \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 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 */ -void gdcmDict::PrintByKey(std::ostream& os) { - std::ostringstream s; - - for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag){ - s << "Tag : "; - s << "(" << std::hex << tag->second->GetGroup() << ','; - s << std::hex << tag->second->GetElement() << ") = " << std::dec; - s << tag->second->GetVR() << ", "; - s << tag->second->GetFourth() << ", "; - s << tag->second->GetName() << "." << std::endl; - } - os << s.str(); +bool Dict::ReplaceEntry(DictEntry const &newEntry) +{ + if ( RemoveEntry(newEntry.GetKey()) ) + { + KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry)); + return true; + } + return false; } /** - * \ingroup gdcmDict - * \brief Print all the dictionary entries contained in this dictionary. - * Entries will be sorted by the name of the dictionary entries. - * \warning AVOID USING IT : the name IS NOT an identifier - * unpredictable result - * @param os The output stream to be written to. + * \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 */ -void gdcmDict::PrintByName(std::ostream& os) { - std::ostringstream s; +bool Dict::RemoveEntry(TagKey const &key) +{ + TagKeyHT::const_iterator it = KeyHt.find(key); + if(it != KeyHt.end()) + { + KeyHt.erase(key); - for (TagNameHT::iterator tag = NameHt.begin(); tag != NameHt.end(); ++tag){ - s << "Tag : "; - s << tag->second->GetName() << ","; - s << tag->second->GetVR() << ", "; - s << tag->second->GetFourth() << ", "; - s << "(" << std::hex << tag->second->GetGroup() << ','; - s << std::hex << tag->second->GetElement() << ") = " << std::dec << std::endl; - } - os << s.str(); + return true; + } + else + { + gdcmWarningMacro( "Unfound entry" << key.c_str()); + return false; + } } /** - * \ingroup gdcmDict - * \brief Get the dictionnary entry identified by a given tag (group,element) - * @param group group of the entry to be found - * @param element element of the entry to be found - * @return the corresponding dictionnary entry when existing, NULL otherwise + * \brief removes an already existing Dicom Dictionary Entry, + * identified by its group,element number + * @param group Dicom group number of the Dicom Element + * @param elem Dicom element number of the Dicom Element + * @return false if Dicom Dictionary Entry doesn't exist */ -gdcmDictEntry * gdcmDict::GetTagByNumber(guint16 group, guint16 element) { - TagKey key = gdcmDictEntry::TranslateToKey(group, element); - if ( ! KeyHt.count(key)) - return (gdcmDictEntry*)0; - return KeyHt.find(key)->second; +bool Dict::RemoveEntry(uint16_t group, uint16_t elem) +{ + return RemoveEntry(DictEntry::TranslateToKey(group, elem)); } /** - * \ingroup gdcmDict - * \brief Get the dictionnary entry identified by it's name. - * @param name element of the ElVal to modify - * \warning : NEVER use it ! - * the 'name' IS NOT an identifier within the Dicom Dicom Dictionary - * the name MAY CHANGE between two versions ! - * @return the corresponding dictionnary entry when existing, NULL otherwise + * \brief Remove all Dicom Dictionary Entries */ -gdcmDictEntry * gdcmDict::GetTagByName(TagName name) { - if ( ! NameHt.count(name)) - return (gdcmDictEntry*)0; - return NameHt.find(name)->second; +void Dict::ClearEntry() +{ + // we assume all the pointed DictEntries are already cleaned-up + // when we clean KeyHt. + KeyHt.clear(); } /** - * \ingroup gdcmDict - * \brief replaces an already existing Dicom Element by a new one - * @param NewEntry - * @return false if Dicom Element doesn't exist + * \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 dictionary entry when existing, NULL otherwise */ -bool gdcmDict::ReplaceEntry(gdcmDictEntry* NewEntry) { - if ( RemoveEntry(NewEntry->gdcmDictEntry::GetKey()) ) { - KeyHt[ NewEntry->GetKey()] = NewEntry; - return (true); - } - return (false); +DictEntry *Dict::GetEntry(TagKey const &key) +{ + TagKeyHT::iterator it = KeyHt.find(key); + if ( it == KeyHt.end() ) + { + return 0; + } + return &(it->second); +} + +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); } /** - * \ingroup gdcmDict - * \brief adds a new Dicom Dictionary Entry - * @param NewEntry - * @return false if Dicom Element already existed + * \brief Get the first entry while visiting the Dict entries + * \return The first DicEntry if found, otherwhise NULL */ - bool gdcmDict::AddNewEntry(gdcmDictEntry* NewEntry) { - TagKey key; - key = NewEntry->GetKey(); - - if(KeyHt.count(key) == 1) { - dbg.Verbose(1, "gdcmDict::AddNewEntry already present", key.c_str()); - return(false); - } else { - KeyHt[NewEntry->GetKey()] = NewEntry; - return(true); - } +DictEntry *Dict::GetFirstEntry() +{ + ItKeyHt = KeyHt.begin(); + if( ItKeyHt != KeyHt.end() ) + return &(ItKeyHt->second); + return NULL; } /** - * \ingroup gdcmDict - * \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 + * \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 */ -bool gdcmDict::RemoveEntry(TagKey key) { - if(KeyHt.count(key) == 1) { - gdcmDictEntry* EntryToDelete = KeyHt.find(key)->second; - if ( EntryToDelete ) - delete EntryToDelete; - KeyHt.erase(key); - return (true); - } else { - dbg.Verbose(1, "gdcmDict::RemoveEntry unfound entry", key.c_str()); - return (false); - } +DictEntry *Dict::GetNextEntry() +{ + gdcmAssertMacro (ItKeyHt != KeyHt.end()); + + ++ItKeyHt; + if (ItKeyHt != KeyHt.end()) + return &(ItKeyHt->second); + return NULL; } +//----------------------------------------------------------------------------- +// Protected + +//----------------------------------------------------------------------------- +// Private + +//----------------------------------------------------------------------------- +// Print /** - * \ingroup gdcmDict - * \brief removes an already existing Dicom Dictionary Entry, - * identified by its group,element - number - * @param group Dicom group number of the Dicom Element - * @param element Dicom element number of the Dicom Element - * @return false if Dicom Dictionary Entry doesn't exist + * \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 */ -bool gdcmDict::RemoveEntry (guint16 group, guint16 element) { - return( RemoveEntry(gdcmDictEntry::TranslateToKey(group, element)) ); +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) + { + 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; + } + os << s.str(); } +//----------------------------------------------------------------------------- +} // end namespace gdcm