ENH: Move the old setup.py to its new home

[gdcm.git] / src / gdcmSQItem.h

diff --git a/src/gdcmSQItem.h b/src/gdcmSQItem.h
index a2eefbf3a1e87bf44aa27fd8de7af163b5c5ea85..ecfffb684ba3ffb74cf8cdf27247e79b5c2c5a86 100644 (file)
--- a/src/gdcmSQItem.h
+++ b/src/gdcmSQItem.h
@@ -1,13 +1,30 @@
-// gdcmSQItem.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmSQItem.h,v $
+  Language:  C++
+  Date:      $Date: 2004/10/07 21:01:10 $
+  Version:   $Revision: 1.18 $
+                                                                                
+  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.html for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
 #ifndef GDCMSQITEM_H
 #define GDCMSQITEM_H
 
-#include <list>
-
 #include "gdcmDocEntry.h"
 #include "gdcmDocEntrySet.h"
 #include "gdcmDocument.h"
+#include <list>
+
+class gdcmBinEntry;
+
 //-----------------------------------------------------------------------------
 typedef std::list<gdcmDocEntry *> ListDocEntry;
 //-----------------------------------------------------------------------------
@@ -15,57 +32,76 @@ class GDCM_EXPORT gdcmSQItem : public gdcmDocEntrySet
 {
 public:
    gdcmSQItem(int);
-   ~gdcmSQItem(void);
+   ~gdcmSQItem();
 
    virtual void Print(std::ostream &os = std::cout); 
+   virtual void Write(FILE *fp, FileType filetype);
 
- /// \brief   returns the DocEntry chained List for this SQ Item.
-   inline ListDocEntry &GetDocEntries() 
-      {return docEntries;};   
+   /// \brief   returns the DocEntry chained List for this SQ Item.
+   ListDocEntry &GetDocEntries() { 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);};         
+   /// \brief   adds the passed DocEntry to the DocEntry chained List for
+   /// this SQ Item.      
+   void AddDocEntry(gdcmDocEntry *e) { docEntries.push_back(e); };
 
    virtual bool AddEntry(gdcmDocEntry *Entry); // add to the List
   
-   gdcmDocEntry *GetDocEntryByNumber(guint16 group, 
-                                     guint16 element);
-   gdcmDocEntry *GetDocEntryByName  (std::string Name);
+   gdcmDocEntry *GetDocEntryByNumber(uint16_t group, uint16_t element);
+   // FIXME method to write
+   //gdcmDocEntry *GetDocEntryByName  (std::string Name);
    
-   bool SetEntryByNumber(std::string val,guint16 group,
-                                         guint16 element);                   
+   bool SetEntryByNumber(std::string val, uint16_t group, uint16_t element);                   
     
-   std::string GetEntryByNumber(guint16 group, guint16 element);
-   std::string GetEntryByName(TagName name);
-      
-protected:
+   virtual std::string GetEntryByNumber(uint16_t group, uint16_t element);
+
+   /// \brief   returns the ordinal position of a given SQItem
+   int GetSQItemNumber() { return SQItemNumber; };
+
+   /// \brief   Sets the ordinal position of a given SQItem
+   void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
 
-   // DocEntry related utilities 
-         
-   virtual gdcmDocEntry *NewDocEntryByNumber(guint16 group,
-                                             guint16 element); // TODO
-   virtual gdcmDocEntry *NewDocEntryByName  (std::string Name); //TODO 
+   /// Accessor on \ref SQDepthLevel.
+   int GetDepthLevel() { return SQDepthLevel; }
+                                                                                
+   /// Accessor on \ref SQDepthLevel.
+   void SetDepthLevel(int depth) { SQDepthLevel = depth; }
+
+   /// Accessor on \ref BaseTagKey.
+   void           SetBaseTagKey( gdcmBaseTagKey key ) { BaseTagKey = key; }
+
+   /// Accessor on \ref BaseTagKey.
+   gdcmBaseTagKey GetBaseTagKey( ) { return BaseTagKey; }
+
+
+protected:
 
 // Variables
 
-/// \brief chained list of (Elementary) Doc Entries
-  ListDocEntry docEntries;
+   /// \brief chained list of (Elementary) Doc Entries
+   ListDocEntry docEntries;
   
-/// \brief SQ Item ordinal number 
-  int SQItemNumber;
+   /// \brief SQ Item ordinal number 
+   int SQItemNumber;
 
+   ///\brief pointer to the HTable of the gdcmDocument,
+   ///       (because we don't know it within any gdcmDicomDirObject nor any gdcmSQItem)
+   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 gdcmSeqEntry::SQDepthLevel
+   ///        counterpart are only defined on printing purposes
+   ///        (see \ref Print).
+   int SQDepthLevel;
 
-};
+   /// \brief A TagKey of a gdcmDocEntry nested in a sequence is prepended
+   ///        with this BaseTagKey.
+   gdcmBaseTagKey BaseTagKey;
 
+};
 
 //-----------------------------------------------------------------------------
 #endif
-