]> Creatis software - gdcm.git/blobdiff - src/gdcmSQItem.cxx
Coding Style + Doxygenation
[gdcm.git] / src / gdcmSQItem.cxx
index 02ac489c6d2636f36c68412775d147035342562b..9babd77f5ff34fde840ed5b022c0606722036fa7 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/06/19 23:51:04 $
-  Version:   $Revision: 1.10 $
+  Date:      $Date: 2005/01/06 20:03:28 $
+  Version:   $Revision: 1.45 $
   
   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) {
-   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();
 }
 
 //-----------------------------------------------------------------------------
@@ -54,33 +60,96 @@ gdcmSQItem::~gdcmSQItem()
 /*
  * \brief   canonical Printer
  */
- void gdcmSQItem::Print(std::ostream & os) {
+void SQItem::Print(std::ostream &os)
+{
    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() << "SQItemNumber " << 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(PrintLevel);
+      Entry->Print(os); 
+      if ( SeqEntry *seqEntry = dynamic_cast<SeqEntry*>(Entry) )
+      {
+         (void)seqEntry;  //not used
+         PrintEndLine = false;
+      }
+      if (PrintEndLine)
+      {
+         os << std::endl;
+      }
    } 
 }
 
+/*
+ * \ingroup SQItem
+ * \brief   canonical Writer
+ */
+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
+   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;
+      }
+
+      // 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;
 }   
@@ -93,146 +162,178 @@ bool gdcmSQItem::AddEntry(gdcmDocEntry *entry)
  * \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 of the searched tag.
- * @param   element Element of the searched tag.
+ * @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
  */
-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() )
+      }
+
+      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);
+
+         // 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", GDCM_UNKNOWN, GDCM_UNKNOWN);
+         } 
+         // we assume the constructor didn't fail
+         entry = new ValEntry(dictEntry);
+         if (entry)
          {
-            // 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");
+            entry->SetValue(val); 
          }
-         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 ( gdcmValEntry* Entry = dynamic_cast<gdcmValEntry*>(*i) )
-            Entry->SetValue(val);
-         (*i)->SetLength(val.length()); 
+         if ( ValEntry* entry = dynamic_cast<ValEntry*>(*i) )
+         {
+            entry->SetValue(val);
+         }
          return true;    
       }
    }
+   return false;
 }
-//-----------------------------------------------------------------------------
-// Protected
 
-//-----------------------------------------------------------------------------
-// Private
-
-// end-user intended : the guy *wants* to create his own SeQuence ?!?
-
-/// \brief to be written if really usefull
-gdcmDocEntry *gdcmSQItem::NewDocEntryByNumber(guint16 group,
-                                              guint16 element) {
-/// \todo TODO                           
-   gdcmDocEntry *a;
-   std::cout << " gdcmSQItem::NewDocEntryByNumber : TODO" <<std::endl; 
-   return a;                             
+/**
+ * \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 to be written if really usefull
-gdcmDocEntry *gdcmSQItem::NewDocEntryByName  (std::string Name) {
-/// \todo TODO                           
-   gdcmDocEntry *a;
-   std::cout << " gdcmSQItem::NewDocEntryByName : TODO" <<std::endl; 
-   return a;                                     
+                                                                                
+/**
+ * \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   Gets a Dicom Element inside a SQ Item Entry, by name
- * @return
+ * \brief   Initialise the visit of the chained list
  */
- gdcmDocEntry *gdcmSQItem::GetDocEntryByName(std::string name) {
-   gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();
-   gdcmDictEntry *dictEntry = (*PubDict).GetDictEntryByName(name);
-   if( dictEntry == NULL)
-      return NULL;
-   return GetDocEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement());      
+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
 /**
- * \ingroup gdcmSQItem
  * \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;
 }
 
 /**
- * \ingroup gdcmSQItem
  * \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();
+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;
 }
+//-----------------------------------------------------------------------------
+// Private
 
-/**
- * \ingroup gdcmSQItem
- * \brief   Get the value of a Dicom Element inside a SQ Item Entry, by name
- * @param   name : name of the searched element.
- * @return
- */ 
-
-std::string gdcmSQItem::GetEntryByName(TagName name)  {
-   gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();
-   gdcmDictEntry *dictEntry = (*PubDict).GetDictEntryByName(name); 
-
-   if( dictEntry == NULL)
-      return GDCM_UNFOUND;
-   return GetEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement()); 
-}
 
 //-----------------------------------------------------------------------------
+
+} // end namespace gdcm