Program: gdcm
Module: $RCSfile: gdcmDocEntrySet.h,v $
Language: C++
- Date: $Date: 2005/01/08 15:03:59 $
- Version: $Revision: 1.36 $
+ Date: $Date: 2005/08/24 12:09:13 $
+ Version: $Revision: 1.54 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#define GDCMDOCENTRYSET_H
#include "gdcmBase.h"
-#include "gdcmException.h"
#include <fstream>
namespace gdcm
{
+//-----------------------------------------------------------------------------
class DocEntry;
class ValEntry;
class BinEntry;
class SeqEntry;
class DictEntry;
-typedef std::string BaseTagKey;
-//-----------------------------------------------------------------------------
+typedef TagKey BaseTagKey;
+//-----------------------------------------------------------------------------
/**
+ * \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).
+ * - \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.
*/
class GDCM_EXPORT DocEntrySet : public Base
{
-friend class File;
public:
- DocEntrySet() {};
+ /// Canonical Constructor
+ DocEntrySet();
+ /// Canonical Destructor
virtual ~DocEntrySet() {};
- /// \brief adds any type of entry to the entry set (pure vitual)
- virtual bool AddEntry(DocEntry *Entry) = 0; // pure virtual
- virtual bool RemoveEntry(DocEntry *EntryToRemove)=0; // pure virtual
- virtual bool RemoveEntryNoDestroy(DocEntry *EntryToRemove)=0; // pure virtual
-
/// \brief write any type of entry to the entry set
- virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0;// pure virtual
+ virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0;
- virtual DocEntry *GetDocEntry(uint16_t group,
- uint16_t elem) = 0;
- virtual std::string GetEntry(uint16_t group, uint16_t elem) = 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;
- DictEntry *NewVirtualDictEntry(uint16_t group,
- uint16_t element,
- TagName const &vr = GDCM_UNKNOWN,
- TagName const &vm = GDCM_UNKNOWN,
- TagName const &name = GDCM_UNKNOWN );
-
-protected:
-// DocEntry related utilities
+ 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)
+ ValEntry *GetValEntry(uint16_t group, uint16_t elem);
+ /// \brief Gets a BinEntry, identified by its (group,elem)
+ BinEntry *GetBinEntry(uint16_t group, uint16_t elem);
+ /// \brief Gets a SeqEntry, identified by its (group,elem)
+ SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem);
+ bool SetValEntry(std::string const &content,
+ uint16_t group, uint16_t elem);
+ bool SetBinEntry(uint8_t *content, int lgth,
+ uint16_t group, uint16_t elem);
+ bool SetValEntry(std::string const &content, ValEntry *entry);
+ bool SetBinEntry(uint8_t *content, int lgth, BinEntry *entry);
+
+ ValEntry *InsertValEntry(std::string const &value,
+ uint16_t group, uint16_t elem,
+ TagName const &vr = GDCM_UNKNOWN);
+ BinEntry *InsertBinEntry(uint8_t *binArea, int lgth,
+ uint16_t group, uint16_t elem,
+ TagName const &vr = GDCM_UNKNOWN);
+ 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
ValEntry *NewValEntry(uint16_t group,uint16_t elem,
TagName const &vr = GDCM_UNKNOWN);
- BinEntry *NewBinEntry(uint16_t group,uint16_t elem,
+ BinEntry *NewBinEntry(uint16_t group, uint16_t elem,
TagName const &vr = GDCM_UNKNOWN);
- SeqEntry *NewSeqEntry(uint16_t group,uint16_t elem);
+ SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem);
+// DictEntry related utilities
+ DictEntry *NewVirtualDictEntry(uint16_t group,uint16_t elem,
+ TagName const &vr = GDCM_UNKNOWN,
+ TagName const &vm = GDCM_UNKNOWN,
+ TagName const &name = GDCM_UNKNOWN );
+
+protected:
// DictEntry related utilities
DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
DictEntry *GetDictEntry(uint16_t group, uint16_t elem,
TagName const &vr);
+ /// To be able to backtrack (Private Sequence, Implicit VR related pb)
+ DocEntry *PreviousDocEntry;
+
+private:
};
} // end namespace gdcm