]> Creatis software - gdcm.git/blobdiff - src/gdcmSQItem.cxx
Fix mistypings
[gdcm.git] / src / gdcmSQItem.cxx
index 5e4812f28e8db2f67aa3c1e6c25b41e94bea3e20..b6c5dd0d31c9a9045d7abbc1ea2b0a5fbe2ff82d 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/06/22 14:16:45 $
-  Version:   $Revision: 1.12 $
+  Date:      $Date: 2007/10/08 15:20:17 $
+  Version:   $Revision: 1.88 $
   
   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 "gdcmSQItem.h"
 #include "gdcmSeqEntry.h"
-#include "gdcmValEntry.h"
-#include "gdcmBinEntry.h"
 #include "gdcmGlobal.h"
+#include "gdcmDictSet.h"
 #include "gdcmUtil.h"
-
 #include "gdcmDebug.h"
 
+#include <fstream>
 
+namespace GDCM_NAME_SPACE 
+{
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup gdcmSQItem
- * \brief   Constructor from a given gdcmSQItem
+ * \brief   Constructor from a given SQItem
  */
-gdcmSQItem::gdcmSQItem(int depthLevel ) 
-          : gdcmDocEntrySet(depthLevel) {
-   SQDepthLevel = depthLevel +1;
+SQItem::SQItem(int depthLevel ) 
+          : DocEntrySet( )
+{
+   SQDepthLevel = depthLevel;
+   SQItemNumber = 0;
 }
 
 /**
  * \brief   Canonical destructor.
  */
-gdcmSQItem::~gdcmSQItem() 
+SQItem::~SQItem() 
 {
-   for(ListDocEntry::iterator cc = docEntries.begin();
-       cc != docEntries.end();
-       ++cc)
-   {
-      delete (*cc);
-   }
-   docEntries.clear();
+   ClearEntry();
 }
 
 //-----------------------------------------------------------------------------
-// Print
+// Public
 /*
- * \brief   canonical Printer
+ * \brief   canonical Writer
+ * @param fp     file pointer to an already open file. 
+ * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
  */
- void gdcmSQItem::Print(std::ostream & os) {
-   std::ostringstream s;
+void SQItem::WriteContent(std::ofstream *fp, FileType filetype, 
+                               bool , bool )
+{
+   int j;
+   uint16_t item[4] = { 0xfffe, 0xe000, 0xffff, 0xffff };
+   uint16_t itemt[4]= { 0xfffe, 0xe00d, 0x0000, 0x0000 };
 
-   if (SQDepthLevel>0) {
-      for (int i=0;i<SQDepthLevel;i++)
-         s << "   | " ;
+    //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 
    }
-   std::cout << s.str() << " --- SQItem number " << SQItemNumber  << std::endl;
-   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 ( (*it)->GetGroup() == 0xfffe )
+      {
+         continue;
+      }
+
+      // 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 : break or continue; ?!?  
+                 // --> makes no difference since the only bugged file we have
+                 // contains 'impossible tag' fffe|0000 in last position !                            
+      }
+      // false : we are not in MetaElements
+      // true  : we are inside a Sequence
+      (*it)->WriteContent(fp, filetype, false, true);
+   }
+      
+    //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)
    {
-       os << s.str();
-      //(*i)->SetPrintLevel(printLevel); //self->GetPrintLevel() ?
-      (*i)->SetPrintLevel(2);
-      (*i)->Print(os);   
+      binary_write( *fp, itemt[j]);  // fffe e000 0000 0000
    } 
 }
 
-
-/*
- * \ingroup gdcmSQItem
- * \brief   canonical Writer
+/**
+ * \brief   Compute the full length of the SQItem (not only value length)
+ *           depending on the VR.
  */
- 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);
-
-      if (gdcmBinEntry* BinEntry = dynamic_cast< gdcmBinEntry* >(Entry) ) {
-         BinEntry->Write(fp,filetype);
-         return;
-      }
-      if (gdcmValEntry* ValEntry = dynamic_cast< gdcmValEntry* >(Entry) ) {
-         ValEntry->Write(fp,filetype);
-         return;
-      }
-      if (gdcmSeqEntry* SeqEntry = dynamic_cast< gdcmSeqEntry* >(Entry) ) {
-         SeqEntry->Write(fp,filetype);
-         return;
+uint32_t SQItem::ComputeFullLength()
+{
+   uint32_t l = 8;  // Item Starter length
+   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;
       }
-   } 
+      l += (*it)->ComputeFullLength();
+   }
+   l += 8; // 'Item Delimitation' item 
+   return l;  
 }
 
