ENH: Adding 'gdcm' namespace. Be nice with me this was a ~13000 lines patch. Also...

[gdcm.git] / src / gdcmSeqEntry.h

diff --git a/src/gdcmSeqEntry.h b/src/gdcmSeqEntry.h
index e197bc04db672432b80785aadf207b5e6fb0a0d6..0358bf0db9b9e7b3cc4df62e6e007694ab2fec4f 100644 (file)
--- a/src/gdcmSeqEntry.h
+++ b/src/gdcmSeqEntry.h
@@ -1,66 +1,82 @@
-// gdcmSeqEntry.h
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmSeqEntry.h,v $
+  Language:  C++
+  Date:      $Date: 2004/10/12 04:35:48 $
+  Version:   $Revision: 1.20 $
+                                                                                
+  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 GDCMSQDOCENTRY_H
 #define GDCMSQDOCENTRY_H
 
-#include <list>
-
 #include "gdcmSQItem.h"
 #include "gdcmDocEntry.h"
+#include <list>
+namespace gdcm 
+{
 
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmSQItem *> ListSQItem;
+typedef std::list<SQItem *> ListSQItem;
 //-----------------------------------------------------------------------------
 
-class GDCM_EXPORT gdcmSeqEntry : public gdcmDocEntry 
+class GDCM_EXPORT SeqEntry : public DocEntry 
 {
 public:
-   gdcmSeqEntry(gdcmDictEntry* e, int depth);
-   ~gdcmSeqEntry(void);
+   SeqEntry( DictEntry* );
+   SeqEntry(DocEntry* d,  int depth);
+   virtual ~SeqEntry();
    
    virtual void Print(std::ostream &os = std::cout); 
+   virtual void Write(FILE *fp, FileType);
 
- /// \brief   returns the SQITEM chained List for this SeQuence.
-   inline ListSQItem &GetSQItems() 
-      {return items;};
+   /// returns the SQITEM chained List for this SeQuence.
+   ListSQItem &GetSQItems() { return items; }
       
- /// \brief Sets the delimitor mode
-    inline void SetDelimitorMode(bool dm) 
-       { delimitor_mode = dm;}
+   /// Sets the delimitor mode
+   void SetDelimitorMode(bool dm) { delimitor_mode = dm;}
 
- /// \brief Sets the Sequence Delimitation Item
-    inline void SetSequenceDelimitationItem(gdcmDocEntry * e) 
-       { seq_term = e;}
-       
-    void AddEntry(gdcmSQItem *it); 
+   /// Sets the Sequence Delimitation Item
+   void SetSequenceDelimitationItem(DocEntry * e) { seq_term = e;}
 
- /// \brief   creates a new SQITEM for this SeQuence.
-    gdcmSQItem * NewItem(void);
-    
-   gdcmDocEntry *NewDocEntryByNumber(guint16 group, guint16 element);    
-   gdcmDocEntry *NewDocEntryByName  (std::string Name); 
-   gdcmDocEntry *GetDocEntryByNumber(guint16 group, guint16 element);
+   void AddEntry(SQItem *it, int itemNumber);
+   SQItem *GetSQItemByOrdinalNumber(int itemNumber);
 
-   void SetDepthLevel(int depth);
-         
+   /// Gets the depth level
+   int GetDepthLevel() { return SQDepthLevel; }
+                                                                                
+   /// Sets the depth level of a Sequence Entry embedded in a SeQuence
+   void SetDepthLevel(int depth) { SQDepthLevel = depth; }
 protected:
 
 private:
-
 // Variables
 
-/// \brief If this Sequence is in delimitor mode (length =0xffffffff) or not
+   /// If this Sequence is in delimitor mode (length =0xffffffff) or not
    bool delimitor_mode;
    
-/// \brief chained list of SQ Items
+   /// Chained list of SQ Items
    ListSQItem items;
    
-/// \brief sequence terminator item 
-   gdcmDocEntry *seq_term;
-
+   /// sequence terminator item 
+   DocEntry *seq_term;
+
+   /// \brief Defines the depth level of this \ref SeqEntry inside
+   ///        the (optionaly) nested sequences. \ref SQDepthLevel
+   ///        and its \ref SQItem::SQDepthLevel counterpart
+   ///        are only defined on printing purposes (see \ref Print).
+   int SQDepthLevel;
 };
-
-
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif