]> Creatis software - gdcm.git/blobdiff - src/gdcmElementSet.cxx
Some normalizations :
[gdcm.git] / src / gdcmElementSet.cxx
index 4338de23255077c62743c683bae7ccc8643d784b..317c108f9b6df7f08104eaf262e6ee1e5e65866f 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmElementSet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/07 22:03:30 $
-  Version:   $Revision: 1.39 $
+  Date:      $Date: 2005/01/23 10:12:33 $
+  Version:   $Revision: 1.48 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -28,7 +28,6 @@ namespace gdcm
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup ElementSet
  * \brief   Constructor from a given ElementSet
  */
 //BOZ depthLevel is not usefull anymore
@@ -39,7 +38,6 @@ ElementSet::ElementSet(int depthLevel)
 }
 
 /**
- * \ingroup ElementSet
  * \brief   Canonical destructor.
  */
 ElementSet::~ElementSet() 
@@ -59,9 +57,10 @@ ElementSet::~ElementSet()
 /**
   * \brief   Prints the Header Entries (Dicom Elements)
   *          from the H Table
-  * @return
+  * @param os ostream to write to  
+  * @param indent Indentation string to be prepended during printing
   */ 
-void ElementSet::Print(std::ostream &os)
+void ElementSet::Print(std::ostream &os, std::string const & )
 {
    for( TagDocEntryHT::const_iterator i = TagHT.begin(); i != TagHT.end(); ++i)
    {
@@ -70,9 +69,8 @@ void ElementSet::Print(std::ostream &os)
       entry->SetPrintLevel(PrintLevel);
       entry->Print(os);   
 
-      if ( SeqEntry *seqEntry = dynamic_cast<SeqEntry*>(entry) )
+      if ( dynamic_cast<SeqEntry*>(entry) )
       {
-         (void)seqEntry;
          // Avoid the newline for a sequence:
          continue;
       }
@@ -85,7 +83,8 @@ void ElementSet::Print(std::ostream &os)
 /**
   * \brief   Writes the Header Entries (Dicom Elements)
   *          from the H Table
-  * @return
+  * @param fp ofstream to write to  
+  * @param filetype filetype
   */ 
 void ElementSet::WriteContent(std::ofstream *fp, FileType filetype)
 {
@@ -97,9 +96,131 @@ void ElementSet::WriteContent(std::ofstream *fp, FileType filetype)
    } 
 }
 
+/**
+ * \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
 
+/**
+ * \brief   Checks if a given Dicom Element exists within the H table
+ * @param   group   Group number of the searched Dicom Element 
+ * @param   elem  Element number of the searched Dicom Element 
+ * @return true is found
+ */
+bool ElementSet::CheckIfEntryExist(uint16_t group, uint16_t elem )
+{
+   const std::string &key = DictEntry::TranslateToKey(group, elem );
+   return TagHT.count(key) != 0;
+}
+
+/**
+ * \brief   Searches within Header Entries (Dicom Elements) parsed with 
+ *          the public and private dictionaries 
+ *          for the element value representation of a given tag.
+ * @param   group  Group number of the searched tag.
+ * @param   elem Element number of the searched tag.
+ * @return  Corresponding element value representation when it exists,
+ *          and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
+ */
+std::string ElementSet::GetEntry(uint16_t group, uint16_t elem)
+{
+   TagKey key = DictEntry::TranslateToKey(group, elem);
+   if ( !TagHT.count(key))
+   {
+      return GDCM_UNFOUND;
+   }
+
+   return ((ValEntry *)TagHT.find(key)->second)->GetValue();
+}
+
+
 //-----------------------------------------------------------------------------
 // Private
 
@@ -126,8 +247,6 @@ bool ElementSet::AddEntry(DocEntry *newEntry)
 /**
  * \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 ElementSet::RemoveEntry( DocEntry *entryToRemove)
 {
@@ -135,7 +254,7 @@ bool ElementSet::RemoveEntry( DocEntry *entryToRemove)
    if( TagHT.count(key) == 1 )
    {
       TagHT.erase(key);
-      gdcmVerboseMacro( "One element erased.");
+      //gdcmVerboseMacro( "One element erased.");
       delete entryToRemove;
       return true;
    }
@@ -154,7 +273,7 @@ bool ElementSet::RemoveEntryNoDestroy(DocEntry *entryToRemove)
    if( TagHT.count(key) == 1 )
    {
       TagHT.erase(key);
-      gdcmVerboseMacro( "One element erased.");
+      //gdcmVerboseMacro( "One element erased.");
       return true;
    }
 
@@ -163,31 +282,60 @@ bool ElementSet::RemoveEntryNoDestroy(DocEntry *entryToRemove)
 }
 
 /**
- * \brief   Initialise the visit of the Hash table (TagHT)
+ * \brief   Get the first entry while visiting the DocEntrySet
+ * \return  The first DocEntry if found, otherwhise NULL
  */
-void ElementSet::Initialize()
+DocEntry *ElementSet::GetFirstEntry()
 {
    ItTagHT = TagHT.begin();
+   if (ItTagHT != TagHT.end())
+      return  ItTagHT->second;
+   return NULL;
 }
 
 /**
- * \brief   Get the next entry whil visiting the Hash table (TagHT)
+ * \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())
-   {
-      DocEntry *tmp = ItTagHT->second;
-      ++ItTagHT;
+      return  ItTagHT->second;
+   return NULL;
+}
 
-      return(tmp);
-   }
-   else
-   {
-      return(NULL);
-   }
+
+/**
+ * \brief   Get the larst entry while visiting the DocEntrySet
+ * \return  The last DocEntry if found, otherwhise NULL
+ */
+DocEntry *ElementSet::GetLastEntry()
+{
+   ItTagHT = TagHT.end();
+   if ( ItTagHT != TagHT.begin() )
+      return  ItTagHT->second;
+   return NULL;
+}
+
+/**
+ * \brief   Get the previous entry while visiting the Hash table (TagHT)
+ * \note : meaningfull only if GetFirstEntry already called 
+ * \return  The previous DocEntry if found, otherwhise NULL
+ */
+DocEntry *ElementSet::GetPreviousEntry()
+{
+   gdcmAssertMacro (ItTagHT != TagHT.begin());
+
+   --ItTagHT;
+   if (ItTagHT != TagHT.begin())
+      return  ItTagHT->second;
+   return NULL;
 }
 
+
 //-----------------------------------------------------------------------------
 } // end namespace gdcm