Program: gdcm
Module: $RCSfile: gdcmDocEntrySet.h,v $
Language: C++
- Date: $Date: 2004/10/12 04:35:45 $
- Version: $Revision: 1.20 $
+ Date: $Date: 2007/08/22 16:14:04 $
+ Version: $Revision: 1.71 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
=========================================================================*/
-#ifndef GDCMDOCENTRYSET_H
-#define GDCMDOCENTRYSET_H
+#ifndef _GDCMDOCENTRYSET_H_
+#define _GDCMDOCENTRYSET_H_
-#include "gdcmException.h"
+#include "gdcmRefCounter.h"
+#include "gdcmVRKey.h"
+#include "gdcmTagKey.h"
-namespace gdcm
+#include <fstream>
+
+namespace GDCM_NAME_SPACE
{
+//-----------------------------------------------------------------------------
class DocEntry;
-class ValEntry;
-class BinEntry;
+class DataEntry;
class SeqEntry;
class DictEntry;
-typedef std::string BaseTagKey;
//-----------------------------------------------------------------------------
-
/**
- * \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).
+ * \brief
+ * \ref DocEntrySet is an abstract base class for \ref ElementSet, \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
+ * 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
+class GDCM_EXPORT DocEntrySet : public RefCounter
{
+ gdcmTypeMacro(DocEntrySet);
+
public:
- DocEntrySet() {};
- virtual ~DocEntrySet() {};
+ /// \brief write any type of entry to the entry set
+ virtual void WriteContent (std::ofstream *fp, FileType filetype,
+ bool insideMetaElements) = 0;
- /// \brief adds any type of entry to the entry set (pure vitual)
- 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 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;
- /// \brief write any type of entry to the entry set
- virtual void Write (FILE *fp, FileType filetype) = 0;// pure virtual
-
- 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:
+ 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
- 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);
+ DataEntry *NewDataEntry(uint16_t group,uint16_t elem,
+ VRKey const &vr = GDCM_VRUNKNOWN);
+ SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem);
+
+ virtual void Copy(DocEntrySet *) {};
+
+protected:
+ /// Canonical Constructor
+ DocEntrySet();
+ /// Canonical Destructor
+ virtual ~DocEntrySet() {}
// DictEntry related utilities
- DictEntry *GetDictEntryByName (std::string const & name);
- DictEntry *GetDictEntryByNumber(uint16_t, uint16_t);
+ 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