X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.h;h=ec56a65b3907ec95ef0bae4267a602983e6e8ff2;hb=0416947420d9168401c99e7fbf0dca0a081c9175;hp=94566ad23b62ff835f2643f71e18a16ced0b19ef;hpb=98b5c3d02083ad65fce19ff79007fcc3f370e7c5;p=gdcm.git diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h index 94566ad2..ec56a65b 100644 --- a/src/gdcmDocEntrySet.h +++ b/src/gdcmDocEntrySet.h @@ -1,47 +1,140 @@ -// gdcmDocEntrySet.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDocEntrySet.h,v $ + Language: C++ + Date: $Date: 2005/02/07 08:48:18 $ + Version: $Revision: 1.49 $ + + 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 "gdcmException.h" -#include "gdcmDocEntry.h" - -//----------------------------------------------------------------------------- +#include "gdcmBase.h" +#include -class GDCM_EXPORT gdcmDocEntrySet +namespace gdcm { +//----------------------------------------------------------------------------- +class DocEntry; +class ValEntry; +class BinEntry; +class SeqEntry; +class DictEntry; +typedef std::string BaseTagKey; + +//----------------------------------------------------------------------------- +/** + * \brief + * \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 +{ public: + /// Canonical Constructor + DocEntrySet() {}; + /// Canonical Destructor + virtual ~DocEntrySet() {}; - gdcmDocEntrySet(int depth = 0); - ~gdcmDocEntrySet(void); + /// \brief write any type of entry to the entry set + virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0; - virtual bool AddEntry(gdcmDocEntry *Entry) = 0; // pure virtual - bool CheckEntryVR(gdcmDocEntry *Entry, std::string vr); - virtual void Print (std::ostream & os = std::cout) = 0;// pure virtual + /// \brief Remove all Entry in the entry set + virtual void ClearEntry() = 0; + /// \brief adds any type of entry to the entry set + virtual bool AddEntry(DocEntry *Entry) = 0; + /// \brief Removes any type of entry out of the entry set, and destroys it + virtual bool RemoveEntry(DocEntry *EntryToRemove) = 0; + /// \brief Removes any type of entry out of the entry set, DOESN'T destroy it + virtual bool RemoveEntryNoDestroy(DocEntry *EntryToRemove) = 0; + /// Gets the first entry of any type of set + virtual DocEntry *GetFirstEntry()=0; + /// Gets the next entry of any type of set + virtual DocEntry *GetNextEntry()=0; - inline int GetDepthLevel(void) - {return(SQDepthLevel);} - void SetDepthLevel(int depth) - {SQDepthLevel = depth;} - -protected: + virtual std::string GetEntryValue(uint16_t group, uint16_t elem); + virtual void *GetEntryBinArea(uint16_t group, uint16_t elem); + virtual int GetEntryLength(uint16_t group, uint16_t elem); + virtual std::string GetEntryVR(uint16_t group, uint16_t elem); - void gdcmDocEntrySet::FindDocEntryLength (gdcmDocEntry *Entry); - - // DocEntry related utilities - - virtual gdcmDocEntry *NewDocEntryByNumber(guint16 group, - guint16 element)=0; // pure virtual - virtual gdcmDocEntry *NewDocEntryByName (std::string Name)=0;// pure virtual + /// \brief Gets any type of DocEntry, identified by its (group,elem) + virtual DocEntry *GetDocEntry(uint16_t group, uint16_t elem) = 0; + /// \brief Gets a ValEntry, identified by its (group, elem) + virtual ValEntry *GetValEntry(uint16_t group, uint16_t elem); + /// \brief Gets a BinEntry, identified by its (group,elem) + virtual BinEntry *GetBinEntry(uint16_t group, uint16_t elem); + /// \brief Gets a SeqEntry, identified by its (group,elem) + virtual SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem); + + virtual bool SetValEntry(std::string const &content, + uint16_t group, uint16_t elem); + virtual bool SetBinEntry(uint8_t *content, int lgth, + uint16_t group, uint16_t elem); + virtual bool SetValEntry(std::string const &content, ValEntry *entry); + virtual bool SetBinEntry(uint8_t *content, int lgth, BinEntry *entry); + + virtual ValEntry *InsertValEntry(std::string const &value, + uint16_t group, uint16_t elem, + TagName const &vr = GDCM_UNKNOWN); + virtual BinEntry *InsertBinEntry(uint8_t *binArea, int lgth, + uint16_t group, uint16_t elem, + TagName const &vr = GDCM_UNKNOWN); + virtual SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem); + /// tells us if the set contains no entry + virtual bool IsEmpty() = 0; + virtual bool CheckIfEntryExist(uint16_t group, uint16_t elem); + +// DocEntry related utilities + ValEntry *NewValEntry(uint16_t group,uint16_t elem, + TagName const &vr = GDCM_UNKNOWN); + BinEntry *NewBinEntry(uint16_t group, uint16_t elem, + TagName const &vr = GDCM_UNKNOWN); + SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem); + +// DictEntry related utilities + DictEntry *NewVirtualDictEntry(uint16_t group,uint16_t elem, + TagName const &vr = GDCM_UNKNOWN, + TagName const &vm = GDCM_UNKNOWN, + TagName const &name = GDCM_UNKNOWN ); + +protected: +// DictEntry related utilities + DictEntry *GetDictEntry(uint16_t group, uint16_t elem); + DictEntry *GetDictEntry(uint16_t group, uint16_t elem, + TagName const &vr); - int SQDepthLevel; - private: - }; - +} // end namespace gdcm //----------------------------------------------------------------------------- #endif