]> Creatis software - gdcm.git/blobdiff - src/gdcmSQItem.h
ENH: Move the old setup.py to its new home
[gdcm.git] / src / gdcmSQItem.h
index 675492d56ac3f338d1eb11882c4f19fa604d018d..ecfffb684ba3ffb74cf8cdf27247e79b5c2c5a86 100644 (file)
@@ -1,12 +1,29 @@
-// 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;
@@ -14,31 +31,77 @@ typedef std::list<gdcmDocEntry *> ListDocEntry;
 class GDCM_EXPORT gdcmSQItem : public gdcmDocEntrySet
 {
 public:
-   gdcmSQItem(void);
-   ~gdcmSQItem(void);
+   gdcmSQItem(int);
+   ~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(uint16_t group, uint16_t element);
+   // FIXME method to write
+   //gdcmDocEntry *GetDocEntryByName  (std::string Name);
+   
+   bool SetEntryByNumber(std::string val, uint16_t group, uint16_t element);                   
+    
+   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; };
+
+   /// 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 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;
+
+       
 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;
 
-// Variables
+   /// \brief A TagKey of a gdcmDocEntry nested in a sequence is prepended
+   ///        with this BaseTagKey.
+   gdcmBaseTagKey BaseTagKey;
 
-/// \brief chained list of (Elementary) Doc Entries
-  ListDocEntry docEntries;
 };
 
-
 //-----------------------------------------------------------------------------
 #endif
-