X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.h;h=9eaa474bda5e79849999835f733ce3ceccf70cc3;hb=02163588f1fa2bb0af4b45455b6f9d08ec64f7b3;hp=21eadf8b93e9b40dc6995d16f33b58aafbabb72a;hpb=fd37aa842b5d31ca266b6bda8a77f3201d02338d;p=gdcm.git diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h index 21eadf8b..9eaa474b 100644 --- a/src/gdcmDocEntrySet.h +++ b/src/gdcmDocEntrySet.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocEntrySet.h,v $ Language: C++ - Date: $Date: 2004/09/27 08:39:06 $ - Version: $Revision: 1.19 $ + 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 @@ -19,83 +19,117 @@ #ifndef GDCMDOCENTRYSET_H #define GDCMDOCENTRYSET_H -#include "gdcmException.h" -#include "gdcmDocEntry.h" - -typedef std::string gdcmBaseTagKey; +#include "gdcmBase.h" +#include + +namespace gdcm +{ +class DocEntry; +class ValEntry; +class BinEntry; +class SeqEntry; +class DictEntry; + +typedef std::string BaseTagKey; //----------------------------------------------------------------------------- /** - * \ref gdcmDocEntrySet is an abstract base class for \ref gdcmElementSet - * and \ref gdcmSQItem which are both containers for gdcmDocEntries. - * \ref gdcmElementSet is based on the STL map<> container - * (see \ref gdcmElementSet::TagHT), as opposed to \ref gdcmSQItem - * which is based on an STL list container (see \ref gdcmSQItem::docEntries). + * \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 gdcmDocEntrySet is designed as an adapter to unify the - * interfaces of \ref gdcmDocEntrySet and \ref gdcmElementSet. + * 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 gdcmDocument::ParseDES - * which calls \ref gdcmDocument::ParseSQ, which in turns calls - * \ref gdcmDocument::ParseDES ]. + * 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 gdcmDocEntrySet +class GDCM_EXPORT DocEntrySet : public Base { public: + DocEntrySet() {}; + virtual ~DocEntrySet() {}; - gdcmDocEntrySet() {} - virtual ~gdcmDocEntrySet() {} + /// \brief write any type of entry to the entry set + virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0; - /// \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 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; - /// \brief write any type of entry to the entry set - virtual void Write (FILE *fp, FileType filetype) = 0;// pure virtual - - 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 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); +private: }; - +} // end namespace gdcm //----------------------------------------------------------------------------- #endif