-
-//-----------------------------------------------------------------------------
-// Public
 /**
- * \brief   adds any Entry (Dicom Element) to the Sequence Item
+ * \brief   Inserts *in the right place* any Entry (Dicom Element)
+ *          into the Sequence Item
+ * @param entry Entry to add
+ * @return always true 
  */
-bool gdcmSQItem::AddEntry(gdcmDocEntry *entry)
-{
-   docEntries.push_back(entry);
-   //TODO : check if it worked
+bool SQItem::AddEntry(DocEntry *entry)
+{   
+   if (DocEntries.empty() )
+   {
+      DocEntries.push_back(entry);
+      entry->Register();
+      return true;
+   }
+   ListDocEntry::iterator insertSpot;
+   ListDocEntry::iterator it = DocEntries.end();
+   do
+   {
+      it--;
+
+      if ( (*it)->IsItemDelimitor() )
+      {
+         continue;
+      }
+      if ( (*it)->GetGroup() < entry->GetGroup() )
+         break;
+      else
+         if ( (*it)->GetGroup() == entry->GetGroup() &&
+              (*it)->GetElement() < entry->GetElement() )
+            break;
+   } while (it != DocEntries.begin() );
+  
+   ++it;
+   insertSpot = it;
+   DocEntries.insert(insertSpot, entry); 
+   entry->Register();
    return true;
 }   
 
 /**
- * \brief   Sets Entry (Dicom Element) value of an element,
- *          specified by it's tag (Group, Number) 
- *          and the length, too ...  inside a SQ Item
- *          If the Element is not found, it's just created !
- * \warning we suppose, right now, the element belongs to a Public Group
- *          (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.
- * @return  true if element was found or created successfully
+ * \brief   Clear the std::list from given entry AND delete the entry.
+ * @param   entryToRemove Entry to remove AND delete.
+ * @return true if the entry was found and removed; false otherwise
  */
-
-bool gdcmSQItem::SetEntryByNumber(std::string val,guint16 group, 
-                                  guint16 element)
+bool SQItem::RemoveEntry( DocEntry *entryToRemove )
 {
-   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()) )
+   for(ListDocEntry::iterator it = DocEntries.begin();
+                              it != DocEntries.end();
+                            ++it)
+   {
+      if ( *it == entryToRemove )
       {
-         // instead of ReplaceOrCreateByNumber 
-         // that is a method of gdcmDocument :-( 
-         gdcmValEntry* Entry = (gdcmValEntry*)0;
-         TagKey key = gdcmDictEntry::TranslateToKey(group, element);
-
-         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 {
-            gdcmDocEntry* FoundEntry = ptagHT->find(key)->second;
-            Entry = dynamic_cast<gdcmValEntry*>(FoundEntry);
-            if (!Entry) 
-               dbg.Verbose(0, "gdcmSQItem::SetEntryByNumber: docEntries"
-                              " contains non gdcmValEntry occurences");
-         }
-         if (Entry)
-            Entry->SetValue(val); 
-         Entry->SetLength(val.length());
-         docEntries.insert(i,Entry); 
+         DocEntries.erase(it);
+         gdcmDebugMacro( "One element erased: " << entryToRemove->GetKey() );
+         entryToRemove->Unregister();
          return true;
-      }   
-      if (group == (*i)->GetGroup() && element == (*i)->GetElement() )
-      {
-         if ( gdcmValEntry* Entry = dynamic_cast<gdcmValEntry*>(*i) )
-            Entry->SetValue(val);
-         (*i)->SetLength(val.length()); 
-         return true;    
       }
    }
+   gdcmWarningMacro( "Entry not found: " << entryToRemove->GetKey() );
+   return false ;
 }
