X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDict.h;h=b7c3c5bc0da29b9d4bfc4168d6b6d545537f8682;hb=a150a376b47fc0894b57d18a59e970b2b9f2889f;hp=10a585693b1a93de7b15dd2a687219730c313f42;hpb=55d77e0913ff360d639af1841c70d14dc8687584;p=gdcm.git diff --git a/src/gdcmDict.h b/src/gdcmDict.h index 10a58569..b7c3c5bc 100644 --- a/src/gdcmDict.h +++ b/src/gdcmDict.h @@ -1,69 +1,95 @@ -// gdcmDict.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDict.h,v $ + Language: C++ + Date: $Date: 2004/12/16 13:46:37 $ + Version: $Revision: 1.25 $ + + 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. + +=========================================================================*/ + #ifndef GDCMDICT_H #define GDCMDICT_H -#include "gdcmCommon.h" +#include "gdcmBase.h" #include "gdcmDictEntry.h" #include #include #include -//----------------------------------------------------------------------------- -typedef std::map TagKeyHT; -typedef std::map TagNameHT; +namespace gdcm +{ +//----------------------------------------------------------------------------- +typedef std::string DictKey; +typedef std::map TagKeyHT; +typedef std::map TagNameHT; +typedef std::list EntryNamesList; +typedef std::map > EntryNamesByCatMap; //----------------------------------------------------------------------------- /* - * \defgroup gdcmDict - * \brief gdcmDict acts a memory representation of a dicom dictionary i.e. + * \defgroup Dict + * \brief Dict acts a memory representation of a dicom dictionary i.e. * it is a container for a collection of dictionary entries. The * dictionary is loaded from in an ascii file. * There should be a single public dictionary (THE dictionary of * the actual DICOM v3) but as many shadow dictionaries as imagers * combined with all software versions... - * \see gdcmDictSet + * \see DictSet */ -class GDCM_EXPORT gdcmDict { +class GDCM_EXPORT Dict : public Base +{ public: - gdcmDict(std::string & FileName); - ~gdcmDict(); + Dict(std::string const & filename); + ~Dict(); // Print - void Print(std::ostream &os = std::cout); - void PrintByKey(std::ostream &os = std::cout); - void PrintByName(std::ostream &os = std::cout); + void Print(std::ostream &os = std::cout); + void PrintByKey(std::ostream &os = std::cout); + void PrintByName(std::ostream &os = std::cout); // Entries - bool AddNewEntry (gdcmDictEntry *NewEntry); - bool ReplaceEntry(gdcmDictEntry *NewEntry); - bool RemoveEntry (TagKey key); - bool RemoveEntry (guint16 group, guint16 element); - + bool AddNewEntry (DictEntry const & newEntry); + bool ReplaceEntry(DictEntry const & newEntry); + bool RemoveEntry (TagKey const & key); + bool RemoveEntry (uint16_t group, uint16_t element); + // Tag - gdcmDictEntry *GetDictEntryByName(TagName name); - gdcmDictEntry *GetDictEntryByNumber(guint16 group, guint16 element); + DictEntry *GetDictEntryByName(TagName const & name); + DictEntry *GetDictEntryByNumber(uint16_t group, uint16_t element); + + EntryNamesList *GetDictEntryNames(); + EntryNamesByCatMap *GetDictEntryNamesByCategory(); - std::list *GetDictEntryNames(void); - std::map > * - GetDictEntryNamesByCategory(void); + /// \brief Returns a ref to the Dicom Dictionary H table (map) + /// @return the Dicom Dictionary H table + const TagKeyHT & GetEntriesByKey() const { return KeyHt; } - /** - * \ingroup gdcmDict - * \brief returns a ref to the Dicom Dictionary H table (map) - * return the Dicom Dictionary H table - */ - inline TagKeyHT & gdcmDict::GetEntries(void) { return KeyHt; } + /// \brief Returns a ref to the Dicom Dictionary H table (map) + /// @return the Dicom Dictionary H table + const TagNameHT & GetEntriesByName() const { return NameHt; } private: /// ASCII file holding the Dictionnary - std::string filename; + std::string Filename; + /// Access through TagKey (see alternate access with NameHt) - TagKeyHT KeyHt; + TagKeyHT KeyHt; + /// Access through TagName (see alternate access with KeyHt) - TagNameHT NameHt; + TagNameHT NameHt; }; +} // end namespace gdcm //----------------------------------------------------------------------------- #endif