* Remove useless methods added by JPR for Python users. All was already

[gdcm.git] / src / gdcmDocEntrySet.h

diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h
index 4c5fd14aa56d3315a8da41892e0e4c434707b2dd..ec56a65b3907ec95ef0bae4267a602983e6e8ff2 100644 (file)
--- a/src/gdcmDocEntrySet.h
+++ b/src/gdcmDocEntrySet.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/20 11:39:49 $
-  Version:   $Revision: 1.39 $
+  Date:      $Date: 2005/02/07 08:48:18 $
+  Version:   $Revision: 1.49 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -20,11 +20,11 @@
 #define GDCMDOCENTRYSET_H
 
 #include "gdcmBase.h"
-#include "gdcmException.h"
 #include <fstream>
 
 namespace gdcm 
 {
+//-----------------------------------------------------------------------------
 class DocEntry;
 class ValEntry;
 class BinEntry;
@@ -32,8 +32,8 @@ class SeqEntry;
 class DictEntry;
 
 typedef std::string BaseTagKey;
-//-----------------------------------------------------------------------------
 
+//-----------------------------------------------------------------------------
 /**
  * \brief
  * \ref DocEntrySet is an abstract base class for \ref ElementSet
@@ -58,64 +58,80 @@ typedef std::string BaseTagKey;
  */
 class GDCM_EXPORT DocEntrySet : public Base
 {
-friend class File;
 public:
+   /// Canonical Constructor
    DocEntrySet() {};
+   /// Canonical Destructor
    virtual ~DocEntrySet() {};
 
-   // ------- '... =0;' stands for 'Pure Virtual'
+   /// \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;
-
+   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;
+   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;
 
-   /// \brief write any type of entry to the entry set
-   virtual void WriteContent (std::ofstream *fp, 
-                              FileType filetype) = 0;
+   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)
-   virtual ValEntry *GetValEntry(uint16_t group,
-                                 uint16_t elem) = 0;
+   virtual DocEntry *GetDocEntry(uint16_t group, uint16_t elem) = 0;
+   /// \brief Gets a ValEntry, identified by its (group, elem)
+   virtual ValEntry *GetValEntry(uint16_t group, uint16_t elem);
    /// \brief Gets a BinEntry, identified by its (group,elem)
-   virtual BinEntry *GetBinEntry(uint16_t group,
-                                 uint16_t elem) = 0;
-
+   virtual BinEntry *GetBinEntry(uint16_t group, uint16_t elem);
    /// \brief Gets a SeqEntry, identified by its (group,elem)
-   virtual SeqEntry *GetSeqEntry(uint16_t group,
-                                 uint16_t elem) = 0;
+   virtual SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem);
+
+   virtual bool SetValEntry(std::string const &content,
+                            uint16_t group, uint16_t elem);
+   virtual bool SetBinEntry(uint8_t *content, int lgth,
+                            uint16_t group, uint16_t elem);
+   virtual bool SetValEntry(std::string const &content, ValEntry *entry);
+   virtual bool SetBinEntry(uint8_t *content, int lgth, BinEntry *entry);
+
+   virtual ValEntry *InsertValEntry(std::string const &value,
+                                    uint16_t group, uint16_t elem,
+                                    TagName const &vr = GDCM_UNKNOWN);
+   virtual BinEntry *InsertBinEntry(uint8_t *binArea, int lgth,
+                                    uint16_t group, uint16_t elem,
+                                    TagName const &vr = GDCM_UNKNOWN);
+   virtual 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);
 
-   /// \brief Gets the 'string value' of a ValEntry
-   ///        identified by its (group,elem) - Sorry for the name !...-
-   virtual std::string GetEntry(uint16_t group, uint16_t elem) = 0;
+// DocEntry  related utilities 
+   ValEntry *NewValEntry(uint16_t group,uint16_t elem,
+                         TagName const &vr = GDCM_UNKNOWN);
+   BinEntry *NewBinEntry(uint16_t group, uint16_t elem,
+                         TagName const &vr = GDCM_UNKNOWN);
+   SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem);
 
-   DictEntry *NewVirtualDictEntry(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:
-// DocEntry  related utilities 
-
-   ValEntry *NewValEntry(uint16_t group,uint16_t elem,
-                         TagName const &vr = GDCM_UNKNOWN);
-   BinEntry *NewBinEntry(uint16_t group,uint16_t elem,
-                         TagName const &vr = GDCM_UNKNOWN);
-   SeqEntry *NewSeqEntry(uint16_t group,uint16_t elem);
-
 // DictEntry  related utilities
    DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
    DictEntry *GetDictEntry(uint16_t group, uint16_t elem,
                            TagName const &vr);
+
+private:
 };
 
 } // end namespace gdcm