]> Creatis software - gdcm.git/blobdiff - src/gdcmDocEntrySet.cxx
Fix bug in Orientation::VerfCriterion
[gdcm.git] / src / gdcmDocEntrySet.cxx
index 9f4d7c421f19d071010da68f8b989db31eecd100..a054d86e7f990360c22b91aa1d123403f9bdb4fc 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/02/02 10:02:17 $
-  Version:   $Revision: 1.51 $
+  Date:      $Date: 2005/09/06 15:28:49 $
+  Version:   $Revision: 1.59 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #include "gdcmSeqEntry.h"
 #include "gdcmValEntry.h"
 #include "gdcmBinEntry.h"
+#include "gdcmUtil.h"
 
 namespace gdcm 
 {
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
-
+DocEntrySet::DocEntrySet() 
+{ 
+   PreviousDocEntry = 0;
+}
 //-----------------------------------------------------------------------------
 // Public
 /**
@@ -38,12 +42,12 @@ namespace gdcm
  * @param   group  Group number of the searched tag.
  * @param   elem Element number of the searched tag.
  * @return  Corresponding element value when it exists,
- *          and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
+ *          and the string GDCM_UNFOUND otherwise.
  */
 std::string DocEntrySet::GetEntryValue(uint16_t group, uint16_t elem)
 {
    ContentEntry *entry = dynamic_cast<ContentEntry *>(GetDocEntry(group,elem));
-   if( entry )
+   if ( entry )
       return entry->GetValue();
    return GDCM_UNFOUND;
 }
@@ -57,11 +61,39 @@ std::string DocEntrySet::GetEntryValue(uint16_t group, uint16_t elem)
 void *DocEntrySet::GetEntryBinArea(uint16_t group, uint16_t elem) 
 {
    BinEntry *entry = GetBinEntry(group, elem);
-   if( entry )
+   if ( entry )
       return entry->GetBinArea();
    return 0;
 }
 
+/**
+ * \brief   Return the value of the BinEntry if it's "std::string representable"
+ * @param   group  Group number of the searched tag.
+ * @param   elem Element number of the searched tag.
+ * @return  Corresponding element value when it's "std::string representable"
+ *          and the string GDCM_NOTASCII otherwise.
+ */
+std::string DocEntrySet::GetEntryForcedAsciiValue(uint16_t group, uint16_t elem)
+{
+   DocEntry *d = GetDocEntry(group,elem);
+   if ( !d )
+      return GDCM_UNFOUND;
+
+   if (ValEntry *v = dynamic_cast<ValEntry *>(d))
+      return v->GetValue();
+
+   if (BinEntry *b = dynamic_cast<BinEntry *>(d))
+   {
+      uint8_t *a = b->GetBinArea();
+      if (!b)
+         return GDCM_NOTLOADED;
+         // TODO : unify those two methods.
+      if (Util::IsCleanArea(a, b->GetLength()) )
+         return  Util::CreateCleanString(a, b->GetLength());
+   }
+   return GDCM_NOTASCII;
+}
+
 /**
  * \brief   Searches within Header Entries (Dicom Elements) parsed with 
  *          the public and private dictionaries 
@@ -73,7 +105,7 @@ void *DocEntrySet::GetEntryBinArea(uint16_t group, uint16_t elem)
 int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem)
 {
    DocEntry *entry = GetDocEntry(group, elem);
-   if( entry )
+   if ( entry )
       return entry->GetLength();
    return -1;
 }
@@ -94,7 +126,7 @@ int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem)
 std::string DocEntrySet::GetEntryVR(uint16_t group, uint16_t elem)
 {
    DocEntry *entry = GetDocEntry(group, elem);
-   if( entry )
+   if ( entry )
       return entry->GetVR();
    return GDCM_UNFOUND;
 }
@@ -129,7 +161,7 @@ BinEntry *DocEntrySet::GetBinEntry(uint16_t group, uint16_t elem)
    DocEntry *currentEntry = GetDocEntry(group, elem);
    if ( !currentEntry )
    {
-      gdcmVerboseMacro( "No corresponding BinEntry " << std::hex << group <<
+      gdcmWarningMacro( "No corresponding BinEntry " << std::hex << group <<
                          "," << elem);
       return NULL;
    }
@@ -150,7 +182,7 @@ SeqEntry *DocEntrySet::GetSeqEntry(uint16_t group, uint16_t elem)
    DocEntry *currentEntry = GetDocEntry(group, elem);
    if ( !currentEntry )
    {
-      gdcmVerboseMacro( "No corresponding SeqEntry " << std::hex << group <<
+      gdcmWarningMacro( "No corresponding SeqEntry " << std::hex << group <<
                         "," << elem);
       return NULL;
    }
@@ -172,7 +204,7 @@ bool DocEntrySet::SetValEntry(std::string const &content,
    ValEntry *entry = GetValEntry(group, elem);
    if (!entry )
    {
-      gdcmVerboseMacro( "No corresponding ValEntry " << std::hex << group <<
+      gdcmWarningMacro( "No corresponding ValEntry " << std::hex << group <<
                          "," << elem << " element (try promotion first).");
       return false;
    }
@@ -194,7 +226,7 @@ bool DocEntrySet::SetBinEntry(uint8_t *content, int lgth,
    BinEntry *entry = GetBinEntry(group, elem);
    if (!entry )
    {
-      gdcmVerboseMacro( "No corresponding ValEntry " << std::hex << group <<
+      gdcmWarningMacro( "No corresponding ValEntry " << std::hex << group <<
                         "," << elem << " element (try promotion first).");
       return false;
    }
@@ -210,7 +242,7 @@ bool DocEntrySet::SetBinEntry(uint8_t *content, int lgth,
  */
 bool DocEntrySet::SetValEntry(std::string const &content, ValEntry *entry)
 {
-   if(entry)
+   if (entry)
    {
       entry->SetValue(content);
       return true;
@@ -227,7 +259,7 @@ bool DocEntrySet::SetValEntry(std::string const &content, ValEntry *entry)
  */
 bool DocEntrySet::SetBinEntry(uint8_t *content, int lgth, BinEntry *entry)
 {
-   if(entry)
+   if (entry)
    {
       entry->SetBinArea(content);  
       entry->SetLength(lgth);
@@ -252,23 +284,23 @@ ValEntry *DocEntrySet::InsertValEntry(std::string const &value,
                                       TagName const &vr )
 {
    ValEntry *valEntry = 0;
-   DocEntry *currentEntry = GetDocEntry( group, elem);
+   DocEntry *currentEntry = GetDocEntry( group, elem );
    
    if (currentEntry)
    {
       valEntry = dynamic_cast<ValEntry *>(currentEntry);
 
       // Verify the VR
-      if( valEntry )
-         if( valEntry->GetVR()!=vr )
+      if ( valEntry )
+         if ( valEntry->GetVR()!=vr )
             valEntry = NULL;
 
       // if currentEntry doesn't correspond to the requested valEntry
-      if( !valEntry)
+      if ( !valEntry)
       {
-         if( !RemoveEntry(currentEntry) )
+         if ( !RemoveEntry(currentEntry) )
          {
-            gdcmVerboseMacro( "Removal of previous DocEntry failed.");
+            gdcmWarningMacro( "Removal of previous DocEntry failed.");
 
             return NULL;
          }
@@ -276,13 +308,13 @@ ValEntry *DocEntrySet::InsertValEntry(std::string const &value,
    }
 
    // Create a new valEntry if necessary
-   if( !valEntry )
+   if ( !valEntry )
    {
-      valEntry = NewValEntry(group, elem, vr);
+      valEntry = NewValEntry( group, elem, vr );
 
       if ( !AddEntry(valEntry) )
       {
-         gdcmVerboseMacro("AddEntry failed although this is a creation.");
+         gdcmWarningMacro("AddEntry failed although this is a creation.");
 
          delete valEntry;
          return NULL;
@@ -294,11 +326,12 @@ ValEntry *DocEntrySet::InsertValEntry(std::string const &value,
    return valEntry;
 }
 
-/*
+/**
  * \brief   Modifies the value of a given Header Entry (Dicom Element)
  *          when it exists. Create it with the given value when unexistant.
  *          A copy of the binArea is made to be kept in the Document.
  * @param   binArea (binary) value to be set
+ * @param   lgth length of the Bin Area we want to set
  * @param   group   Group number of the Entry 
  * @param   elem  Element number of the Entry
  * @param   vr  V(alue) R(epresentation) of the Entry -if private Entry-
@@ -310,7 +343,7 @@ BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth,
                                       TagName const &vr )
 {
    BinEntry *binEntry = 0;
-   DocEntry *currentEntry = GetDocEntry( group, elem);
+   DocEntry *currentEntry = GetDocEntry( group, elem );
 
    // Verify the currentEntry
    if (currentEntry)
@@ -318,16 +351,16 @@ BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth,
       binEntry = dynamic_cast<BinEntry *>(currentEntry);
 
       // Verify the VR
-      if( binEntry )
-         if( binEntry->GetVR()!=vr )
+      if ( binEntry )
+         if ( binEntry->GetVR()!=vr )
             binEntry = NULL;
 
       // if currentEntry doesn't correspond to the requested valEntry
-      if( !binEntry)
+      if ( !binEntry)
       {
-         if( !RemoveEntry(currentEntry) )
+         if ( !RemoveEntry(currentEntry) )
          {
-            gdcmVerboseMacro( "Removal of previous DocEntry failed.");
+            gdcmWarningMacro( "Removal of previous DocEntry failed.");
 
             return NULL;
          }
@@ -335,13 +368,13 @@ BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth,
    }
 
    // Create a new binEntry if necessary
-   if( !binEntry)
+   if ( !binEntry)
    {
       binEntry = NewBinEntry(group, elem, vr);
 
       if ( !AddEntry(binEntry) )
       {
-         gdcmVerboseMacro( "AddEntry failed allthough this is a creation.");
+         gdcmWarningMacro( "AddEntry failed although this is a creation.");
 
          delete binEntry;
          return NULL;
@@ -350,7 +383,7 @@ BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth,
 
    // Set the binEntry value
    uint8_t *tmpArea;
-   if( lgth>0 && binArea )
+   if ( lgth>0 && binArea )
    {
       tmpArea = new uint8_t[lgth];
       memcpy(tmpArea,binArea,lgth);
@@ -359,9 +392,9 @@ BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth,
    {
       tmpArea = 0;
    }
-   if( !SetBinEntry(tmpArea,lgth,binEntry) )
+   if ( !SetBinEntry(tmpArea,lgth,binEntry) )
    {
-      if( tmpArea )
+      if ( tmpArea )
       {
          delete[] tmpArea;
       }
@@ -370,8 +403,8 @@ BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth,
    return binEntry;
 }  
 
-/*
- * \brief   Modifies the value of a given Header Entry (Dicom Element)
+/**
+ * \brief   Modifies the value of a given Doc Entry (Dicom Element)
  *          when it exists. Creates it when unexistant.
  * @param   group   Group number of the Entry 
  * @param   elem  Element number of the Entry
@@ -381,42 +414,44 @@ BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth,
 SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem)
 {
    SeqEntry *seqEntry = 0;
-   DocEntry *currentEntry = GetDocEntry( group, elem);
+   DocEntry *currentEntry = GetDocEntry( group, elem );
 
    // Verify the currentEntry
-   if( currentEntry )
+   if ( currentEntry )
    {
       seqEntry = dynamic_cast<SeqEntry *>(currentEntry);
 
       // Verify the VR
-      if( seqEntry )
-         if( seqEntry->GetVR()!="SQ" )
-            seqEntry = NULL;
+      if ( seqEntry )
+         seqEntry = NULL;
 
-      // if currentEntry doesn't correspond to the requested valEntry
-      if( !seqEntry )
+      // if currentEntry doesn't correspond to the requested seqEntry
+      if ( !seqEntry )
       {
          if (!RemoveEntry(currentEntry))
          {
-            gdcmVerboseMacro( "Removal of previous DocEntry failed.");
+            gdcmWarningMacro( "Removal of previous DocEntry failed.");
 
             return NULL;
          }
       }
    }
    // Create a new seqEntry if necessary
-   if( !seqEntry )
+   if ( !seqEntry )
    {
       seqEntry = NewSeqEntry(group, elem);
 
-      if( !AddEntry(seqEntry) )
+      if ( !AddEntry(seqEntry) )
       {
-         gdcmVerboseMacro( "AddEntry failed allthough this is a creation.");
+         gdcmWarningMacro( "AddEntry failed although this is a creation.");
 
          delete seqEntry;
          return NULL;
       }
    }
+
+   // TODO : Find a trick to insert a SequenceDelimitationItem 
+   //       in the SeqEntry, at the end.
    return seqEntry;
 } 
  
@@ -431,32 +466,16 @@ bool DocEntrySet::CheckIfEntryExist(uint16_t group, uint16_t elem )
    return GetDocEntry(group,elem)!=NULL;
 }
 
-/**
- * \brief   Request a new virtual dict entry to the dict set
- * @param   group group  number of the underlying DictEntry
- * @param   elem  element number of the underlying DictEntry
- * @param   vr    VR (Value Representation) of the underlying DictEntry
- * @param   vm    VM (Value Multiplicity)   of the underlying DictEntry
- * @param   name   english name
- */
-DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group,uint16_t elem,
-                                             TagName const & vr,
-                                             TagName const & vm,
-                                             TagName const & name )
-{
-   return Global::GetDicts()->NewVirtualDictEntry(group,elem,vr,vm,name);
-}
-
 /**
  * \brief   Build a new Val Entry from all the low level arguments. 
  *          Check for existence of dictionary entry, and build
  *          a default one when absent.
- * @param   group group   number of the new Entry
- * @param   elem  element number of the new Entry
- * @param   vr     VR of the new Entry 
+ * @param   group Group number   of the new Entry
+ * @param   elem  Element number of the new Entry
+ * @param   vr    V(alue) R(epresentation) of the new Entry 
  */
 ValEntry *DocEntrySet::NewValEntry(uint16_t group,uint16_t elem,
-                                   TagName const & vr) 
+                                   TagName const &vr) 
 {
    DictEntry *dictEntry = GetDictEntry(group, elem, vr);
    gdcmAssertMacro(dictEntry);
@@ -464,7 +483,7 @@ ValEntry *DocEntrySet::NewValEntry(uint16_t group,uint16_t elem,
    ValEntry *newEntry = new ValEntry(dictEntry);
    if (!newEntry) 
    {
-      gdcmVerboseMacro( "Failed to allocate ValEntry");
+      gdcmWarningMacro( "Failed to allocate ValEntry");
       return 0;
    }
    return newEntry;
@@ -475,9 +494,9 @@ ValEntry *DocEntrySet::NewValEntry(uint16_t group,uint16_t elem,
  * \brief   Build a new Bin Entry from all the low level arguments. 
  *          Check for existence of dictionary entry, and build
  *          a default one when absent.
- * @param   group group   number of the new Entry
- * @param   elem  element number of the new Entry
- * @param   vr     VR of the new Entry 
+ * @param   group Group   number of the new Entry
+ * @param   elem  Element number of the new Entry
+ * @param   vr    V(alue) R(epresentation) of the new Entry 
  */
 BinEntry *DocEntrySet::NewBinEntry(uint16_t group, uint16_t elem,
                                    TagName const &vr) 
@@ -488,7 +507,7 @@ BinEntry *DocEntrySet::NewBinEntry(uint16_t group, uint16_t elem,
    BinEntry *newEntry = new BinEntry(dictEntry);
    if (!newEntry) 
    {
-      gdcmVerboseMacro( "Failed to allocate BinEntry");
+      gdcmWarningMacro( "Failed to allocate BinEntry");
       return 0;
    }
    return newEntry;
@@ -498,8 +517,8 @@ BinEntry *DocEntrySet::NewBinEntry(uint16_t group, uint16_t elem,
  * \brief   Build a new Seq Entry from all the low level arguments. 
  *          Check for existence of dictionary entry, and build
  *          a default one when absent.
- * @param   group group   number of the new Entry
- * @param   elem  element number of the new Entry
+ * @param   group Group   number of the new Entry
+ * @param   elem  Element number of the new Entry
  */
 SeqEntry* DocEntrySet::NewSeqEntry(uint16_t group, uint16_t elem) 
 {
@@ -509,21 +528,37 @@ SeqEntry* DocEntrySet::NewSeqEntry(uint16_t group, uint16_t elem)
    SeqEntry *newEntry = new SeqEntry( dictEntry );
    if (!newEntry)
    {
-      gdcmVerboseMacro( "Failed to allocate SeqEntry");
+      gdcmWarningMacro( "Failed to allocate SeqEntry");
       return 0;
    }
    return newEntry;
 }
 
+/**
+ * \brief   Request a new virtual dict entry to the dict set
+ * @param   group Group   number of the underlying DictEntry
+ * @param   elem  Element number of the underlying DictEntry
+ * @param   vr    V(alue) R(epresentation) of the underlying DictEntry
+ * @param   vm    V(alue) M(ultiplicity)   of the underlying DictEntry
+ * @param   name   english name
+ */
+DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group, uint16_t elem,
+                                             TagName const &vr,
+                                             TagName const &vm,
+                                             TagName const &name )
+{
+   return Global::GetDicts()->NewVirtualDictEntry(group,elem,vr,vm,name);
+}
+
 //-----------------------------------------------------------------------------
 // Protected
 /**
  * \brief   Searches [both] the public [and the shadow dictionary (when they
  *          exist)] for the presence of the DictEntry with given
  *          group and element. The public dictionary has precedence on the
- *          shadow one.
- * @param   group  group number of the searched DictEntry
- * @param   elem element number of the searched DictEntry
+ *          shadow one(s), if any.
+ * @param   group  Group number of the searched DictEntry
+ * @param   elem Element number of the searched DictEntry
  * @return  Corresponding DictEntry when it exists, NULL otherwise.
  */
 DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem) 
@@ -532,7 +567,7 @@ DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem)
    Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
    if (!pubDict) 
    {
-      gdcmVerboseMacro( "We SHOULD have a default dictionary");
+      gdcmWarningMacro( "We SHOULD have a default dictionary");
    }
    else
    {
@@ -547,7 +582,7 @@ DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem)
  *          group and element, and create a new virtual DictEntry if necessary
  * @param   group  group number of the searched DictEntry
  * @param   elem element number of the searched DictEntry
- * @param   vr Value Representation to use, if necessary 
+ * @param   vr V(alue) R(epresentation) to use, if necessary 
  * @return  Corresponding DictEntry when it exists, NULL otherwise.
  */
 DictEntry *DocEntrySet::GetDictEntry(uint16_t group, uint16_t elem,