]> Creatis software - gdcm.git/blobdiff - src/gdcmSQItem.cxx
Fix mistypings
[gdcm.git] / src / gdcmSQItem.cxx
index a9c1ed5efcc8fb523f3ab91c2a16ffeb9b8ac918..b6c5dd0d31c9a9045d7abbc1ea2b0a5fbe2ff82d 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/12/03 20:16:58 $
-  Version:   $Revision: 1.40 $
+  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
@@ -18,8 +18,6 @@
 
 #include "gdcmSQItem.h"
 #include "gdcmSeqEntry.h"
-#include "gdcmValEntry.h"
-#include "gdcmBinEntry.h"
 #include "gdcmGlobal.h"
 #include "gdcmDictSet.h"
 #include "gdcmUtil.h"
 
 #include <fstream>
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE 
 {
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup SQItem
  * \brief   Constructor from a given SQItem
  */
 SQItem::SQItem(int depthLevel ) 
           : DocEntrySet( )
 {
    SQDepthLevel = depthLevel;
+   SQItemNumber = 0;
 }
 
 /**
@@ -46,74 +44,32 @@ SQItem::SQItem(int depthLevel )
  */
 SQItem::~SQItem() 
 {
-   for(ListDocEntry::iterator cc = DocEntries.begin();
-                             cc != DocEntries.end();
-                             ++cc)
-   {
-      delete *cc;
-   }
-   DocEntries.clear();
+   ClearEntry();
 }
 
 //-----------------------------------------------------------------------------
-// Print
-/*
- * \brief   canonical Printer
- */
- void SQItem::Print(std::ostream& os)
- {
-   os << "S ";
-   std::ostringstream s;
-
-   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)
-   {
-      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;
-      }
-   } 
-}
-
+// Public
 /*
- * \ingroup SQItem
  * \brief   canonical Writer
+ * @param fp     file pointer to an already open file. 
+ * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
  */
-void SQItem::WriteContent(std::ofstream* fp, FileType filetype)
+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, 0xffff, 0xffff };
+   uint16_t itemt[4]= { 0xfffe, 0xe00d, 0x0000, 0x0000 };
 
     //we force the writting of an 'Item' Start Element
-    // because we want to write the Item as a 'no Length' item
+    // 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 != DocEntries.end();
                              ++it)
    {   
       // we skip delimitors (start and end one) because 
@@ -128,232 +84,234 @@ void SQItem::WriteContent(std::ofstream* fp, FileType filetype)
       // we just *always* ignore spurious fffe|0000 tag ! 
       if ( (*it)->GetGroup() == 0xfffe && (*it)->GetElement() == 0x0000 )
       {
-         break; // FIXME : continue; ?!?
+          break; // FIXME : break or continue; ?!?  
+                 // --> makes no difference since the only bugged file we have
+                 // contains 'impossible tag' fffe|0000 in last position !                            
       }
-
-      (*it)->WriteContent(fp, filetype);
+      // 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)
    {
-      binary_write( *fp, itemt[j]);  // fffe e000 ffff ffff 
-   }
+      binary_write( *fp, itemt[j]);  // fffe e000 0000 0000
+   } 
 }
 
-//-----------------------------------------------------------------------------
-// Public
-/**
- * \brief   adds any Entry (Dicom Element) to the Sequence Item
- */
-bool SQItem::AddEntry(DocEntry* entry)
-{
-   DocEntries.push_back(entry);
-   //TODO : check if it worked
-   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   Compute the full length of the SQItem (not only value length)
+ *           depending on the VR.
  */
-
-bool SQItem::SetEntryByNumber(std::string const & val, uint16_t group, 
-                              uint16_t element)
+uint32_t SQItem::ComputeFullLength()
 {
-   for(ListDocEntry::iterator i = DocEntries.begin(); 
-                              i != DocEntries.end(); 
-                            ++i)
-   { 
-      if ( (*i)->GetGroup() == 0xfffe && (*i)->GetElement() == 0xe000 ) 
+   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;  
+}
 
-      if (  ( group   < (*i)->GetGroup() )
-          ||( group == (*i)->GetGroup() && element < (*i)->GetElement()) )
-      {
-         // instead of ReplaceOrCreateByNumber 
-         // 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
-            Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
-            // if the invoked (group,elem) doesn't exist inside the Dictionary
-            // we create a VirtualDictEntry
-            DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, element);
-            if (dictEntry == NULL)
-            {
-               dictEntry = 
-                  Global::GetDicts()->NewVirtualDictEntry(group, element,
-                                                          "UN", "??", "??");
-            } 
-            // we assume the constructor didn't fail
-            entry = new ValEntry(dictEntry);
-            /// \todo
-            /// ----
-            /// better we don't assume too much !
-            /// SQItem is now used to describe any DICOMDIR related object
-         }
-         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);
+/**
+ * \brief   Inserts *in the right place* any Entry (Dicom Element)
+ *          into the Sequence Item
+ * @param entry Entry to add
+ * @return always true 
+ */
+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--;
 
