X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.h;h=0173958a015a6c936bbd18374775808ace0e646d;hb=928d3c30e40ab7f3d12bfd038ce8a48befcddce8;hp=9a2164776c2948a31a9994d11961a46875040bd9;hpb=5c198a737e21a72460f81e81a1b9405b5a591b60;p=gdcm.git diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h index 9a216477..0173958a 100644 --- a/src/gdcmDocEntrySet.h +++ b/src/gdcmDocEntrySet.h @@ -1,62 +1,132 @@ -// gdcmDocEntrySet.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDocEntrySet.h,v $ + Language: C++ + Date: $Date: 2005/10/20 15:24:09 $ + Version: $Revision: 1.60 $ + + 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 "gdcmVRKey.h" +#include "gdcmTagKey.h" + +#include -class GDCM_EXPORT gdcmDocEntrySet +namespace gdcm { +//----------------------------------------------------------------------------- +class DocEntry; +class DataEntry; +class SeqEntry; +class DictEntry; +//----------------------------------------------------------------------------- +/** + * \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 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() {} + + /// \brief write any type of entry to the entry set + 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; + /// 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; + + 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); + virtual std::string GetEntryForcedAsciiValue(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); + /// tells us if the set contains no entry + virtual bool IsEmpty() = 0; + virtual bool CheckIfEntryExist(uint16_t group, uint16_t elem); + +// DocEntry related utilities + DataEntry *NewDataEntry(uint16_t group,uint16_t elem, + VRKey const &vr = GDCM_VRUNKNOWN); + SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem); - gdcmDocEntrySet(int depth = 0); - ~gdcmDocEntrySet(void); - -/// \brief adds any type of entry to the entry set (pure vitual) - virtual bool AddEntry(gdcmDocEntry *Entry) = 0; // pure virtual - -// bool CheckEntryVR(gdcmDocEntry *Entry, std::string vr); - -/// \brief prints any type of entry to the entry set (pure vitual) - virtual void Print (std::ostream & os = std::cout) = 0;// pure virtual - - /// \brief Gets the depth level of a Dicom Header Entry embedded in a SeQuence - inline int GetDepthLevel(void) - {return(SQDepthLevel);} - - /// \brief Sets the depth level of a Dicom Header Entry embedded in a SeQuence - inline void SetDepthLevel(int depth) - {SQDepthLevel = depth;} - protected: +// 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; -// void gdcmDocEntrySet::FindDocEntryLength (gdcmDocEntry *Entry); - - // DocEntry related utilities - - /// \brief Build a new Element Value from all the low level arguments. - /// Check for existence of dictionary entry, and build - /// a default one when absent (pure virtual) - virtual gdcmDocEntry *NewDocEntryByNumber(guint16 group, - guint16 element)=0; // pure virtual - - /// \brief Build a new Element Value from all the low level arguments. - /// Check for existence of dictionary entry, and build - /// a default one when absent (pure virtual) - virtual gdcmDocEntry *NewDocEntryByName (std::string Name)=0;// pure virtual - - /// Gives the depth level of the element set inside SeQuences - int SQDepthLevel; - private: - }; - +} // end namespace gdcm //----------------------------------------------------------------------------- #endif