]> Creatis software - gdcm.git/blobdiff - src/gdcmSQItem.cxx
methods ReplaceOrCreate renamed as Insert
[gdcm.git] / src / gdcmSQItem.cxx
index f64d2b141bb716bf93655cc6ec4f2392edaf7fd1..b63b376a44d153d512b895742fd5cb6f9be9c9b6 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/07 22:03:30 $
-  Version:   $Revision: 1.48 $
+  Date:      $Date: 2005/01/24 16:44:54 $
+  Version:   $Revision: 1.58 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -32,7 +32,6 @@ namespace gdcm
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup SQItem
  * \brief   Constructor from a given SQItem
  */
 SQItem::SQItem(int depthLevel ) 
@@ -59,8 +58,10 @@ SQItem::~SQItem()
 // 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)
+void SQItem::Print(std::ostream &os, std::string const &)
 {
    std::ostringstream s;
 
@@ -71,7 +72,7 @@ void SQItem::Print(std::ostream &os)
          s << "   | " ;
       }
    }
-   //std::cout << s.str() << " --- SQItem number " << SQItemNumber  << std::endl;
+   os << s.str() << " --- SQItem number " << SQItemNumber  << std::endl;
    for (ListDocEntry::iterator i  = DocEntries.begin();
                                i != DocEntries.end();
                              ++i)
@@ -82,9 +83,8 @@ void SQItem::Print(std::ostream &os)
       os << s.str();
       Entry->SetPrintLevel(PrintLevel);
       Entry->Print(os); 
-      if ( SeqEntry *seqEntry = dynamic_cast<SeqEntry*>(Entry) )
+      if ( dynamic_cast<SeqEntry*>(Entry) )
       {
-         (void)seqEntry;  //not used
          PrintEndLine = false;
       }
       if (PrintEndLine)