-         return true;
-      }   
-      if (group == (*i)->GetGroup() && element == (*i)->GetElement() )
+      if ( (*it)->IsItemDelimitor() )
       {
-         if ( ValEntry* entry = dynamic_cast<ValEntry*>(*i) )
-         {
-            entry->SetValue(val);
-         }
-         (*i)->SetLength(val.length()); 
-         return true;    
+         continue;
       }
-   }
-   return false;
-}
+      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   Clear the hash table from given entry AND delete the entry.
+ * \brief   Clear the std::list 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
+ * @return true if the entry was found and removed; false otherwise
  */
-bool SQItem::RemoveEntry( DocEntry* entryToRemove)
+bool SQItem::RemoveEntry( DocEntry *entryToRemove )
 {
    for(ListDocEntry::iterator it = DocEntries.begin();
-       it != DocEntries.end();
-       ++it)
+                              it != DocEntries.end();
+                            ++it)
    {
-      if( *it == entryToRemove)
+      if ( *it == entryToRemove )
       {
          DocEntries.erase(it);
-         dbg.Verbose(0, "SQItem::RemoveEntry: one element erased.");
-         delete entryToRemove;
+         gdcmDebugMacro( "One element erased: " << entryToRemove->GetKey() );
+         entryToRemove->Unregister();
          return true;
       }
    }
-                                                                                
-   dbg.Verbose(0, "SQItem::RemoveEntry: value not present ");
+   gdcmWarningMacro( "Entry not found: " << entryToRemove->GetKey() );
    return false ;
 }
-                                                                                
+
 /**
- * \brief   Clear the hash table from given entry BUT keep the entry.
- * @param   entryToRemove Entry to remove.
+ * \brief  Remove all entry in the Sequence Item 
  */
-bool SQItem::RemoveEntryNoDestroy(DocEntry* entryToRemove)
+void SQItem::ClearEntry()
 {
-   for(ListDocEntry::iterator it = DocEntries.begin();
-       it != DocEntries.end();
-       ++it)
+   for(ListDocEntry::iterator cc = DocEntries.begin();
+                              cc != DocEntries.end();
+                            ++cc)
    {
-      if( *it == entryToRemove)
-      {
-         DocEntries.erase(it);
-         dbg.Verbose(0, "SQItem::RemoveEntry: one element erased.");
-         return true;
-      }
+      (*cc)->Unregister();
    }
-                                                                                
-   dbg.Verbose(0, "SQItem::RemoveEntry: value not present ");
-   return false ;
+   DocEntries.clear();
 }
-                                                                                
+
 /**
- * \brief   Initialise the visit of the chained list
+ * \brief   Get the first Dicom entry while visiting the SQItem
+ * \return  The first DocEntry if found, otherwhise 0
  */
-void SQItem::Initialize()
+DocEntry *SQItem::GetFirstEntry()
 {
    ItDocEntries = DocEntries.begin();
+   if ( ItDocEntries != DocEntries.end() )
+      return *ItDocEntries;
+   return 0;   
 }
                                                                                 
 /**
- * \brief   Get the next entry whil visiting the chained list
+ * \brief   Get the next Dicom entry while visiting the SQItem
  * \return  The next DocEntry if found, otherwhise NULL
  */
 DocEntry *SQItem::GetNextEntry()
 {
-   if (ItDocEntries != DocEntries.end())
-   {
-      DocEntry *tmp = *ItDocEntries;
-      ++ItDocEntries;
-                                                                                
-      return(tmp);
-   }
-   else
-   {
-      return(NULL);
-   }
+   ++ItDocEntries;
+   if ( ItDocEntries != DocEntries.end() )
+      return  *ItDocEntries;
+   return NULL;
 }
 
-//-----------------------------------------------------------------------------
-// Protected
 /**
- * \brief   Gets a Dicom Element inside a SQ Item Entry, by number
- * @return
+ * \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::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;
-      }
    }
-   return 0;
+   return NULL;
 }
 
 /**
- * \brief   Get the value of a Dicom Element inside a SQ Item Entry, by number
- * @return
- *
-
-std::string SQItem::GetEntryByNumber(uint16_t group, uint16_t element)
+ * \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)
 {
-   for(ListDocEntry::iterator i = DocEntries.begin();
-                              i != DocEntries.end(); ++i)
+   // Remove all previous entries
+   ClearEntry();
+
+   DocEntrySet::Copy(set);
+
+   SQItem *sq = dynamic_cast<SQItem *>(set);
+   if( sq )
    {
-      if ( (*i)->GetGroup() == group && (*i)->GetElement() == element)
-      {
-         return ((ValEntry *)(*i))->GetValue();   //FIXME
-      }
+      SQDepthLevel = sq->SQDepthLevel;
+      SQItemNumber = sq->SQItemNumber;
+
+      DocEntries = sq->DocEntries;
+      for(ItDocEntries = DocEntries.begin();ItDocEntries != DocEntries.end();++ItDocEntries)
+         (*ItDocEntries)->Register();
    }
-   return GDCM_UNFOUND;
 }
+
 //-----------------------------------------------------------------------------
-// Private
+// 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