Coding Style + Doxygenation

[gdcm.git] / src / gdcmSeqEntry.h

diff --git a/src/gdcmSeqEntry.h b/src/gdcmSeqEntry.h
index 325aff665e47a55892e24fba925546ed7975f518..2388523fd09f188daff69fe942fc2c6246152468 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/06/21 04:43:02 $
-  Version:   $Revision: 1.11 $
+  Date:      $Date: 2005/01/06 20:03:28 $
+  Version:   $Revision: 1.26 $
                                                                                 
   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
@@ -19,52 +19,66 @@
 #ifndef GDCMSQDOCENTRY_H
 #define GDCMSQDOCENTRY_H
 
-#include <list>
-
-#include "gdcmSQItem.h"
 #include "gdcmDocEntry.h"
 
+#include <list>
+
+namespace gdcm 
+{
+class SQItem;
 //-----------------------------------------------------------------------------
-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);
-   virtual ~gdcmSeqEntry();
+   SeqEntry( DictEntry *e);
+   SeqEntry( DocEntry *d, int depth );
+   ~SeqEntry();
    
-   virtual void Print(std::ostream &os = std::cout); 
+   void Print(std::ostream &os = std::cout); 
+   void WriteContent(std::ofstream *fp, FileType filetype);
 
-   /// \brief   returns the SQITEM chained List for this SeQuence.
-   inline ListSQItem &GetSQItems() { return items; }
+   /// returns the SQITEM chained List for this SeQuence.
+   ListSQItem const &GetSQItems() const { return Items; }
       
-   /// \brief Sets the delimitor mode
-   inline void SetDelimitorMode(bool dm) { delimitor_mode = dm;}
+   /// Sets the delimitor mode
+   void SetDelimitorMode(bool dm) { DelimitorMode = dm; }
 
-   /// \brief Sets the Sequence Delimitation Item
-   inline void SetSequenceDelimitationItem(gdcmDocEntry * e) { seq_term = e;}
-       
-   void AddEntry(gdcmSQItem *it, int itemNumber);
-   gdcmSQItem *GetSQItemByOrdinalNumber(int itemNumber);
+   /// Sets the Sequence Delimitation Item
+   void SetSequenceDelimitationItem(DocEntry *e) { SeqTerm = e;}
+
+   void AddEntry(SQItem *it, int itemNumber);
+   SQItem *GetSQItemByOrdinalNumber(int itemNumber);
+
+   /// Gets the depth level
+   int GetDepthLevel() const { return SQDepthLevel; }
+
+   /// Sets the depth level of a Sequence Entry embedded in a SeQuence
+   void SetDepthLevel(int depth) { SQDepthLevel = depth; }
 
-   void SetDepthLevel(int depth);
-         
 protected:
 
 private:
 // Variables
 
-   /// \brief If this Sequence is in delimitor mode (length =0xffffffff) or not
-   bool delimitor_mode;
+   /// If this Sequence is in delimitor mode (length =0xffffffff) or not
+   bool DelimitorMode;
    
-   /// \brief Chained list of SQ Items
-   ListSQItem items;
+   /// Chained list of SQ Items
+   ListSQItem Items;
    
-   /// \brief sequence terminator item 
-   gdcmDocEntry *seq_term;
-};
+   /// sequence terminator item 
+   DocEntry *SeqTerm;
 
+   /// \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