-//-----------------------------------------------------------------------------
-// Protected
 
+/**
+ * \brief  Remove all entry in the Sequence Item 
+ */
+void SQItem::ClearEntry()
+{
+   for(ListDocEntry::iterator cc = DocEntries.begin();
+                              cc != DocEntries.end();
+                            ++cc)
+   {
+      (*cc)->Unregister();
+   }
+   DocEntries.clear();
+}
 
 /**
- * \brief   Gets a Dicom Element inside a SQ Item Entry, by number
- * @return
+ * \brief   Get the first Dicom entry while visiting the SQItem
+ * \return  The first DocEntry if found, otherwhise 0
  */
-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);
-   }   
+DocEntry *SQItem::GetFirstEntry()
+{
+   ItDocEntries = DocEntries.begin();
+   if ( ItDocEntries != DocEntries.end() )
+      return *ItDocEntries;
+   return 0;   
+}
+                                                                                
+/**
+ * \brief   Get the next Dicom entry while visiting the SQItem
+ * \return  The next DocEntry if found, otherwhise NULL
+ */
+DocEntry *SQItem::GetNextEntry()
+{
+   ++ItDocEntries;
+   if ( ItDocEntries != DocEntries.end() )
+      return  *ItDocEntries;
    return NULL;
 }
 
 /**
- * \brief   Get the value of a Dicom Element inside a SQ Item Entry, by number
- * @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();
-      }
-   }   
-   return GDCM_UNFOUND;
+ * \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 Entry whose (group,elem) was passed. 0 if not found
+ */
+DocEntry *SQItem::GetDocEntry(uint16_t group, uint16_t elem)
+{
+   for(ListDocEntry::iterator i =  DocEntries.begin();
+                              i != DocEntries.end(); 
+                            ++i)
+   {
+      if ( (*i)->GetGroup() == group && (*i)->GetElement() == elem )
+         return *i;
+   }
+   return NULL;
+}
+
+/**
+ * \brief Copies all the attributes from an other DocEntrySet 
+ * @param set entry to copy from
+ * @remarks The contained DocEntries a not copied, only referenced
+ */
+void SQItem::Copy(DocEntrySet *set)
+{
+   // Remove all previous entries
+   ClearEntry();
+
+   DocEntrySet::Copy(set);
+
+   SQItem *sq = dynamic_cast<SQItem *>(set);
+   if( sq )
+   {
+      SQDepthLevel = sq->SQDepthLevel;
+      SQItemNumber = sq->SQItemNumber;
+
+      DocEntries = sq->DocEntries;
+      for(ItDocEntries = DocEntries.begin();ItDocEntries != DocEntries.end();++ItDocEntries)
+         (*ItDocEntries)->Register();
+   }
 }
+
+//-----------------------------------------------------------------------------
+// Protected
+
 //-----------------------------------------------------------------------------
 // Private
 
+//-----------------------------------------------------------------------------
+// Print
+/*
+ * \brief   canonical Printer
+ * @param os     Stream to print to. 
+ * @param indent Indentation string to be prepended during printing.
+ */
+void SQItem::Print(std::ostream &os, std::string const &)
+{
+   std::ostringstream s;
+
+   if (SQDepthLevel > 0)
+   {
+      for (int i = 0; i < SQDepthLevel; ++i)
+      {
+         s << "   | " ;
+      }
+   }
+   os << s.str() << " --- SQItem number " << SQItemNumber  << std::endl;
+   for (ListDocEntry::iterator i  = DocEntries.begin();
+                               i != DocEntries.end();
+                             ++i)
+   {
+      DocEntry *Entry = *i;
+      bool PrintEndLine = true;
+
+      os << s.str();
+      Entry->SetPrintLevel(PrintLevel);
+      Entry->Print(os); 
+      if ( dynamic_cast<SeqEntry*>(Entry) )
+      {
+         PrintEndLine = false;
+      }
+      if (PrintEndLine)
+      {
+         os << std::endl;
+      }
+   } 
+}
 
 //-----------------------------------------------------------------------------
+} // end namespace gdcm