X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDict.h;h=d5f9aea1493ff1c8283d0d1136be01cb1f95cb13;hb=ab62b1a706df8e2ab1fbf26fa5037d6c22293655;hp=1e1f0754e17e2e5bce3da000978df99639df9592;hpb=65467b71ee500909b0ef7c31d442ca0c160d6a15;p=gdcm.git diff --git a/src/gdcmDict.h b/src/gdcmDict.h index 1e1f0754..d5f9aea1 100644 --- a/src/gdcmDict.h +++ b/src/gdcmDict.h @@ -1,5 +1,21 @@ -// gdcmDict.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDict.h,v $ + Language: C++ + Date: $Date: 2004/07/28 21:23:20 $ + Version: $Revision: 1.17 $ + + 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.htm 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 @@ -11,7 +27,7 @@ #include //----------------------------------------------------------------------------- -typedef std::map TagKeyHT; +typedef std::map TagKeyHT; typedef std::map TagNameHT; //----------------------------------------------------------------------------- @@ -25,45 +41,46 @@ typedef std::map TagNameHT; * combined with all software versions... * \see gdcmDictSet */ -class GDCM_EXPORT gdcmDict { +class GDCM_EXPORT gdcmDict +{ public: - gdcmDict(std::string & FileName); - ~gdcmDict(); + gdcmDict(std::string const & FileName); + ~gdcmDict(); // 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 ReplaceEntry(gdcmDictEntry *NewEntry); + bool RemoveEntry (gdcmTagKey key); + bool RemoveEntry (uint16_t group, uint16_t element); + // Tag - gdcmDictEntry *GetDictEntryByName(TagName name); - gdcmDictEntry *GetDictEntryByNumber(guint16 group, guint16 element); + gdcmDictEntry *GetDictEntryByName(TagName name); + gdcmDictEntry *GetDictEntryByNumber(uint16_t group, uint16_t element); - std::list *GetDictEntryNames(void); + std::list *GetDictEntryNames(); std::map > * - GetDictEntryNamesByCategory(void); + GetDictEntryNamesByCategory(); - /** - * \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 + TagKeyHT & GetEntriesByKey() { return KeyHt; } + + /// \brief Returns a ref to the Dicom Dictionary H table (map) + /// @return the Dicom Dictionary H table + TagNameHT & GetEntriesByName() { return NameHt; } private: - std::string name; - std::string filename; - - /// Access through TagKey (see alternate access with NameHt) - TagKeyHT KeyHt; + /// ASCII file holding the Dictionnary + std::string Filename; + /// Access through gdcmTagKey (see alternate access with NameHt) + TagKeyHT KeyHt; /// Access through TagName (see alternate access with KeyHt) - TagNameHT NameHt; + TagNameHT NameHt; }; //-----------------------------------------------------------------------------