-// gdcmDocEntrySet.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmDocEntrySet.h,v $
+ Language: C++
+ Date: $Date: 2004/10/12 04:35:45 $
+ Version: $Revision: 1.20 $
+
+ 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"
-
-//-----------------------------------------------------------------------------
-class GDCM_EXPORT gdcmDocEntrySet
+namespace gdcm
{
+class DocEntry;
+class ValEntry;
+class BinEntry;
+class SeqEntry;
+class DictEntry;
-public:
+typedef std::string BaseTagKey;
+//-----------------------------------------------------------------------------
- gdcmDocEntrySet(int depth = 0);
- ~gdcmDocEntrySet(void);
+/**
+ * \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 SQItem::docEntries).
+ * 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:
+ DocEntrySet() {};
+ virtual ~DocEntrySet() {};
/// \brief adds any type of entry to the entry set (pure vitual)
- virtual bool AddEntry(gdcmDocEntry *Entry) = 0; // pure virtual
- //FIXME bool CheckEntryVR(gdcmDocEntry *Entry, std::string vr);
-
+ virtual bool AddEntry(DocEntry *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 Gets the depth level of a Dicom Header Entry embedded in a SeQuence
- inline int GetDepthLevel(void)
- {return(SQDepthLevel);}
+ /// \brief write any type of entry to the entry set
+ virtual void Write (FILE *fp, FileType filetype) = 0;// pure virtual
- /// \brief Sets the depth level of a Dicom Header Entry embedded in a SeQuence
- inline void SetDepthLevel(int depth)
- {SQDepthLevel = depth;}
-
+ virtual DocEntry* GetDocEntryByNumber(uint16_t group,
+ uint16_t element) = 0;
+ DocEntry *GetDocEntryByName(std::string const & name);
+ virtual std::string GetEntryByNumber(uint16_t group,uint16_t element) = 0;
+ std::string GetEntryByName(TagName const & name);
+ DictEntry *NewVirtualDictEntry(uint16_t group,
+ uint16_t element,
+ std::string const & vr = "unkn",
+ std::string const & fourth = "unkn",
+ std::string const & name = "unkn");
+
protected:
-// 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:
-
-};
+// DocEntry related utilities
+ ValEntry* NewValEntryByNumber(uint16_t group,
+ uint16_t element);
+ BinEntry* NewBinEntryByNumber(uint16_t group,
+ uint16_t element);
+ DocEntry* NewDocEntryByNumber(uint16_t group,
+ uint16_t element);
+ DocEntry* NewDocEntryByNumber(uint16_t group,
+ uint16_t element,
+ std::string const & VR);
+ DocEntry* NewDocEntryByName (std::string const & name);
+ SeqEntry* NewSeqEntryByNumber(uint16_t group,
+ uint16_t element);
+
+// DictEntry related utilities
+ DictEntry *GetDictEntryByName (std::string const & name);
+ DictEntry *GetDictEntryByNumber(uint16_t, uint16_t);
+};
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff