]> Creatis software - gdcm.git/blobdiff - src/gdcmElementSet.cxx
The following methods
[gdcm.git] / src / gdcmElementSet.cxx
index e98a34462b713a6ef8a5b2e4bc71662397b22eb9..cf778c42745d9a3faf69fe42030045ee36070c5d 100644 (file)
-// gdcmElementSet.cxx
-//-----------------------------------------------------------------------------
-//
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmElementSet.cxx,v $
+  Language:  C++
+  Date:      $Date: 2005/01/20 11:37:37 $
+  Version:   $Revision: 1.47 $
+                                                                                
+  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.html for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
 #include "gdcmElementSet.h"
 #include "gdcmDebug.h"
+#include "gdcmValEntry.h"
+#include "gdcmBinEntry.h"
+#include "gdcmSeqEntry.h"
+
+namespace gdcm 
+{
 
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup gdcmElementSet
- * \brief   Constructor from a given gdcmElementSet
+ * \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
  * \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;  // TODO : a verifier
+      if ( cc->second )
+      {
+         delete cc->second;
+      }
    }
-   tagHT.clear();
+   TagHT.clear();
 }
 
-
 //-----------------------------------------------------------------------------
-// Public
+// Print
+/**
+  * \brief   Prints the Header Entries (Dicom Elements)
+  *          from the H Table
+  * @param os ostream to write to  
+  * @param indent Indentation string to be prepended during printing
+  */ 
+void ElementSet::Print(std::ostream &os, std::string const & )
+{
+   for( TagDocEntryHT::const_iterator i = TagHT.begin(); i != TagHT.end(); ++i)
+   {
+      DocEntry* entry = i->second;
+
+      entry->SetPrintLevel(PrintLevel);
+      entry->Print(os);   
 
+      if ( dynamic_cast<SeqEntry*>(entry) )
+      {
+         // Avoid the newline for a sequence:
+         continue;
+      }
+      os << std::endl;
+   }
+}
 
 //-----------------------------------------------------------------------------
-// Print
+// Public
 /**
-  * \brief   Prints the Header Entries (Dicom Elements)
+  * \brief   Writes the Header Entries (Dicom Elements)
   *          from the H Table
-  * @return
+  * @param fp ofstream to write to  
+  * @param filetype filetype
   */ 
-void gdcmElementSet::Print(std::ostream & os) {
-   for (TagDocEntryHT::iterator i = tagHT.begin(); i != tagHT.end(); ++i)  
+void ElementSet::WriteContent(std::ofstream *fp, FileType filetype)
+{
+   for (TagDocEntryHT::const_iterator i = TagHT.begin(); 
+                                     i != TagHT.end(); 
+                                    ++i)
    {
-      //(*i)->second->SetPrintLevel(printLevel);
-      (i->second)->Print(os);   
+      i->second->WriteContent(fp, filetype);
    } 
 }
 
 
-//-----------------------------------------------------------------------------
-// Protected
+/**
+ * \brief  retrieves a Dicom Element using (group, element)
+ * @param   group  Group number of the searched Dicom Element 
+ * @param   elem Element number of the searched Dicom Element 
+ * @return  
+ */
+DocEntry *ElementSet::GetDocEntry(uint16_t group, uint16_t elem) 
+{
+   TagKey key = DictEntry::TranslateToKey(group, elem);
+   if ( !TagHT.count(key))
+   {
+      return NULL;
+   }
+   return TagHT.find(key)->second;
+}
+
+/**
+ * \brief  Same as \ref Document::GetDocEntry except it only
+ *         returns a result when the corresponding entry is of type
+ *         ValEntry.
+ * @param   group  Group number of the searched Dicom Element 
+ * @param   elem Element number of the searched Dicom Element  
+ * @return When present, the corresponding ValEntry. 
+ */
+ValEntry *ElementSet::GetValEntry(uint16_t group, uint16_t elem)
+{
+   DocEntry *currentEntry = GetDocEntry(group, elem);
+   if ( !currentEntry )
+   {
+      return 0;
+   }
+   if ( ValEntry *entry = dynamic_cast<ValEntry*>(currentEntry) )
+   {
+      return entry;
+   }
+   gdcmVerboseMacro( "Unfound ValEntry.");
+
+   return 0;
+}
+
+/**
+ * \brief  Same as \ref Document::GetDocEntry except it only
+ *         returns a result when the corresponding entry is of type
+ *         BinEntry.
+ * @param   group  Group number of the searched Dicom Element 
+ * @param   elem Element number of the searched Dicom Element  
+ * @return When present, the corresponding BinEntry. 
+ */
+BinEntry *ElementSet::GetBinEntry(uint16_t group, uint16_t elem)
+{
+   DocEntry *currentEntry = GetDocEntry(group, elem);
+   if ( !currentEntry )
+   {
+      return 0;
+   }
+   if ( BinEntry *entry = dynamic_cast<BinEntry*>(currentEntry) )
+   {
+      return entry;
+   }
+   gdcmVerboseMacro( "Unfound BinEntry.");
+
+   return 0;
+}
+
+/**
+ * \brief  Same as \ref Document::GetDocEntry except it only
+ *         returns a result when the corresponding entry is of type
+ *         SeqEntry.
+ * @param   group  Group number of the searched Dicom Element 
+ * @param   elem Element number of the searched Dicom Element  
+ * @return When present, the corresponding SeqEntry. 
+ */
+SeqEntry *ElementSet::GetSeqEntry(uint16_t group, uint16_t elem)
+{
+   DocEntry *currentEntry = GetDocEntry(group, elem);
+   if ( !currentEntry )
+   {
+      return 0;
+   }
+   if ( SeqEntry *entry = dynamic_cast<SeqEntry*>(currentEntry) )
+   {
+      return entry;
+   }
+   gdcmVerboseMacro( "Unfound SeqEntry.");
+
+   return 0;
+}
+
 
 //-----------------------------------------------------------------------------
+// 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: ",
-                  key.c_str());
-      return(false);
-   } 
-   else 
+      gdcmVerboseMacro( "Key already present: " << key.c_str());
+      return false;
+   }
+   else
+   {
+      TagHT.insert(TagDocEntryHT::value_type(newEntry->GetKey(), newEntry));
+      return true;
+   }
+}
+
+/**
+ * \brief   Clear the hash table from given entry AND delete the entry.
+ * @param   entryToRemove Entry to remove AND delete.
+ */
+bool ElementSet::RemoveEntry( DocEntry *entryToRemove)
+{
+   const TagKey &key = entryToRemove->GetKey();
+   if( TagHT.count(key) == 1 )
    {
-      tagHT[NewEntry->GetKey()] = NewEntry;
-      return(true);
-   }   
+      TagHT.erase(key);
+      //gdcmVerboseMacro( "One element erased.");
+      delete entryToRemove;
+      return true;
+   }
+
+   gdcmVerboseMacro( "Key not present");
+   return false ;
 }
 
 /**
- * \brief   Clear the hash table from given entry.
- * @param   EntryToRemove Entry to remove.
+ * \brief   Clear the hash table from given entry BUT keep the entry.
+ * @param   entryToRemove Entry to remove.
  */
-bool gdcmElementSet::RemoveEntry( gdcmDocEntry *EntryToRemove)
+bool ElementSet::RemoveEntryNoDestroy(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(1, "gdcmElementSet::RemoveEntry: one element erased.");
+      TagHT.erase(key);
+      //gdcmVerboseMacro( "One element erased.");
       return true;
    }
 
-   dbg.Verbose(0, "gdcmElementSet::RemoveEntry: key not present: ");
-   return(false);
+   gdcmVerboseMacro( "Key not present");
+   return false ;
+}
+
+/**
+ * \brief   Get the first entry while visiting the DocEntrySet
+ * \return  The first DocEntry if found, otherwhise NULL
+ */
+DocEntry *ElementSet::GetFirstEntry()
+{
+   ItTagHT = TagHT.begin();
+   if (ItTagHT != TagHT.end())
+      return  ItTagHT->second;
+   return NULL;
 }
+
+/**
+ * \brief   Get the next entry while visiting the Hash table (TagHT)
+ * \note : meaningfull only if GetFirstEntry already called 
+ * \return  The next DocEntry if found, otherwhise NULL
+ */
+DocEntry *ElementSet::GetNextEntry()
+{
+   gdcmAssertMacro (ItTagHT != TagHT.end());
+
+   ++ItTagHT;
+   if (ItTagHT != TagHT.end())
+      return  ItTagHT->second;
+   return NULL;
+}
+
+//-----------------------------------------------------------------------------
+} // end namespace gdcm