GetDocEntry,GetValEntry,GetBinEntry,GetSeqEntry are now 'pure virtual' methods

[gdcm.git] / src / gdcmDocEntrySet.h

diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h
index 0cf434ff677ff61ec6d974da1c662266c34091b8..055548d1e8ac35c5b7ffb8cca48a70092fd03747 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/05 15:38:28 $
-  Version:   $Revision: 1.30 $
+  Date:      $Date: 2005/01/19 10:30:51 $
+  Version:   $Revision: 1.38 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -35,6 +35,7 @@ typedef std::string 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
@@ -62,43 +63,59 @@ public:
    DocEntrySet() {};
    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
+   // ------- '... =0;' stands for 'Pure Virtual'
+
+   /// \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;
 
    /// \brief write any type of entry to the entry set
-   virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0;// pure virtual
-
-   virtual DocEntry* GetDocEntryByNumber(uint16_t group,
-                                         uint16_t element) = 0;
-   DocEntry* GetDocEntryByName(TagName 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,
-                                   TagName const & vr     = GDCM_UNKNOWN,
-                                   TagName const & fourth = GDCM_UNKNOWN,
-                                   TagName const & name   = GDCM_UNKNOWN );
+   virtual void WriteContent (std::ofstream *fp, 
+                              FileType filetype) = 0;
+
+   /// \brief Gets any type of DocEntry, identified by its (group,element)
+   virtual DocEntry *GetDocEntry(uint16_t group,
+                                 uint16_t elem) = 0;
+
+   /// \brief Gets a ValEntry, identified by its (group,element)
+   virtual ValEntry *GetValEntry(uint16_t group,
+                                 uint16_t elem) = 0;
+   /// \brief Gets a BinEntry, identified by its (group,element)
+   virtual BinEntry *GetBinEntry(uint16_t group,
+                                 uint16_t elem) = 0;
+
+   /// \brief Gets a SeqEntry, identified by its (group,element)
+   virtual SeqEntry *GetSeqEntry(uint16_t group,
+                                 uint16_t elem) = 0;
+
+   /// \brief Gets the 'string value' of a ValEntry
+   ///        identified by its (group,element) - Sorry for the name !...-
+   virtual std::string GetEntry(uint16_t group, uint16_t elem) = 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 
-   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,
-                                 TagName const & vr); 
-   DocEntry* NewDocEntryByName  (TagName const & name);
-   SeqEntry* NewSeqEntryByNumber(uint16_t group, 
-                                 uint16_t element);
+
+   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 *GetDictEntryByName  (TagName const & name);
-   DictEntry *GetDictEntryByNumber(uint16_t, uint16_t);
+   DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
+   DictEntry *GetDictEntry(uint16_t group, uint16_t elem,
+                           TagName const &vr);
 };
 
 } // end namespace gdcm