]> Creatis software - gdcm.git/blobdiff - src/gdcmSeqEntry.cxx
Fix mistypings
[gdcm.git] / src / gdcmSeqEntry.cxx
index 9ba911ee236863df0c045455c90c40b0a668b29a..7b047295c3205a8fdd7190561e10987e32d0ba23 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSeqEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/07/02 13:55:28 $
-  Version:   $Revision: 1.21 $
+  Date:      $Date: 2007/10/08 15:20:17 $
+  Version:   $Revision: 1.72 $
                                                                                 
   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
 #include "gdcmTS.h"
 #include "gdcmGlobal.h"
 #include "gdcmUtil.h"
+#include "gdcmDebug.h"
 
 #include <iostream>
 #include <iomanip>
+#include <fstream>
+
+namespace GDCM_NAME_SPACE 
+{
 //-----------------------------------------------------------------------------
+// Constructor / Destructor
+
 // Constructor / Destructor
 /**
- * \ingroup gdcmSeqEntry
- * \brief   Constructor from a given gdcmSeqEntry
+ * \brief   Constructor from a given SeqEntry
  */
-gdcmSeqEntry::gdcmSeqEntry(gdcmDictEntry* e, int depth
-             : gdcmDocEntry(e)
+SeqEntry::SeqEntry( uint16_t group,uint16_t elem 
+             : DocEntry(group, elem, "SQ")
 {
-   delimitor_mode = false;
-   seq_term  = NULL;
-   SQDepthLevel = depth;
+   Length       = 0;
+   ReadLength   = 0xffffffff;
+   SQDepthLevel = -1;
+
+   DelimitorMode = false;
+   SeqTerm  = NULL;
 }
 
 /**
- * \brief   Canonical destructor.
+ * \brief   Constructor from a given DocEntry
+ * @param   e Pointer to existing Doc entry
+ * @param   depth depth level of the current Seq entry
  */
-gdcmSeqEntry::~gdcmSeqEntry() {
-   for(ListSQItem::iterator cc = items.begin();cc != items.end();++cc)
-   {
-      delete *cc;
-   }
-   if (!seq_term)
-      delete seq_term;
+SeqEntry::SeqEntry( DocEntry *e, int depth )
+             //: DocEntry( e->GetDictEntry() )
+            : DocEntry( e->GetGroup(), e->GetElement(), "SQ" /*e->GetVR()*/ )
+{
+   Length       = 0;
+   ReadLength   = 0xffffffff;
+   SQDepthLevel = depth;
+
+   ImplicitVR   = e->IsImplicitVR();
+   Offset       = e->GetOffset();
+   SeqTerm = NULL;
 }
 
-/*
- * \brief   canonical Printer
+/**
+ * \brief   Canonical destructor.
  */
-void gdcmSeqEntry::Print(std::ostream &os){
-
-   // First, Print the Dicom Element itself.
-   SetPrintLevel(2);   
-   gdcmDocEntry::Print(os);
-   os << std::endl;
-
-   if (GetReadLength() == 0)
-      return;
-
-   // Then, Print each SQ Item   
-   for(ListSQItem::iterator cc = items.begin();cc != items.end();++cc)
-   {
-      (*cc)->Print(os);   
-   }
-
-   // at end, print the sequence terminator item, if any
-   if (delimitor_mode) {
-      for (int i=0;i<SQDepthLevel+1;i++)
-         os << "   | " ;
-      if (seq_term != NULL) {
-         seq_term->Print(os);
-         os << std::endl;
-      } 
-      else 
-         // fusible
-         os << "      -------------- should have a sequence terminator item";
-   }                    
+SeqEntry::~SeqEntry()
+{
+   ClearSQItem();
 }
 
+//-----------------------------------------------------------------------------
+// Public
 /*
  * \brief   canonical Writer
+ * @param fp pointer to an already open file
+ * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
  */
-void gdcmSeqEntry::Write(FILE *fp, FileType filetype)
+void SeqEntry::WriteContent(std::ofstream *fp, FileType filetype, bool , bool )
 {
    uint16_t seq_term_gr = 0xfffe;
    uint16_t seq_term_el = 0xe0dd;
    uint32_t seq_term_lg = 0x00000000;
-
-   uint16_t item_term_gr = 0xfffe;
-   uint16_t item_term_el = 0xe00d;
-
-   gdcmDocEntry::Write(fp, filetype);
-   for(ListSQItem::iterator cc  = GetSQItems().begin();
-                            cc != GetSQItems().end();
+   // ignore 'Zero length' Sequences
+   if ( GetReadLength() == 0 )
+      return;
+   // false : we are not in MetaElements
+   // true : we are inside a Sequence
+   DocEntry::WriteContent(fp, filetype, false, true);
+   for(ListSQItem::iterator cc  = Items.begin();
+                            cc != Items.end();
                           ++cc)
-   {
-      (*cc)->Write(fp, filetype);
-
-   fwrite ( &item_term_gr,(size_t)2 ,(size_t)1 ,fp);
-   fwrite ( &item_term_el,(size_t)2 ,(size_t)1 ,fp);   
-   fwrite ( &seq_term_lg,(size_t)4 ,(size_t)1 ,fp); 
+   {   
+      (*cc)->WriteContent(fp, filetype, false, true);
    }
-    //we force the writting of a Sequence Delimitaion item
-    // because we wrote the Sequence as a 'no Length' sequence
-   fwrite ( &seq_term_gr,(size_t)2 ,(size_t)1 ,fp);
-   fwrite ( &seq_term_el,(size_t)2 ,(size_t)1 ,fp);
-   fwrite ( &seq_term_lg,(size_t)4 ,(size_t)1 ,fp); 
+   
+   // we force the writting of a Sequence Delimitation item
+   // because we wrote the Sequence as a 'no Length' sequence
+   binary_write(*fp, seq_term_gr);
+   binary_write(*fp, seq_term_el);
+   binary_write(*fp, seq_term_lg);
 }
 
-//-----------------------------------------------------------------------------
-// Public
+/**
+ * \brief   Compute the full length of the SeqEntry (not only value
+ *          length) depending on the VR.
+ */
+uint32_t SeqEntry::ComputeFullLength()
+{
+   uint32_t l = 12; // Tag (4) + VR (explicit) 4 + 4 (length);   
+   for(ListSQItem::iterator cc  = Items.begin();
+                            cc != Items.end();
+                          ++cc)
+   {        
+      l += (*cc)->ComputeFullLength();
+   }   
+   l += 8; // seq_term Tag (4) +  seq_term_lg (4)
+   return l;
+}
 
- /// \brief   adds the passed ITEM to the ITEM chained List for this SeQuence.      
-void gdcmSeqEntry::AddEntry(gdcmSQItem *sqItem, int itemNumber) {
+/**
+ * \brief   adds the passed ITEM to the ITEM chained List for this SeQuence.
+ * @param sqItem SQItem to be pushed back in the SeqEntry
+ * @param itemNumber ordinal number of the SQItem
+ *  \note NOT end-user intendend method !
+ */
+void SeqEntry::AddSQItem(SQItem *sqItem, int itemNumber)
+{
+// FIXME : SQItemNumber is supposed to be the ordinal number of the SQItem
+//         within the Sequence.
+//         Either only 'push_back' is allowed, 
+//                and we just have to do something like SeqEntry::lastNb++
+//         Or we can add (or remove) anywhere, and SQItemNumber will be broken
    sqItem->SetSQItemNumber(itemNumber);
-   items.push_back(sqItem);
+   Items.push_back(sqItem);
+   sqItem->Register();
 }
 
-/// \brief Sets the depth level of a Sequence Entry embedded in a SeQuence 
-void gdcmSeqEntry::SetDepthLevel(int depth) {
-   SQDepthLevel = depth;
+/**
+ * \brief Remove all SQItem.
+ */
+void SeqEntry::ClearSQItem()
+{
+   for(ListSQItem::iterator cc = Items.begin(); cc != Items.end(); ++cc)
+   {
+      (*cc)->Unregister();
+   }
+   if (SeqTerm)
+   {
+      SeqTerm->Unregister();
+   }
 }
 
-/// \brief return a pointer to the SQItem referenced by its ordinal number
-/// (returns the first one if ordinal number is <0
-///  returns the last  one if ordinal number is > item number
+/**
+ * \brief   Get the first entry while visiting the SeqEntry
+ * \return  The first SQItem if found, otherwhise NULL
+ */ 
+SQItem *SeqEntry::GetFirstSQItem()
+{
+   ItSQItem = Items.begin();
+   if (ItSQItem != Items.end())
+      return *ItSQItem;
+   return NULL;
+} 
 
-gdcmSQItem *gdcmSeqEntry::GetSQItemByOrdinalNumber(int nb) {
+/**
+ * \brief   Get the next SQItem while visiting the SeqEntry
+ * \note : meaningfull only if GetFirstEntry already called
+ * \return  The next SQItem if found, otherwhise NULL
+ */
+
+SQItem *SeqEntry::GetNextSQItem()
+{
+   gdcmAssertMacro (ItSQItem != Items.end())
+   {
+      ++ItSQItem;
+      if (ItSQItem != Items.end())
+         return *ItSQItem;
+   }
+   return NULL;
+}
+/**
+ * \brief return a pointer to the SQItem referenced by its ordinal number.
+ *        Returns the first item when argument is negative.
+ *        Returns the  last item when argument is bigger than the total
+ *        item number.
+ */
+SQItem *SeqEntry::GetSQItem(int nb)
+{
    if (nb<0)
-      return (*(items.begin()));
+   {
+      return *(Items.begin());
+   }
    int count = 0 ;
-   for(ListSQItem::iterator cc = items.begin();
-       cc != items.end();
-       count ++, ++cc){
-      if (count==nb)
+   for(ListSQItem::iterator cc = Items.begin();
+                           cc != Items.end();
+                           count ++, ++cc)
+   {
+      if (count == nb)
+      {
          return *cc;
+      }
+   }
+   return *(Items.end());
+}
+
+/**
+ * \brief returns the number of SQItems within the current Sequence
+ */
+unsigned int SeqEntry::GetNumberOfSQItems()
+{
+   return Items.size();
+}
+
+/**
+ * \brief Sets the Sequence Delimitation Item
+ * \param e Delimitation item
+ */
+void SeqEntry::SetDelimitationItem(DocEntry *e)
+{
+   if( SeqTerm != e )
+   {
+      if( SeqTerm )
+         SeqTerm->Unregister();
+      SeqTerm = e;
+      if( SeqTerm )
+         SeqTerm->Register();
+   }
+}
+
+/**
+ * \brief Copies all the attributes from an other DocEntry 
+ * @param doc entry to copy from
+ * @remarks The contained SQItems a not copied, only referenced
+ */
+void SeqEntry::Copy(DocEntry *doc)
+{
+   // Delete previous SQ items
+   ClearSQItem();
+
+   DocEntry::Copy(doc);
+   SeqEntry *entry = dynamic_cast<SeqEntry *>(doc);
+   if ( entry )
+   {
+      DelimitorMode = entry->DelimitorMode;
+      SQDepthLevel = entry->SQDepthLevel;
+
+      SeqTerm = entry->SeqTerm;
+      if(SeqTerm)
+         SeqTerm->Register();
+      Items = entry->Items;
+      for(ItSQItem = Items.begin();ItSQItem != Items.end(); ++ItSQItem)
+      {
+         (*ItSQItem)->Register();
+      }
    }
-   return (*(items.end())); // Euhhhhh ?!? Is this the last one . FIXME
 }
+
 //-----------------------------------------------------------------------------
 // Protected
 
-
 //-----------------------------------------------------------------------------
 // Private
 
 //-----------------------------------------------------------------------------
+// Print
+/**
+ * \brief   canonical Printer
+ */
+void SeqEntry::Print( std::ostream &os, std::string const & )
+{
+   // os << "S ";
+   
+   // First, Print the common part (vr [length offset] name).
+   DocEntry::Print(os);
+   os << std::endl;
+
+   if (GetReadLength() == 0)
+      return;
+
+   // Then, Print each SQ Item   
+   for(ListSQItem::iterator cc = Items.begin(); cc != Items.end(); ++cc)
+   {
+      (*cc)->SetPrintLevel(PrintLevel);
+      (*cc)->Print(os);   
+   }
+
+   // at end, print the sequence terminator item, if any
+   if (DelimitorMode)
+   {
+      int i;
+      for ( i = 0; i < SQDepthLevel; i++ )
+         os << "   | " ;
+      os << " --- "  << std::endl;
+      for ( i = 0; i < SQDepthLevel; i++ )
+         os << "   | " ;
+      if (SeqTerm != NULL)
+      {
+         SeqTerm->SetPrintLevel(PrintLevel);
+         SeqTerm->Print(os);
+         os << std::endl;
+      } 
+      else 
+      {
+         // fuse
+         gdcmWarningMacro("  -------- should have a sequence terminator item");
+      }
+   }
+}
+
+//-----------------------------------------------------------------------------
+} // end namespace gdcm