]> Creatis software - gdcm.git/blobdiff - src/gdcmSQItem.h
Fix mistypings
[gdcm.git] / src / gdcmSQItem.h
index 9aa9b71623227522e021c423d1a5dabe92a99ecc..94918015755301409555a5a2b0c709bdcd1698ab 100644 (file)
@@ -3,81 +3,99 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.h,v $
   Language:  C++
-  Date:      $Date: 2004/06/19 23:51:04 $
-  Version:   $Revision: 1.8 $
+  Date:      $Date: 2007/09/17 12:16:01 $
+  Version:   $Revision: 1.56 $
                                                                                 
   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
      PURPOSE.  See the above copyright notices for more information.
                                                                                 
 =========================================================================*/
-#ifndef GDCMSQITEM_H
-#define GDCMSQITEM_H
+#ifndef _GDCMSQITEM_H_
+#define _GDCMSQITEM_H_
 
-#include <list>
-#include "gdcmDocEntry.h"
 #include "gdcmDocEntrySet.h"
-#include "gdcmDocument.h"
+#include "gdcmElementSet.h"
+
+#include <list>
+#include <fstream>
+
+namespace GDCM_NAME_SPACE 
+{
+class DocEntry;
 
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmDocEntry *> ListDocEntry;
+typedef std::list<DocEntry *> ListDocEntry;
+
 //-----------------------------------------------------------------------------
-class GDCM_EXPORT gdcmSQItem : public gdcmDocEntrySet
+/**
+ * \brief a SeqEntry is composed by a set of SQItems.
+ *        Each SQItem is composed by a set of DocEntry
+ *        A DocEntry may be a SeqEntry
+ *        ... and so forth 
+ */ 
+class GDCM_EXPORT SQItem : public DocEntrySet 
 {
-public:
-   gdcmSQItem(int);
-   ~gdcmSQItem(void);
+   gdcmTypeMacro(SQItem);
 
-   virtual void Print(std::ostream &os = std::cout); 
+public:
+   static SQItem *New(int depthLevel) {return new SQItem(depthLevel);}
 
-   /// \brief   returns the DocEntry chained List for this SQ Item.
-   inline 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);};         
+   virtual void Print(std::ostream &os = std::cout, 
+                      std::string const &indent = "" ); 
+   void WriteContent(std::ofstream *fp, FileType filetype,
+                           bool insideMetaElements, bool insideSequence);
+   uint32_t ComputeFullLength();
 
-   virtual bool AddEntry(gdcmDocEntry *Entry); // add to the List
+   bool AddEntry(DocEntry *Entry); // add to the List
+   bool RemoveEntry(DocEntry *EntryToRemove);
+   void ClearEntry();
   
-   gdcmDocEntry *GetDocEntryByNumber(guint16 group, guint16 element);
-   gdcmDocEntry *GetDocEntryByName  (std::string Name);
-   
-   bool SetEntryByNumber(std::string val,guint16 group, guint16 element);                   
-    
-   std::string GetEntryByNumber(guint16 group, guint16 element);
-   std::string GetEntryByName(TagName name);
-       
-   inline int GetSQItemNumber() { return SQItemNumber;};
-
-   inline void SetSQItemNumber(int itemNumber) { SQItemNumber=itemNumber;};                 
-protected:
+   DocEntry *GetFirstEntry();
+   DocEntry *GetNextEntry();
 
-// DocEntry related utilities 
-         
-   virtual gdcmDocEntry *NewDocEntryByNumber(guint16 group,
-                                             guint16 element); // TODO
-   virtual gdcmDocEntry *NewDocEntryByName  (std::string Name); //TODO 
+   DocEntry *GetDocEntry(uint16_t group, uint16_t elem);
 
-// Variables
+   bool IsEmpty() { return DocEntries.empty(); }
 
-   /// \brief chained list of (Elementary) Doc Entries
-   ListDocEntry docEntries;
-  
-   /// \brief SQ Item ordinal number 
-   int SQItemNumber;
+   /// \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; }
 
-   ///\brief pointer to the HTable of the gdcmDocument,
-   ///       (because we don't know it within any gdcmObject nor any gdcmSQItem)
-   TagDocEntryHT *ptagHT;
-       
-private:
+   ///  \brief Accessor on  SQDepthLevel.
+   int GetDepthLevel() { return SQDepthLevel; }                                                                             
 
+   ///  \brief Accessor on  SQDepthLevel.
+   void SetDepthLevel(int depth) { SQDepthLevel = depth; }
 
-};
+   virtual void Copy(DocEntrySet *set);
 
+protected:
+   SQItem(int depthLevel);
+   ~SQItem();
+
+// Variables that need to be accessed in subclasses
+   /// \brief Chained list of Doc Entries
+   ListDocEntry DocEntries;
+   /// Iterator, used to visit the entries
+   ListDocEntry::iterator ItDocEntries;
+  
+private:
+   /// \brief Sequences can be nested. This  SQDepthLevel represents
+   ///        the level of the nesting of instances of this class.
+   ///         SQDepthLevel and its  SeqEntry::SQDepthLevel
+   ///        counterpart are only defined on printing purposes
+   ///        (see  Print).
+   int SQDepthLevel;
+
+   /// \brief SQ Item ordinal number 
+   int SQItemNumber;
+};
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif