ENH: Minor cleanup, mostly cosmetic

[gdcm.git] / src / gdcmSQItem.h

diff --git a/src/gdcmSQItem.h b/src/gdcmSQItem.h
index 9aa9b71623227522e021c423d1a5dabe92a99ecc..22eaedb32a1e7cda2037a576591a7bed466ac93c 100644 (file)
--- a/src/gdcmSQItem.h
+++ b/src/gdcmSQItem.h
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.h,v $
   Language:  C++
-  Date:      $Date: 2004/06/19 23:51:04 $
-  Version:   $Revision: 1.8 $
+  Date:      $Date: 2004/10/28 03:10:58 $
+  Version:   $Revision: 1.22 $
                                                                                 
   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.htm for details.
+  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
@@ -18,66 +18,92 @@
 #ifndef GDCMSQITEM_H
 #define GDCMSQITEM_H
 
-#include <list>
-#include "gdcmDocEntry.h"
 #include "gdcmDocEntrySet.h"
-#include "gdcmDocument.h"
+#include "gdcmElementSet.h"
+
+#include <list>
+
+namespace gdcm 
+{
+class DocEntry;
 
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmDocEntry *> ListDocEntry;
+typedef std::list<DocEntry *> ListDocEntry;
 //-----------------------------------------------------------------------------
-class GDCM_EXPORT gdcmSQItem : public gdcmDocEntrySet
+class GDCM_EXPORT SQItem : public DocEntrySet 
 {
 public:
-   gdcmSQItem(int);
-   ~gdcmSQItem(void);
+   SQItem(int depthLevel);
+   ~SQItem();
 
-   virtual void Print(std::ostream &os = std::cout); 
+   void Print(std::ostream &os = std::cout); 
+   void Write(std::ofstream *fp, FileType filetype);
 
    /// \brief   returns the DocEntry chained List for this SQ Item.
-   inline ListDocEntry &GetDocEntries() {return docEntries;};   
+   ListDocEntry const & GetDocEntries() const { return DocEntries; };
    
    /// \brief   adds the passed DocEntry to the DocEntry chained List for
    /// this SQ Item.      
-   inline void AddDocEntry(gdcmDocEntry *e) {docEntries.push_back(e);};         
+   void AddDocEntry(DocEntry *e) { DocEntries.push_back(e); };
 
-   virtual bool AddEntry(gdcmDocEntry *Entry); // add to the List
+   virtual bool AddEntry(DocEntry *Entry); // add to the List
   
-   gdcmDocEntry *GetDocEntryByNumber(guint16 group, guint16 element);
-   gdcmDocEntry *GetDocEntryByName  (std::string Name);
+   DocEntry *GetDocEntryByNumber(uint16_t group, uint16_t element);
+   // FIXME method to write
+   //DocEntry *GetDocEntryByName  (std::string Name);
    
-   bool SetEntryByNumber(std::string val,guint16 group, guint16 element);                   
+   bool SetEntryByNumber(std::string const & val, uint16_t group, 
+                                                  uint16_t element);
     
-   std::string GetEntryByNumber(guint16 group, guint16 element);
-   std::string GetEntryByName(TagName name);
-       
-   inline int GetSQItemNumber() { return SQItemNumber;};
+   std::string GetEntryByNumber(uint16_t group, uint16_t element);
 
-   inline void SetSQItemNumber(int itemNumber) { SQItemNumber=itemNumber;};                 
-protected:
+   /// \brief   returns the ordinal position of a given SQItem
+   int GetSQItemNumber() { return SQItemNumber; };
 
-// DocEntry related utilities 
-         
-   virtual gdcmDocEntry *NewDocEntryByNumber(guint16 group,
-                                             guint16 element); // TODO
-   virtual gdcmDocEntry *NewDocEntryByName  (std::string Name); //TODO 
+   /// \brief   Sets the ordinal position of a given SQItem
+   void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
 
-// Variables
+   /// Accessor on \ref SQDepthLevel.
+   int GetDepthLevel() { return SQDepthLevel; }
+                                                                                
+   /// Accessor on \ref SQDepthLevel.
+   void SetDepthLevel(int depth) { SQDepthLevel = depth; }
+
+   /// Accessor on \ref BaseTagKey.
+   void SetBaseTagKey( BaseTagKey const & key ) { BaseTagKeyNested = key; }
+
+   /// Accessor on \ref BaseTagKey.
+   BaseTagKey const & GetBaseTagKey() const { return BaseTagKeyNested; }
+
+
+protected:
+// Variables that need to be access in subclasses
 
    /// \brief chained list of (Elementary) Doc Entries
-   ListDocEntry docEntries;
-  
-   /// \brief SQ Item ordinal number 
-   int SQItemNumber;
+   ListDocEntry DocEntries;
+   
+   ///\brief pointer to the HTable of the Document,
+   ///       (because we don't know it within any DicomDirObject nor any SQItem)
+   TagDocEntryHT *PtagHT;
 
-   ///\brief pointer to the HTable of the gdcmDocument,
-   ///       (because we don't know it within any gdcmObject nor any gdcmSQItem)
-   TagDocEntryHT *ptagHT;
-       
 private:
 
+   /// \brief Sequences can be nested. This \ref SQDepthLevel represents
+   ///        the level of the nesting of instances of this class.
+   ///        \ref SQDepthLevel and its \ref SeqEntry::SQDepthLevel
+   ///        counterpart are only defined on printing purposes
+   ///        (see \ref Print).
+   int SQDepthLevel;
 
-};
+   /// \brief A TagKey of a DocEntry nested in a sequence is prepended
+   ///        with this BaseTagKey.
+   BaseTagKey BaseTagKeyNested;
 
+ 
+   /// \brief SQ Item ordinal number 
+   int SQItemNumber;
+
+};
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif