]> Creatis software - gdcm.git/blobdiff - src/gdcmElementSet.cxx
Coding Style + Doxygenation
[gdcm.git] / src / gdcmElementSet.cxx
index 18af6a70ac952a6dfe3980caadb950ab63ad0815..ef76254bd4c62f1d6f7d06518aab23f8f1acf821 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmElementSet.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/06/25 03:06:38 $
-  Version:   $Revision: 1.14 $
+  Date:      $Date: 2005/01/06 20:03:27 $
+  Version:   $Revision: 1.36 $
                                                                                 
   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 "gdcmSeqEntry.h"
 
+namespace gdcm 
+{
+
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup gdcmElementSet
- * \brief   Constructor from a given gdcmElementSet
+ * \ingroup ElementSet
+ * \brief   Constructor from a given ElementSet
  */
-gdcmElementSet::gdcmElementSet(int depthLevel) 
-              : gdcmDocEntrySet(depthLevel) {
+//BOZ depthLevel is not usefull anymore
+ElementSet::ElementSet(int depthLevel) 
+              : DocEntrySet()
+{
+  (void)depthLevel;
 }
 
 /**
- * \ingroup gdcmElementSet
+ * \ingroup ElementSet
  * \brief   Canonical destructor.
  */
-gdcmElementSet::~gdcmElementSet() 
+ElementSet::~ElementSet() 
 {
-  gdcmDocEntry* EntryToDelete;  
-  for(TagDocEntryHT::iterator cc = tagHT.begin();cc != tagHT.end();++cc)
+   for(TagDocEntryHT::iterator cc = TagHT.begin();cc != TagHT.end(); ++cc)
    {
-      EntryToDelete = cc->second;
-      if ( EntryToDelete )
-         delete EntryToDelete;
+      if ( cc->second )
+      {
+         delete cc->second;
+      }
    }
-   tagHT.clear();
+   TagHT.clear();
 }
 
-
-//-----------------------------------------------------------------------------
-// Public
-
-
 //-----------------------------------------------------------------------------
 // Print
 /**
@@ -60,80 +61,134 @@ gdcmElementSet::~gdcmElementSet()
   *          from the H Table
   * @return
   */ 
-void gdcmElementSet::Print(std::ostream & os)
+void ElementSet::Print(std::ostream &os)
 {
-   gdcmDocEntry* Entry;
-   for (TagDocEntryHT::iterator i = tagHT.begin(); i != tagHT.end(); ++i)  
+   for( TagDocEntryHT::const_iterator i = TagHT.begin(); i != TagHT.end(); ++i)
    {
-      Entry = i->second;
-      Entry->Print(os);   
-      bool PrintEndLine = true;
-      if ( gdcmSeqEntry* SeqEntry = dynamic_cast<gdcmSeqEntry*>(Entry) )
+      DocEntry* entry = i->second;
+
+      entry->SetPrintLevel(PrintLevel);
+      entry->Print(os);   
+
+      if ( SeqEntry *seqEntry = dynamic_cast<SeqEntry*>(entry) )
       {
-         (void)SeqEntry;  //not used
-         PrintEndLine = false;
+         (void)seqEntry;
+         // Avoid the newline for a sequence:
+         continue;
       }
-      if (PrintEndLine)
-         os << std::endl;
-   } 
+      os << std::endl;
+   }
 }
 
+//-----------------------------------------------------------------------------
+// Public
 /**
   * \brief   Writes the Header Entries (Dicom Elements)
   *          from the H Table
   * @return
   */ 
-void gdcmElementSet::Write(FILE *fp, FileType filetype)
+void ElementSet::WriteContent(std::ofstream *fp, FileType filetype)
 {
-
-   for (TagDocEntryHT::iterator i = tagHT.begin(); i != tagHT.end(); ++i)  
+   for (TagDocEntryHT::const_iterator i = TagHT.begin(); 
+                                     i != TagHT.end(); 
+                                    ++i)
    {
-      i->second->Write(fp, filetype);
+      i->second->WriteContent(fp, filetype);
    } 
 }
-//-----------------------------------------------------------------------------
-// Protected
 
 //-----------------------------------------------------------------------------
+// Protected
 
 //-----------------------------------------------------------------------------
 // Private
 
 /**
  * \brief   add a new Dicom Element pointer to the H Table
- * @param   NewEntry entry to add
+ * @param   newEntry entry to add
  */
-bool gdcmElementSet::AddEntry( gdcmDocEntry *NewEntry) {
-   TagKey key;
-   key = NewEntry->GetKey();
+bool ElementSet::AddEntry(DocEntry *newEntry)
+{
+   const TagKey &key = newEntry->GetKey();
 
-   if(tagHT.count(key) == 1)
+   if( TagHT.count(key) == 1 )
    {
-      dbg.Verbose(1, "gdcmElementSet::AddEntry key already present: ",
+      dbg.Verbose(1, "ElementSet::AddEntry key already present: ",
                   key.c_str());
-      return(false);
-   } 
-   else 
+      return false;
+   }
+   else
    {
-      tagHT[NewEntry->GetKey()] = NewEntry;
-      return(true);
-   }   
+      TagHT.insert(TagDocEntryHT::value_type(newEntry->GetKey(), newEntry));
+      return true;
+   }
 }
 
 /**
- * \brief   Clear the hash table from given entry.
- * @param   EntryToRemove Entry to remove.
+ * \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 gdcmElementSet::RemoveEntry( gdcmDocEntry *EntryToRemove)
+bool ElementSet::RemoveEntry( DocEntry *entryToRemove)
 {
-   TagKey key = EntryToRemove->GetKey();
-   if(tagHT.count(key) == 1)
+   const TagKey &key = entryToRemove->GetKey();
+   if( TagHT.count(key) == 1 )
    {
-      tagHT.erase(key);
-      dbg.Verbose(0, "gdcmElementSet::RemoveEntry: one element erased.");
+      TagHT.erase(key);
+      dbg.Verbose(0, "ElementSet::RemoveEntry: one element erased.");
+      delete entryToRemove;
       return true;
    }
 
-   dbg.Verbose(0, "gdcmElementSet::RemoveEntry: key not present: ");
-   return(false);
+   dbg.Verbose(0, "ElementSet::RemoveEntry: key not present");
+   return false ;
 }
+
+/**
+ * \brief   Clear the hash table from given entry BUT keep the entry.
+ * @param   entryToRemove Entry to remove.
+ */
+bool ElementSet::RemoveEntryNoDestroy(DocEntry *entryToRemove)
+{
+   const TagKey &key = entryToRemove->GetKey();
+   if( TagHT.count(key) == 1 )
+   {
+      TagHT.erase(key);
+      dbg.Verbose(0, "ElementSet::RemoveEntry: one element erased.");
+      return true;
+   }
+
+   dbg.Verbose(0, "ElementSet::RemoveEntry: key not present");
+   return false ;
+}
+
+/**
+ * \brief   Initialise the visit of the Hash table (TagHT)
+ */
+void ElementSet::Initialize()
+{
+   ItTagHT = TagHT.begin();
+}
+
+/**
+ * \brief   Get the next entry whil visiting the Hash table (TagHT)
+ * \return  The next DocEntry if found, otherwhise NULL
+ */
+DocEntry *ElementSet::GetNextEntry()
+{
+   if (ItTagHT != TagHT.end())
+   {
+      DocEntry *tmp = ItTagHT->second;
+      ++ItTagHT;
+
+      return(tmp);
+   }
+   else
+   {
+      return(NULL);
+   }
+}
+
+//-----------------------------------------------------------------------------
+} // end namespace gdcm