@@ -95,8 +95,9 @@ void SQItem::Print(std::ostream &os)
 }
 
 /*
- * \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)
 {
@@ -146,6 +147,7 @@ void SQItem::WriteContent(std::ofstream *fp, FileType filetype)
 // Public
 /**
  * \brief   adds any Entry (Dicom Element) to the Sequence Item
+ * @param entry Entry to add
  */
 bool SQItem::AddEntry(DocEntry *entry)
 {
@@ -162,13 +164,13 @@ bool SQItem::AddEntry(DocEntry *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 number of the searched tag.
- * @param   element Element number of the searched tag.
+ * @param   group  Group number of the searched tag.
+ * @param   elem Element number of the searched tag.
  * @return  true if element was found or created successfully
  */
 
-bool SQItem::SetEntryByNumber(std::string const &val, uint16_t group, 
-                              uint16_t element)
+bool SQItem::SetEntryValue(std::string const &val, uint16_t group, 
+                      uint16_t elem)
 {
    for(ListDocEntry::iterator i = DocEntries.begin(); 
                               i != DocEntries.end(); 
@@ -180,23 +182,23 @@ bool SQItem::SetEntryByNumber(std::string const &val, uint16_t group,
       }
 
       if (  ( group  < (*i)->GetGroup() )
-          ||( group == (*i)->GetGroup() && element < (*i)->GetElement()) )
+          ||( group == (*i)->GetGroup() && elem < (*i)->GetElement()) )
       {
-         // instead of ReplaceOrCreateByNumber 
-         // that is a method of Document :-( 
+         // instead of Insert, that is a method of Document :-( 
          ValEntry* entry = 0;
-         TagKey key = DictEntry::TranslateToKey(group, element);
+         TagKey key = DictEntry::TranslateToKey(group, elem);
 
-         // we assume a Public Dictionnary *is* loaded
+         // we assume a Public Dictionary *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);
+         DictEntry *dictEntry = pubDict->GetEntry(group, elem);
          if (dictEntry == NULL)
          {
             dictEntry = 
-               Global::GetDicts()->NewVirtualDictEntry(group, element,
-                                                       "UN", GDCM_UNKNOWN, GDCM_UNKNOWN);
+               Global::GetDicts()->NewVirtualDictEntry(group, elem,
+                                                       "UN", GDCM_UNKNOWN, 
+                                                        GDCM_UNKNOWN);
          } 
          // we assume the constructor didn't fail
          entry = new ValEntry(dictEntry);
@@ -208,9 +210,9 @@ bool SQItem::SetEntryByNumber(std::string const &val, uint16_t group,
 
          return true;
       }   
-      if (group == (*i)->GetGroup() && element == (*i)->GetElement() )
+      if (group == (*i)->GetGroup() && elem == (*i)->GetElement() )
       {
-         if ( ValEntryentry = dynamic_cast<ValEntry*>(*i) )
+         if ( ValEntry *entry = dynamic_cast<ValEntry*>(*i) )
          {
             entry->SetValue(val);
          }
@@ -221,10 +223,9 @@ bool SQItem::SetEntryByNumber(std::string const &val, uint16_t group,
 }
 
 /**
- * \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)
 {
@@ -235,18 +236,19 @@ bool SQItem::RemoveEntry( DocEntry* entryToRemove)
       if( *it == entryToRemove)
       {
          DocEntries.erase(it);
-         gdcmVerboseMacro( "One element erased.");
+         gdcmVerboseMacro( "One element erased: " << entryToRemove->GetKey() );
          delete entryToRemove;
          return true;
       }
    }
-   gdcmVerboseMacro( "Value not present.");
+   gdcmVerboseMacro( "Entry not found: " << entryToRemove->GetKey() );
    return false ;
 }
 
 /**
- * \brief   Clear the hash table from given entry BUT keep the entry.
+ * \brief   Clear the std::list from given entry BUT keep the entry.
  * @param   entryToRemove Entry to remove.
+ * @return true if the entry was found and removed; false otherwise
  */
 bool SQItem::RemoveEntryNoDestroy(DocEntry* entryToRemove)
 {
@@ -257,54 +259,57 @@ bool SQItem::RemoveEntryNoDestroy(DocEntry* entryToRemove)
       if( *it == entryToRemove)
       {
          DocEntries.erase(it);
-         gdcmVerboseMacro( "One element erased.");
+         gdcmVerboseMacro( "One element erased, no destroyed: "
+                            << entryToRemove->GetKey() );
          return true;
       }
    }
                                                                                 
-   gdcmVerboseMacro( "Value not present.");
+   gdcmVerboseMacro( "Entry not found:" << entryToRemove->GetKey() );
    return false ;
 }
                                                                                 
 /**
- * \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 chained list
  * \return  The next DocEntry if found, otherwhise NULL
  */
 DocEntry *SQItem::GetNextEntry()
 {
-   if (ItDocEntries != DocEntries.end())
+  // gdcmAssertMacro (ItDocEntries != DocEntries.end());
    {
-      DocEntry *tmp = *ItDocEntries;
       ++ItDocEntries;
-                                                                                
-      return(tmp);
-   }
-   else
-   {
-      return(NULL);
+      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)
    {
-      if ( (*i)->GetGroup() == group && (*i)->GetElement() == element )
+      if ( (*i)->GetGroup() == group && (*i)->GetElement() == elem )
       {
          return *i;
       }
@@ -313,18 +318,81 @@ DocEntry* SQItem::GetDocEntryByNumber(uint16_t group, uint16_t element)
 }
 
 /**
- * \brief   Get the value of 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
+ */
+ValEntry* SQItem::GetValEntry(uint16_t group, uint16_t elem)
+{
+   DocEntry *d = GetDocEntry(group, elem);
+   if ( ValEntry *e = dynamic_cast<ValEntry*>(d) )
+      return e;
+   return 0;
+}
+
+/**
+ * \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
+ */
+BinEntry* SQItem::GetBinEntry(uint16_t group, uint16_t elem)
+{
+   DocEntry *d = GetDocEntry(group, elem);
+   if ( BinEntry *e = dynamic_cast<BinEntry*>(d) )
+      return e;
+   return 0;
+}
+
+/**
+ * \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
+ */
+SeqEntry* SQItem::GetSeqEntry(uint16_t group, uint16_t elem)
+{
+   DocEntry *d = GetDocEntry(group, elem);
+   if ( SeqEntry *e = dynamic_cast<SeqEntry*>(d) )
+      return e;
+   return 0;
+}
+
+
+/**
+ * \brief   Get the value of a Dicom Element inside a SQ Item Entry
+ * \note : meaningfull only if the required entry is NEITHER a SeqEntry 
+ *                                                   NOR a BinEntry
+ * @param   group   Group number of the Entry
+ * @param   elem  Element number of the Entry 
+ * @return  'string value' of the entry whose (group,elem) was passed.
+ *           GDCM_UNFOUND if not found
  */ 
 
-std::string SQItem::GetEntryByNumber(uint16_t group, uint16_t element)
+std::string SQItem::GetEntryValue(uint16_t group, uint16_t elem)
 {
+
+/*
+   DocEntry *e = GetFirstEntry();
+   while (e)
+   {
+      if ( e->GetGroup() == group && e->GetElement() == elem)
+      {
+
+         if (ValEntry *ve = dynamic_cast<ValEntry*>(e))
+            return ve->GetValue();
+      }
+      e = GetNextEntry();
+   }   
+*/
    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 ((ValEntry *)(*i))->GetValue();   //FIXME
+         if (ValEntry *ve = dynamic_cast<ValEntry*>(*i))
+           return ve->GetValue();
       }
    }
    return GDCM_UNFOUND;