-// 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
#include <map>
//-----------------------------------------------------------------------------
-typedef std::map<TagKey, gdcmDictEntry*> TagKeyHT;
+typedef std::map<gdcmTagKey, gdcmDictEntry*> TagKeyHT;
typedef std::map<TagName, gdcmDictEntry*> 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<std::string> *GetDictEntryNames(void);
+ std::list<std::string> *GetDictEntryNames();
std::map<std::string, std::list<std::string> > *
- GetDictEntryNamesByCategory(void);
+ GetDictEntryNamesByCategory();
+
+ /// \brief Returns a ref to the Dicom Dictionary H table (map)
+ /// @return the Dicom Dictionary H table
+ TagKeyHT & GetEntriesByKey() { 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
+ TagNameHT & GetEntriesByName() { return NameHt; }
private:
/// ASCII file holding the Dictionnary
- std::string filename;
- /// Access through TagKey (see alternate access with NameHt)
- TagKeyHT KeyHt;
+ 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;
};
//-----------------------------------------------------------------------------