X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.h;h=2203ac951c749ef69e5ebf0e53cd0a80df2e3e3b;hb=3306c0c4d4513e73e1ca1ab60922ca02dc86a870;hp=30f4f2e77ace78a17b6a67d7e4faac9c9dbf7d28;hpb=00be59e3db4bb1efcb3ac7980822863d1f7b92e5;p=gdcm.git diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h index 30f4f2e7..2203ac95 100644 --- a/src/gdcmDocEntrySet.h +++ b/src/gdcmDocEntrySet.h @@ -1,29 +1,103 @@ -// gdcmDocEntrySet.h +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDocEntrySet.h,v $ + Language: C++ + Date: $Date: 2005/01/06 17:20:53 $ + Version: $Revision: 1.32 $ + + 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 GDCMDOCENTRYSET_H #define GDCMDOCENTRYSET_H -//----------------------------------------------------------------------------- +#include "gdcmBase.h" +#include "gdcmException.h" +#include + +namespace gdcm +{ +class DocEntry; +class ValEntry; +class BinEntry; +class SeqEntry; +class DictEntry; -class GDCM_EXPORT gdcmDocEntrySet { +typedef std::string BaseTagKey; +//----------------------------------------------------------------------------- +/** + * \ref DocEntrySet is an abstract base class for \ref ElementSet + * and \ref SQItem which are both containers for DocEntries. + * \ref ElementSet is based on the STL map<> container + * (see \ref ElementSet::TagHT), as opposed to \ref SQItem + * which is based on an STL list container (see \ref ListDocEntry). + * Since the syntax for adding a new element to a map<> or a list<> + * differ, \ref DocEntrySet is designed as an adapter to unify the + * interfaces of \ref DocEntrySet and \ref ElementSet. + * As an illustration of this design, please refer to the implementation + * of \ref AddEntry (or any pure virtual method) in both derived classes. + * This adapter unification of interfaces enables the parsing of a + * DICOM header containing (optionaly heavily nested) sequences to be + * written recursively [see \ref Document::ParseDES + * which calls \ref Document::ParseSQ, which in turns calls + * \ref Document::ParseDES ]. + * + * \note Developpers should strongly resist to the temptation of adding + * members to this class since this class is designed as an adapter + * in the form of an abstract base class. + */ +class GDCM_EXPORT DocEntrySet : public Base +{ +friend class File; public: + DocEntrySet() {}; + virtual ~DocEntrySet() {}; + /// \brief adds any type of entry to the entry set (pure vitual) + virtual bool AddEntry(DocEntry *Entry) = 0; // pure virtual + virtual bool RemoveEntry(DocEntry *EntryToRemove)=0; // pure virtual + virtual bool RemoveEntryNoDestroy(DocEntry *EntryToRemove)=0; // pure virtual - gdcmDocEntrySet(void); - ~gdcmDocEntrySet(void); + /// \brief write any type of entry to the entry set + virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0;// pure virtual - void gdcmElementSet::FindDocEntryLength (gdcmDocEntry *Entry); + virtual DocEntry* GetDocEntryByNumber(uint16_t group, + uint16_t elem) = 0; + DocEntry* GetDocEntryByName(TagName const & name); + virtual std::string GetEntryByNumber(uint16_t group, uint16_t elem) = 0; + std::string GetEntryByName(TagName const & name); + DictEntry* NewVirtualDictEntry(uint16_t group, + uint16_t element, + TagName const & vr = GDCM_UNKNOWN, + TagName const & fourth = GDCM_UNKNOWN, + TagName const & name = GDCM_UNKNOWN ); + protected: +// DocEntry related utilities + ValEntry* NewValEntryByNumber(uint16_t group,uint16_t elem, + TagName const & vr = GDCM_UNKNOWN); + BinEntry* NewBinEntryByNumber(uint16_t group,uint16_t elem, + TagName const & vr = GDCM_UNKNOWN); + SeqEntry* NewSeqEntryByNumber(uint16_t group,uint16_t elem); -private: - - bool gdcmDocEntrySet::LoadDocEntriesSet(bool exception_on_error = false) - throw(gdcmFormatError); +// DictEntry related utilities + DictEntry *GetDictEntryByName (TagName const & name); + DictEntry *GetDictEntryByNumber(uint16_t group, uint16_t elem); + DictEntry *GetDictEntryByNumber(uint16_t group, uint16_t elem, + TagName const & vr); }; - +} // end namespace gdcm //----------------------------------------------------------------------------- #endif