Fix mistypings

[gdcm.git] / src / gdcmSeqEntry.h

diff --git a/src/gdcmSeqEntry.h b/src/gdcmSeqEntry.h
index 29381b401d1f033a60bba83867e55338b3b0f4f2..5869387e7e94332b270bb03f46d0086b2ff08d35 100644 (file)
--- a/src/gdcmSeqEntry.h
+++ b/src/gdcmSeqEntry.h
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSeqEntry.h,v $
   Language:  C++
-  Date:      $Date: 2004/09/16 19:21:57 $
-  Version:   $Revision: 1.17 $
+  Date:      $Date: 2007/09/17 12:16:01 $
+  Version:   $Revision: 1.47 $
                                                                                 
   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
@@ -16,66 +16,94 @@
                                                                                 
 =========================================================================*/
 
-#ifndef GDCMSQDOCENTRY_H
-#define GDCMSQDOCENTRY_H
+#ifndef _GDCMSQDOCENTRY_H_
+#define _GDCMSQDOCENTRY_H_
 
-#include <list>
-
-#include "gdcmSQItem.h"
 #include "gdcmDocEntry.h"
 
+#include <list>
+
+namespace GDCM_NAME_SPACE 
+{
+class SQItem;
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmSQItem *> ListSQItem;
-//-----------------------------------------------------------------------------
+typedef std::list<SQItem *> ListSQItem;
 
-class GDCM_EXPORT gdcmSeqEntry : public gdcmDocEntry 
+//-----------------------------------------------------------------------------
+/**
+ * \brief a SeqEntry (as opposed to a DataEntry) is a non elementary DocEntry.
+ *        It 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 SeqEntry : public DocEntry 
 {
+   gdcmTypeMacro(SeqEntry);
+
 public:
-   gdcmSeqEntry( gdcmDictEntry* );
-   gdcmSeqEntry(gdcmDocEntry* d,  int depth);
-   virtual ~gdcmSeqEntry();
+/// \brief Contructs a SeqEntry with a RefCounter from DictEntry
+   //static SeqEntry *New(DictEntry *e) {return new SeqEntry(e);}
+/// \brief Contructs a SeqEntry with a RefCounter from DocEntry
+   static SeqEntry *New(DocEntry *d, int depth) {return new SeqEntry(d,depth);}
+/// \brief Constructs a SeqEntry with a RefCounter from elementary values
+   static SeqEntry *New(uint16_t group,uint16_t elem/*, VRKey const &vr = GDCM_VRUNKNOWN*/) 
+                           {return new SeqEntry(group,elem);}
    
-   virtual void Print(std::ostream &os = std::cout); 
-   virtual void Write(FILE *fp, FileType);
+   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();
 
-   /// returns the SQITEM chained List for this SeQuence.
-   ListSQItem &GetSQItems() { return items; }
+   void AddSQItem(SQItem *it, int itemNumber);
+   void ClearSQItem();
+   SQItem *GetFirstSQItem();
+   SQItem *GetNextSQItem();
+   SQItem *GetSQItem(int itemNumber);
+   unsigned int GetNumberOfSQItems();
       
    /// Sets the delimitor mode
-   void SetDelimitorMode(bool dm) { delimitor_mode = dm;}
-
+   void SetDelimitorMode(bool dm) { DelimitorMode = dm; }
    /// Sets the Sequence Delimitation Item
-   void SetSequenceDelimitationItem(gdcmDocEntry * e) { seq_term = e;}
+   void SetDelimitationItem(DocEntry *e);
 
-   void AddEntry(gdcmSQItem *it, int itemNumber);
-   gdcmSQItem *GetSQItemByOrdinalNumber(int itemNumber);
+   /// Gets the Sequence Delimitation Item
+   DocEntry *GetDelimitationItem() { return SeqTerm;}
 
    /// Gets the depth level
-   int GetDepthLevel() { return SQDepthLevel; }
-                                                                                
+   int GetDepthLevel() const { return SQDepthLevel; }
    /// Sets the depth level of a Sequence Entry embedded in a SeQuence
    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
+
+   virtual void Copy(DocEntry *doc);
+
 protected:
 
 private:
-// Variables
+   //SeqEntry( DictEntry *e);
+   SeqEntry( DocEntry *d, int depth );
+   SeqEntry( uint16_t group, uint16_t elem );
+   ~SeqEntry();
 
+// Variables
    /// If this Sequence is in delimitor mode (length =0xffffffff) or not
-   bool delimitor_mode;
+   bool DelimitorMode;
    
    /// Chained list of SQ Items
-   ListSQItem items;
-   
+   ListSQItem Items;
+   /// iterator on the SQItems of the current SeqEntry
+   ListSQItem::iterator ItSQItem;
+
    /// sequence terminator item 
-   gdcmDocEntry *seq_term;
+   DocEntry *SeqTerm;
 
-   /// \brief Defines the depth level of this \ref gdcmSeqEntry inside
-   ///        the (optionaly) nested sequences. \ref SQDepthLevel
-   ///        and its \ref gdcmSQItem::SQDepthLevel counterpart
-   ///        are only defined on printing purposes (see \ref Print).
+   /// \brief Defines the depth level of this  SeqEntry inside
+   ///        the (optionaly) nested sequences.  SQDepthLevel
+   ///        and its  SQItem::SQDepthLevel counterpart
+   ///        are only defined on printing purposes (see  Print).
    int SQDepthLevel;
 };
-
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif