]> Creatis software - gdcm.git/blobdiff - src/gdcmSQItem.cxx
According to Benoit's suggestion, and without any objection from anybody
[gdcm.git] / src / gdcmSQItem.cxx
index 2299b946bc6af54bf7f2047e82c715c85f34ee51..c6cd59c1150c0ed2c9de5a0a25dbc7152cc49bf1 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/27 15:48:44 $
-  Version:   $Revision: 1.25 $
+  Date:      $Date: 2005/01/08 15:04:00 $
+  Version:   $Revision: 1.49 $
   
   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 "gdcmValEntry.h"
 #include "gdcmBinEntry.h"
 #include "gdcmGlobal.h"
+#include "gdcmDictSet.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)
+SQItem::SQItem(int depthLevel ) 
+          : DocEntrySet( )
 {
-   SQDepthLevel = depthLevel +1;
+   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();
 }
 
 //-----------------------------------------------------------------------------
@@ -57,8 +60,8 @@ gdcmSQItem::~gdcmSQItem()
 /*
  * \brief   canonical Printer
  */
- void gdcmSQItem::Print(std::ostream & os)
- {
+void SQItem::Print(std::ostream &os)
+{
    std::ostringstream s;
 
    if (SQDepthLevel > 0)
@@ -68,20 +71,20 @@ gdcmSQItem::~gdcmSQItem()
          s << "   | " ;
       }
    }
-   std::cout << s.str() << " --- SQItem number " << SQItemNumber  << std::endl;
-   for (ListDocEntry::iterator i  = docEntries.begin();
-                               i != docEntries.end();
+   //std::cout << s.str() << " --- SQItem number " << SQItemNumber  << std::endl;
+   for (ListDocEntry::iterator i  = DocEntries.begin();
+                               i != DocEntries.end();
                              ++i)
    {
-      gdcmDocEntry* Entry = *i;
+      DocEntry *Entry = *i;
       bool PrintEndLine = true;
 
       os << s.str();
-      Entry->SetPrintLevel(2);
+      Entry->SetPrintLevel(PrintLevel);
       Entry->Print(os); 
-      if ( gdcmSeqEntry* SeqEntry = dynamic_cast<gdcmSeqEntry*>(Entry) )
+      if ( SeqEntry *seqEntry = dynamic_cast<SeqEntry*>(Entry) )
       {
-         (void)SeqEntry;  //not used
+         (void)seqEntry;  //not used
          PrintEndLine = false;
       }
       if (PrintEndLine)
@@ -92,25 +95,29 @@ gdcmSQItem::~gdcmSQItem()
 }
 
 /*
- * \ingroup gdcmSQItem
+ * \ingroup SQItem
  * \brief   canonical Writer
  */
-void gdcmSQItem::Write(FILE *fp,FileType 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 };
 
     //we force the writting of an 'Item' Start Element
     // because we want to write the Item as a 'no Length' item
-   fwrite(&item[0],8,1,fp);  // fffe e000 ffff ffff 
+   for(j=0;j<4;++j)
+   {
+      binary_write( *fp, item[j]);  // fffe e000 ffff ffff 
+   }
      
-   for (ListDocEntry::iterator i = docEntries.begin();  
-        i != docEntries.end();
-        ++i)
+   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 ( (*i)->GetGroup() == 0xfffe )
+      if ( (*it)->GetGroup() == 0xfffe )
       {
          continue;
       }
@@ -118,18 +125,21 @@ void gdcmSQItem::Write(FILE *fp,FileType filetype)
       // 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 ( (*i)->GetGroup() == 0xfffe && (*i)->GetElement() == 0x0000 )
+      if ( (*it)->GetGroup() == 0xfffe && (*it)->GetElement() == 0x0000 )
       {
          break; // FIXME : continue; ?!?
       }
 
-      (*i)->Write(fp, filetype);
+      (*it)->WriteContent(fp, filetype);
    }
       
     //we force the writting of an 'Item Delimitation' item
     // because we wrote the Item as a 'no Length' item
-   fwrite(&itemt[0],8,1,fp);  // fffe e000 ffff ffff 
-
+   for(j=0;j<4;++j)
+   {
+      binary_write( *fp, itemt[j]);  // fffe e000 ffff ffff 
+   }
 }
 
 //-----------------------------------------------------------------------------
@@ -137,9 +147,9 @@ void gdcmSQItem::Write(FILE *fp,FileType filetype)
 /**
  * \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;
 }   
@@ -153,94 +163,151 @@ bool gdcmSQItem::AddEntry(gdcmDocEntry *entry)
  *          (NOT a shadow one)       
  * @param   val string value to set
  * @param   group Group number of the searched tag.
- * @param   element Element number of the searched tag.
+ * @param   elem Element number of the searched tag.
  * @return  true if element was found or created successfully
  */
 
-bool gdcmSQItem::SetEntryByNumber(std::string val,uint16_t group, 
-                                  uint16_t element)
+bool SQItem::SetEntry(std::string const &val, uint16_t group, 
+                      uint16_t elem)
 {
-   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()) )
+      if (  ( group  < (*i)->GetGroup() )
+          ||( group == (*i)->GetGroup() && elem < (*i)->GetElement()) )
       {
-         // instead of ReplaceOrCreateByNumber 
-         // that is a method of gdcmDocument :-( 
-         gdcmValEntry* entry = 0;
-         gdcmTagKey key = gdcmDictEntry::TranslateToKey(group, element);
+         // instead of ReplaceOrCreate 
+         // that is a method of Document :-( 
+         ValEntry* entry = 0;
+         TagKey key = DictEntry::TranslateToKey(group, elem);
 
-         if ( ! PtagHT->count(key))
-         {
-            // we assume a Public Dictionnary *is* loaded
-            gdcmDict *pubDict = gdcmGlobal::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 = 
-                  gdcmGlobal::GetDicts()->NewVirtualDictEntry(group, element,
-                                                              "UN", "??", "??");
-            } 
-            // we assume the constructor didn't fail
-            entry = new gdcmValEntry(dictEntry);
-            /// \todo
-            /// ----
-            /// better we don't assume too much !
-            /// gdcmSQItem is now used to describe any DICOMDIR related object
-         }
-         else
+         // we assume a Public Dictionnary *is* loaded
+         Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
+         // if the invoked (group,elem) doesn't exist inside the Dictionary
+         // we create a VirtualDictEntry
+         DictEntry *dictEntry = pubDict->GetDictEntry(group, elem);
+         if (dictEntry == NULL)
          {
-            gdcmDocEntry* foundEntry = PtagHT->find(key)->second;
-            entry = dynamic_cast<gdcmValEntry*>(foundEntry);
-            if (!entry)
-            {
-               dbg.Verbose(0, "gdcmSQItem::SetEntryByNumber: docEntries"
-                              " contains non gdcmValEntry occurences");
-            }
-         }
+            dictEntry = 
+               Global::GetDicts()->NewVirtualDictEntry(group, elem,
+                                                       "UN", GDCM_UNKNOWN, 
+                                                        GDCM_UNKNOWN);
+         } 
+         // we assume the constructor didn't fail
+         entry = new ValEntry(dictEntry);
          if (entry)
          {
             entry->SetValue(val); 
          }
-         entry->SetLength(val.length());
-         docEntries.insert(i,entry);
+         DocEntries.insert(i,entry);
 
          return true;
       }   
-      if (group == (*i)->GetGroup() && element == (*i)->GetElement() )
+      if (group == (*i)->GetGroup() && elem == (*i)->GetElement() )
       {
-         if ( gdcmValEntry* entry = dynamic_cast<gdcmValEntry*>(*i) )
+         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);
+         gdcmVerboseMacro( "One element erased.");
+         delete entryToRemove;
+         return true;
+      }
+   }
+   gdcmVerboseMacro( "Value not present.");
+   return false ;
+}
 
 /**
- * \brief   Gets a Dicom Element inside a SQ Item Entry, by number
+ * \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);
+         gdcmVerboseMacro( "One element erased.");
+         return true;
+      }
+   }
+                                                                                
+   gdcmVerboseMacro( "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
+ * @param   group   Group number of the Entry
+ * @param   elem  Element number of the Entry
  * @return
  */
-gdcmDocEntry *gdcmSQItem::GetDocEntryByNumber(uint16_t group, uint16_t element)
+DocEntry* SQItem::GetDocEntry(uint16_t group, uint16_t elem)
 {
-   for(ListDocEntry::iterator i = docEntries.begin();
-                              i != docEntries.end(); ++i)
+   for(ListDocEntry::iterator i = DocEntries.begin();
+                              i != DocEntries.end(); ++i)
    {
-      if ( (*i)->GetGroup() == group && (*i)->GetElement() == element )
+      if ( (*i)->GetGroup() == group && (*i)->GetElement() == elem )
       {
          return *i;
       }
@@ -249,18 +316,20 @@ gdcmDocEntry *gdcmSQItem::GetDocEntryByNumber(uint16_t group, uint16_t element)
 }
 
 /**
- * \brief   Get the value of a Dicom Element inside a SQ Item Entry, by number
+ * \brief   Get the value of a Dicom Element inside a SQ Item Entry
+ * @param   group   Group number of the Entry
+ * @param   elem  Element number of the Entry 
  * @return
  */ 
 
-std::string gdcmSQItem::GetEntryByNumber(uint16_t group, uint16_t element)
+std::string SQItem::GetEntry(uint16_t group, uint16_t elem)
 {
-   for(ListDocEntry::iterator i = docEntries.begin();
-                              i != docEntries.end(); ++i)
+   for(ListDocEntry::iterator i = DocEntries.begin();
+                              i != DocEntries.end(); ++i)
    {
-      if ( (*i)->GetGroup() == group && (*i)->GetElement() == element)
+      if ( (*i)->GetGroup() == group && (*i)->GetElement() == elem)
       {
-         return ((gdcmValEntry *)(*i))->GetValue();   //FIXME
+         return ((ValEntry *)(*i))->GetValue();   //FIXME
       }
    }
    return GDCM_UNFOUND;
@@ -270,3 +339,5 @@ std::string gdcmSQItem::GetEntryByNumber(uint16_t group, uint16_t element)
 
 
 //-----------------------------------------------------------------------------
+
+} // end namespace gdcm