X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.h;h=98d95b533ff48ee270a7b153d177d7cdc92fea9b;hb=a585fafed1e72e092c6a1942c8692991c1688e7f;hp=4ed6d4a0e0f8bedac3f0e630297c4e1b305ef193;hpb=e40fc77cef3155aab87305ce2f8f14d1acbf158f;p=gdcm.git diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h index 4ed6d4a0..98d95b53 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/07/02 13:55:27 $ - Version: $Revision: 1.13 $ + Date: $Date: 2005/11/21 09:46:26 $ + Version: $Revision: 1.63 $ 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,69 +19,115 @@ #ifndef GDCMDOCENTRYSET_H #define GDCMDOCENTRYSET_H -#include "gdcmException.h" -#include "gdcmDocEntry.h" - -//----------------------------------------------------------------------------- +#include "gdcmRefCounter.h" +#include "gdcmVRKey.h" +#include "gdcmTagKey.h" -class GDCM_EXPORT gdcmDocEntrySet -{ -public: +#include - gdcmDocEntrySet(int depth = 0); - virtual ~gdcmDocEntrySet(); +namespace gdcm +{ +//----------------------------------------------------------------------------- +class DocEntry; +class DataEntry; +class SeqEntry; +class DictEntry; - /// \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) + * - \ref SQItem 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 turn 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 RefCounter +{ + gdcmTypeMacro(DocEntrySet); +public: /// \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(void) { return SQDepthLevel; } - - /// \brief Sets the depth level of a Dicom Header Entry embedded in a - /// SeQuence - void SetDepthLevel(int depth) { SQDepthLevel = depth; } - - virtual gdcmDocEntry* GetDocEntryByNumber(uint16_t group, - uint16_t element) = 0; - gdcmDocEntry *GetDocEntryByName(std::string name); - virtual std::string GetEntryByNumber(uint16_t group,uint16_t element) = 0; - std::string GetEntryByName(TagName name); - gdcmDictEntry *NewVirtualDictEntry(uint16_t group, - uint16_t element, - std::string vr = "unkn", - std::string fourth = "unkn", - std::string name = "unkn"); - -protected: + virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0; + + /// \brief Remove all Entry of the current set + virtual void ClearEntry() = 0; + /// \brief adds any type of entry to the current 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 Gets the first entry (of any type) of the current set + virtual DocEntry *GetFirstEntry()=0; + /// \brief Gets the next entry (of any type) of the current set + virtual DocEntry *GetNextEntry()=0; + + virtual std::string GetEntryString(uint16_t group, uint16_t elem); + virtual void *GetEntryBinArea(uint16_t group, uint16_t elem); + virtual int GetEntryLength(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 DataEntry, identified by its (group, elem) + DataEntry *GetDataEntry(uint16_t group, uint16_t elem); + /// \brief Gets a SeqEntry, identified by its (group,elem) + SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem); + + bool SetEntryString(std::string const &content, + uint16_t group, uint16_t elem); + bool SetEntryBinArea(uint8_t *content, int lgth, + uint16_t group, uint16_t elem); + bool SetEntryString(std::string const &content, DataEntry *entry); + bool SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry); + + DataEntry *InsertEntryString(std::string const &value, + uint16_t group, uint16_t elem, + VRKey const &vr = GDCM_VRUNKNOWN); + DataEntry *InsertEntryBinArea(uint8_t *binArea, int lgth, + uint16_t group, uint16_t elem, + VRKey const &vr = GDCM_VRUNKNOWN); + SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem); + /// \brief Tells us if the set contains no entry + virtual bool IsEmpty() = 0; + virtual bool CheckIfEntryExist(uint16_t group, uint16_t elem); // 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* NewDocEntryByName (std::string Name); + DataEntry *NewDataEntry(uint16_t group,uint16_t elem, + VRKey const &vr = GDCM_VRUNKNOWN); + SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem); -// DictEntry related utilities - gdcmDictEntry *GetDictEntryByName (std::string Name); - gdcmDictEntry *GetDictEntryByNumber(uint16_t, uint16_t); +protected: + /// Canonical Constructor + DocEntrySet(); + /// Canonical Destructor + virtual ~DocEntrySet() {} - /// Gives the depth level of the element set inside SeQuences - int SQDepthLevel; +// DictEntry related utilities + DictEntry *GetDictEntry(uint16_t group, uint16_t elem); + DictEntry *GetDictEntry(uint16_t group, uint16_t elem, + VRKey const &vr); + /// To be able to backtrack (Private Sequence, Implicit VR related pb) + DocEntry *PreviousDocEntry; private: - }; - +} // end namespace gdcm //----------------------------------------------------------------------------- #endif