]> Creatis software - gdcm.git/blobdiff - src/gdcmSQItem.cxx
* Remove memory leaks on the DicomDir
[gdcm.git] / src / gdcmSQItem.cxx
index 709456b363566e60feb1d23080c75ebc176bcebb..62e506771508224ce7ddb841603af16380b2a3f4 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/06/22 13:47:33 $
-  Version:   $Revision: 1.11 $
+  Date:      $Date: 2004/12/03 17:13:18 $
+  Version:   $Revision: 1.39 $
   
   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 "gdcmBinEntry.h"
 #include "gdcmGlobal.h"
 #include "gdcmUtil.h"
-
 #include "gdcmDebug.h"
+#include <fstream>
 
-
+namespace gdcm 
+{
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup gdcmSQItem
- * \brief   Constructor from a given gdcmSQItem
+ * \ingroup SQItem
+ * \brief   Constructor from a given SQItem
  */
-gdcmSQItem::gdcmSQItem(int depthLevel ) 
-          : gdcmDocEntrySet(depthLevel) {
-   SQDepthLevel = depthLevel +1;
+SQItem::SQItem(int depthLevel ) 
+          : DocEntrySet( )
+{
+   SQDepthLevel = depthLevel;
 }
 
 /**
  * \brief   Canonical destructor.
  */
-gdcmSQItem::~gdcmSQItem() 
+SQItem::~SQItem() 
 {
-   for(ListDocEntry::iterator cc = docEntries.begin();
-       cc != docEntries.end();
-       ++cc)
+   for(ListDocEntry::iterator cc = DocEntries.begin();
+                             cc != DocEntries.end();
+                             ++cc)
    {
-      delete (*cc);
+      delete *cc;
    }
-   docEntries.clear();
+   DocEntries.clear();
 }
 
 //-----------------------------------------------------------------------------
@@ -56,63 +58,97 @@ gdcmSQItem::~gdcmSQItem()
 /*
  * \brief   canonical Printer
  */
- void gdcmSQItem::Print(std::ostream & os) {
+ void SQItem::Print(std::ostream& os)
+ {
+   os << "S ";
    std::ostringstream s;
 
-   if (SQDepthLevel>0) {
-      for (int i=0;i<SQDepthLevel;i++)
+   if (SQDepthLevel > 0)
+   {
+      for (int i = 0; i < SQDepthLevel; ++i)
+      {
          s << "   | " ;
+      }
    }
-   std::cout << s.str() << " --- SQItem number " << SQItemNumber  << std::endl;
-   for (ListDocEntry::iterator i = docEntries.begin();  
-        i != docEntries.end();
-        ++i)
+   //std::cout << s.str() << " --- SQItem number " << SQItemNumber  << std::endl;
+   for (ListDocEntry::iterator i  = DocEntries.begin();
+                               i != DocEntries.end();
+                             ++i)
    {
-       os << s.str();
-      //(*i)->SetPrintLevel(printLevel); //self->GetPrintLevel() ?
-      (*i)->SetPrintLevel(2);
-      (*i)->Print(os);   
+      DocEntry* Entry = *i;
+      bool PrintEndLine = true;
+
+      os << s.str();
+      Entry->SetPrintLevel(2);
+      Entry->Print(os); 
+      if ( SeqEntry* seqEntry = dynamic_cast<SeqEntry*>(Entry) )
+      {
+         (void)seqEntry;  //not used
+         PrintEndLine = false;
+      }
+      if (PrintEndLine)
+      {
+         os << std::endl;
+      }
    } 
 }
 
-
 /*
- * \ingroup gdcmSQItem
+ * \ingroup SQItem
  * \brief   canonical Writer
  */
- void gdcmSQItem::Write(FILE *fp,FileType filetype) {
-   gdcmDocEntry *Entry;
-   for (ListDocEntry::iterator i = docEntries.begin();  
-        i != docEntries.end();
-        ++i)
-   {
-      Entry=*i;
-      (Entry)->WriteCommonPart(fp, filetype);
+void SQItem::WriteContent(std::ofstream* fp, FileType filetype)
+{
+   int j;
+   uint16_t item[4] = { 0xfffe, 0xe000, 0xffff, 0xffff };
+   uint16_t itemt[4]= { 0xfffe, 0xe00d, 0xffff, 0xffff };
 
-      if (gdcmBinEntry* BinEntry = dynamic_cast< gdcmBinEntry* >(Entry) ) {
-         BinEntry->Write(fp,filetype);
-                       return;
-      }
-      if (gdcmValEntry* ValEntry = dynamic_cast< gdcmValEntry* >(Entry) ) {
-         ValEntry->Write(fp,filetype);
-                       return;
+    //we force the writting of an 'Item' Start Element
+    // because we want to write the Item as a 'no Length' item
+   for(j=0;j<4;++j)
+   {
+      binary_write( *fp, item[j]);  // fffe e000 ffff ffff 
+   }
+     
+   for (ListDocEntry::iterator it = DocEntries.begin();  
+                              it != DocEntries.end();
+                             ++it)
+   {   
+      // we skip delimitors (start and end one) because 
+      // we force them as 'no length'
+      if ( (*it)->GetGroup() == 0xfffe )
+      {
+         continue;
       }
-      if (gdcmSeqEntry* SeqEntry = dynamic_cast< gdcmSeqEntry* >(Entry) ) {
-         SeqEntry->Write(fp,filetype);
-                       return;
+
+      // Fix in order to make some MR PHILIPS images e-film readable
+      // see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
+      // we just *always* ignore spurious fffe|0000 tag ! 
+      if ( (*it)->GetGroup() == 0xfffe && (*it)->GetElement() == 0x0000 )
+      {
+         break; // FIXME : continue; ?!?
       }
-   } 
-}
 
+      (*it)->WriteContent(fp, filetype);
+   }
+      
+    //we force the writting of an 'Item Delimitation' item
+    // because we wrote the Item as a 'no Length' item
+   for(j=0;j<4;++j)
+   {
+      binary_write( *fp, itemt[j]);  // fffe e000 ffff ffff 
+   }
+}
 
 //-----------------------------------------------------------------------------
 // Public
 /**
  * \brief   adds any Entry (Dicom Element) to the Sequence Item
  */
-bool gdcmSQItem::AddEntry(gdcmDocEntry *entry)
+bool SQItem::AddEntry(DocEntry* entry)
 {
-   docEntries.push_back(entry);
+   DocEntries.push_back(entry);
    //TODO : check if it worked
    return true;
 }   
@@ -130,79 +166,169 @@ bool gdcmSQItem::AddEntry(gdcmDocEntry *entry)
  * @return  true if element was found or created successfully
  */
 
-bool gdcmSQItem::SetEntryByNumber(std::string val,guint16 group, 
-                                  guint16 element)
+bool SQItem::SetEntryByNumber(std::string const & val, uint16_t group, 
+                              uint16_t element)
 {
-   for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i)
+   for(ListDocEntry::iterator i = DocEntries.begin(); 
+                              i != DocEntries.end(); 
+                            ++i)
    { 
       if ( (*i)->GetGroup() == 0xfffe && (*i)->GetElement() == 0xe000 ) 
+      {
          continue;
+      }
 
       if (  ( group   < (*i)->GetGroup() )
           ||( group == (*i)->GetGroup() && element < (*i)->GetElement()) )
       {
          // instead of ReplaceOrCreateByNumber 
-         // that is a method of gdcmDocument :-( 
-         gdcmValEntry* Entry = (gdcmValEntry*)0;
-         TagKey key = gdcmDictEntry::TranslateToKey(group, element);
-                       
-         if ( ! ptagHT->count(key))
+         // that is a method of Document :-( 
+         ValEntry* entry = 0;
+         TagKey key = DictEntry::TranslateToKey(group, element);
+
+         if ( ! PtagHT->count(key))
          {
             // we assume a Public Dictionnary *is* loaded
-            gdcmDict *PubDict = gdcmGlobal::GetDicts()->GetDefaultPubDict();
+            Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
             // if the invoked (group,elem) doesn't exist inside the Dictionary
             // we create a VirtualDictEntry
-            gdcmDictEntry *DictEntry = PubDict->GetDictEntryByNumber(group,
-                                                                     element);
-            if (DictEntry == NULL)
+            DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, element);
+            if (dictEntry == NULL)
             {
-              DictEntry=gdcmGlobal::GetDicts()->NewVirtualDictEntry(group,
-                                                                    element,
-                                                                    "UN",
-                                                                    "??","??");
+               dictEntry = 
+                  Global::GetDicts()->NewVirtualDictEntry(group, element,
+                                                          "UN", "??", "??");
             } 
             // we assume the constructor didn't fail
-            Entry = new gdcmValEntry(DictEntry);
+            entry = new ValEntry(dictEntry);
             /// \todo
             /// ----
             /// better we don't assume too much !
-            /// gdcmSQItem is now used to describe any DICOMDIR related object
-         } else {
-            gdcmDocEntry* FoundEntry = ptagHT->find(key)->second;
-            Entry = dynamic_cast<gdcmValEntry*>(FoundEntry);
-            if (!Entry) 
-               dbg.Verbose(0, "gdcmSQItem::SetEntryByNumber: docEntries"
-                              " contains non gdcmValEntry occurences");
+            /// SQItem is now used to describe any DICOMDIR related object
          }
-         if (Entry)
-            Entry->SetValue(val); 
-         Entry->SetLength(val.length());
-         docEntries.insert(i,Entry); 
+         else
+         {
+            DocEntry* foundEntry = PtagHT->find(key)->second;
+            entry = dynamic_cast<ValEntry*>(foundEntry);
+            if (!entry)
+            {
+               dbg.Verbose(0, "SQItem::SetEntryByNumber: docEntries"
+                              " contains non ValEntry occurences");
+            }
+         }
+         if (entry)
+         {
+            entry->SetValue(val); 
+         }
+         entry->SetLength(val.length());
+         DocEntries.insert(i,entry);
+
          return true;
-      }           
+      }   
       if (group == (*i)->GetGroup() && element == (*i)->GetElement() )
       {
-         if ( gdcmValEntry* Entry = dynamic_cast<gdcmValEntry*>(*i) )
-            Entry->SetValue(val);
+         if ( ValEntry* entry = dynamic_cast<ValEntry*>(*i) )
+         {
+            entry->SetValue(val);
+         }
          (*i)->SetLength(val.length()); 
          return true;    
       }
    }
+   return false;
 }
-//-----------------------------------------------------------------------------
-// Protected
 
+/**
+ * \brief   Clear the hash table from given entry AND delete the entry.
+ * @param   entryToRemove Entry to remove AND delete.
+ * \warning Some problems when using under Windows... prefer the use of
+ *          Initialize / GetNext methods
+ */
+bool SQItem::RemoveEntry( DocEntry* entryToRemove)
+{
+   for(ListDocEntry::iterator it = DocEntries.begin();
+       it != DocEntries.end();
+       ++it)
+   {
+      if( *it == entryToRemove)
+      {
+         DocEntries.erase(it);
+         dbg.Verbose(0, "SQItem::RemoveEntry: one element erased.");
+         delete entryToRemove;
+         return true;
+      }
+   }
+                                                                                
+   dbg.Verbose(0, "SQItem::RemoveEntry: value not present ");
+   return false ;
+}
+                                                                                
+/**
+ * \brief   Clear the hash table from given entry BUT keep the entry.
+ * @param   entryToRemove Entry to remove.
+ */
+bool SQItem::RemoveEntryNoDestroy(DocEntry* entryToRemove)
+{
+   for(ListDocEntry::iterator it = DocEntries.begin();
+       it != DocEntries.end();
+       ++it)
+   {
+      if( *it == entryToRemove)
+      {
+         DocEntries.erase(it);
+         dbg.Verbose(0, "SQItem::RemoveEntry: one element erased.");
+         return true;
+      }
+   }
+                                                                                
+   dbg.Verbose(0, "SQItem::RemoveEntry: value not present ");
+   return false ;
+}
+                                                                                
+/**
+ * \brief   Initialise the visit of the chained list
+ */
+void SQItem::Initialize()
+{
+   ItDocEntries = DocEntries.begin();
+}
+                                                                                
+/**
+ * \brief   Get the next entry whil visiting the chained list
+ * \return  The next DocEntry if found, otherwhise NULL
+ */
+DocEntry *SQItem::GetNextEntry()
+{
+   if (ItDocEntries != DocEntries.end())
+   {
+      DocEntry *tmp = *ItDocEntries;
+      ++ItDocEntries;
+                                                                                
+      return(tmp);
+   }
+   else
+   {
+      return(NULL);
+   }
+}
 
+//-----------------------------------------------------------------------------
+// Protected
 /**
  * \brief   Gets a Dicom Element inside a SQ Item Entry, by number
  * @return
  */
-gdcmDocEntry *gdcmSQItem::GetDocEntryByNumber(guint16 group, guint16 element) {
-   for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i) {
-      if ( (*i)->GetGroup()==group && (*i)->GetElement()==element)
-         return (*i);
-   }   
-   return NULL;
+DocEntry* SQItem::GetDocEntryByNumber(uint16_t group, uint16_t element)
+{
+   for(ListDocEntry::iterator i = DocEntries.begin();
+                              i != DocEntries.end(); ++i)
+   {
+      if ( (*i)->GetGroup() == group && (*i)->GetElement() == element )
+      {
+         return *i;
+      }
+   }
+   return 0;
 }
 
 /**
@@ -210,12 +336,16 @@ gdcmDocEntry *gdcmSQItem::GetDocEntryByNumber(guint16 group, guint16 element) {
  * @return
  */ 
 
-std::string gdcmSQItem::GetEntryByNumber(guint16 group, guint16 element) { 
-   for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i) {
-      if ( (*i)->GetGroup()==group && (*i)->GetElement()==element) {
-         return ((gdcmValEntry *)(*i))->GetValue();
+std::string SQItem::GetEntryByNumber(uint16_t group, uint16_t element)
+{
+   for(ListDocEntry::iterator i = DocEntries.begin();
+                              i != DocEntries.end(); ++i)
+   {
+      if ( (*i)->GetGroup() == group && (*i)->GetElement() == element)
+      {
+         return ((ValEntry *)(*i))->GetValue();   //FIXME
       }
-   }   
+   }
    return GDCM_UNFOUND;
 }
 //-----------------------------------------------------------------------------
@@ -223,3 +353,5 @@ std::string gdcmSQItem::GetEntryByNumber(guint16 group, guint16 element) {
 
 
 //-----------------------------------------------------------------------------
+
+} // end namespace gdcm