X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.h;h=9eaa474bda5e79849999835f733ce3ceccf70cc3;hb=1dd2c40c0da9098b444ad53b0e3c23da808997fa;hp=c77756822e43a9a5f09d89004a4ba2c49f43d2d3;hpb=62fd402e1fc63c4928ab86195dd66208b072dadb;p=gdcm.git diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h index c7775682..9eaa474b 100644 --- a/src/gdcmDocEntrySet.h +++ b/src/gdcmDocEntrySet.h @@ -3,12 +3,12 @@ Program: gdcm Module: $RCSfile: gdcmDocEntrySet.h,v $ Language: C++ - Date: $Date: 2004/09/14 16:47:08 $ - Version: $Revision: 1.17 $ + Date: $Date: 2005/01/26 11:42:02 $ + Version: $Revision: 1.45 $ 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. + 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 @@ -19,80 +19,117 @@ #ifndef GDCMDOCENTRYSET_H #define GDCMDOCENTRYSET_H -#include "gdcmException.h" -#include "gdcmDocEntry.h" - -typedef std::string gdcmBaseTagKey; -//----------------------------------------------------------------------------- +#include "gdcmBase.h" +#include -class GDCM_EXPORT gdcmDocEntrySet +namespace gdcm { -public: +class DocEntry; +class ValEntry; +class BinEntry; +class SeqEntry; +class DictEntry; - gdcmDocEntrySet(int depth = 0); - virtual ~gdcmDocEntrySet(); +typedef std::string BaseTagKey; +//----------------------------------------------------------------------------- - /// \brief adds any type of entry to the entry set (pure vitual) - virtual bool AddEntry(gdcmDocEntry *Entry) = 0; // pure virtual - - /// \brief prints any type of entry to the entry set (pure vitual) - virtual void Print (std::ostream & os = std::cout) = 0;// pure virtual +/** + * \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: + DocEntrySet() {}; + virtual ~DocEntrySet() {}; /// \brief write any type of entry to the entry set - virtual void Write (FILE *fp, FileType filetype) = 0;// pure virtual - - /// \brief Gets the depth level of a Dicom Header Entry embedded in a - /// SeQuence - int GetDepthLevel() { return SQDepthLevel; } - - /// \brief Sets the depth level of a Dicom Header Entry embedded in a - /// SeQuence - void SetDepthLevel(int depth) { SQDepthLevel = depth; } - - void SetBaseTagKey( gdcmBaseTagKey key ) { BaseTagKey = key; } - gdcmBaseTagKey GetBaseTagKey( ) { return BaseTagKey; } - - virtual gdcmDocEntry* GetDocEntryByNumber(uint16_t group, - uint16_t element) = 0; - gdcmDocEntry *GetDocEntryByName(std::string const & name); - virtual std::string GetEntryByNumber(uint16_t group,uint16_t element) = 0; - std::string GetEntryByName(TagName const & name); - gdcmDictEntry *NewVirtualDictEntry(uint16_t group, - uint16_t element, - std::string const & vr = "unkn", - std::string const & fourth = "unkn", - std::string const & name = "unkn"); - -protected: + virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0; + + /// \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; + + virtual DocEntry *GetFirstEntry()=0; + virtual DocEntry *GetNextEntry()=0; + + 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); + + /// \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); + + virtual bool IsEmpty() = 0; + virtual bool CheckIfEntryExist(uint16_t group, uint16_t elem); + + DictEntry *NewVirtualDictEntry(uint16_t group,uint16_t elem, + TagName const &vr = GDCM_UNKNOWN, + TagName const &vm = GDCM_UNKNOWN, + TagName const &name = GDCM_UNKNOWN ); // DocEntry related utilities - gdcmValEntry* NewValEntryByNumber(uint16_t group, - uint16_t element); - gdcmBinEntry* NewBinEntryByNumber(uint16_t group, - uint16_t element); - gdcmDocEntry* NewDocEntryByNumber(uint16_t group, - uint16_t element); - gdcmDocEntry* NewDocEntryByNumber(uint16_t group, - uint16_t element, - std::string const & VR); - gdcmDocEntry* NewDocEntryByName (std::string const & name); - gdcmSeqEntry* NewSeqEntryByNumber(uint16_t group, - uint16_t element); + 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); +protected: // DictEntry related utilities - gdcmDictEntry *GetDictEntryByName (std::string const & name); - gdcmDictEntry *GetDictEntryByNumber(uint16_t, uint16_t); + DictEntry *GetDictEntry(uint16_t group, uint16_t elem); + DictEntry *GetDictEntry(uint16_t group, uint16_t elem, + TagName const &vr); - /// Gives the depth level of the element set inside SeQuences - int SQDepthLevel; - - /// \brief A TagKey of a gdcmDocEntry nested in a sequence is prepended - /// with this BaseTagKey. - gdcmBaseTagKey BaseTagKey; private: }; - +} // end namespace gdcm //----------------------------------------------------------------------------- #endif