]> Creatis software - gdcm.git/blobdiff - src/gdcmDocEntrySet.cxx
Fix mistypings
[gdcm.git] / src / gdcmDocEntrySet.cxx
index 8aa7966340a6fc8fb59629814f617f7379f56656..fbc4764e0dd81562365854a9326319b6eb4373ec 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/10/18 08:35:49 $
-  Version:   $Revision: 1.60 $
+  Date:      $Date: 2007/09/17 12:16:02 $
+  Version:   $Revision: 1.76 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #include "gdcmDataEntry.h"
 #include "gdcmVR.h"
 
-namespace gdcm 
+#if defined(__BORLANDC__)
+   #include <mem.h> // for memset
+#endif 
+
+namespace GDCM_NAME_SPACE 
 {
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
@@ -75,47 +79,11 @@ void *DocEntrySet::GetEntryBinArea(uint16_t group, uint16_t elem)
 }
 
 /**
- * \brief   Return the value of the DataEntry 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;
-
-   DataEntry *de = dynamic_cast<DataEntry *>(d);
-   if ( de )
-   {
-      if( de->IsNotLoaded() )
-         return GDCM_NOTLOADED;
-      if( de->IsUnfound() )
-         return GDCM_UNFOUND;
-      if( de->IsUnread() )
-         return GDCM_UNREAD;
-   }
-
-   if( Global::GetVR()->IsVROfStringRepresentable( de->GetVR() ) )
-      return de->GetString();
-   else
-   {
-      uint8_t *a = de->GetBinArea();
-      if( Util::IsCleanArea(a, de->GetLength()) )
-         return  Util::CreateCleanString(a, de->GetLength());
-   }
-   return GDCM_NOTASCII;
-}
-
-/**
- * \brief   Searches within Header Entries (Dicom Elements) parsed with 
- *          the public and private dictionaries 
+ * \brief   Searches within the DocEntrySet
  *          for the value length of a given tag..
  * @param   group  Group number of the searched tag.
  * @param   elem Element number of the searched tag.
- * @return  Corresponding element length; -2 if not found
+ * @return  Corresponding element length; -1 if not found
  */
 int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem)
 {
@@ -126,30 +94,8 @@ int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem)
 }
 
 /**
- * \brief   Searches within Header Entries (Dicom Elements) parsed with 
- *          the public [and private dictionaries] 
- *          for the element value representation of a given tag..
- *          Obtaining the VR (Value Representation) might be needed by caller
- *          to convert the string typed content to caller's native type 
- *          (think of C++ vs Python). The VR is actually of a higher level
- *          of semantics than just the native C++ type.
- * @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 DocEntrySet::GetEntryVR(uint16_t group, uint16_t elem)
-{
-   DocEntry *entry = GetDocEntry(group, elem);
-   if ( entry )
-      return entry->GetVR();
-   return GDCM_UNFOUND;
-}
-
-/**
- * \brief  Same as \ref Document::GetDocEntry except it only
- *         returns a result when the corresponding entry is of type
- *         DataEntry.
+ * \brief  Same as DocEntrySet::GetDocEntry except it returns a result 
+ *         only when the corresponding entry is of type DataEntry.
  * @param   group  Group number of the searched Dicom Element 
  * @param   elem Element number of the searched Dicom Element  
  * @return When present, the corresponding DataEntry. 
@@ -164,9 +110,8 @@ DataEntry *DocEntrySet::GetDataEntry(uint16_t group, uint16_t elem)
 }
 
 /**
- * \brief  Same as \ref Document::GetDocEntry except it only
- *         returns a result when the corresponding entry is of type
- *         SeqEntry.
+ * \brief  Same as DocEntrySet::GetDocEntry except it returns a result
+ *          only 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. 
@@ -175,18 +120,14 @@ SeqEntry *DocEntrySet::GetSeqEntry(uint16_t group, uint16_t elem)
 {
    DocEntry *currentEntry = GetDocEntry(group, elem);
    if ( !currentEntry )
-   {
-      gdcmWarningMacro( "No corresponding SeqEntry " << std::hex << group <<
-                        "," << elem);
       return NULL;
-   }
 
    return dynamic_cast<SeqEntry*>(currentEntry);
 }
 
 /**
  * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
- *          through it's (group, element) and modifies it's content with
+ *          through its (group, element) and modifies its content with
  *          the given value.
  * @param   content new value (string) to substitute with
  * @param   group  group number of the Dicom Element to modify
@@ -207,7 +148,7 @@ bool DocEntrySet::SetEntryString(std::string const &content,
 
 /**
  * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
- *          through it's (group, element) and modifies it's content with
+ *          through its (group, element) and modifies its content with
  *          the given value.
  * @param   content new value (void*  -> uint8_t*) to substitute with
  * @param   lgth new value length
@@ -230,7 +171,7 @@ bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth,
 
 /**
  * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
- *          and modifies it's content with the given value.
+ *          and modifies its content with the given value.
  * @param  content new value (string) to substitute with
  * @param  entry Entry to be modified
  */
@@ -246,7 +187,7 @@ bool DocEntrySet::SetEntryString(std::string const &content, DataEntry *entry)
 
 /**
  * \brief   Accesses an existing DataEntry (i.e. a Dicom Element)
- *          and modifies it's content with the given value.
+ *          and modifies its content with the given value.
  * @param   content new value (void*  -> uint8_t*) to substitute with
  * @param  entry Entry to be modified 
  * @param  lgth new value length
@@ -264,7 +205,7 @@ bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry)
 
 /**
  * \brief   Modifies the value of a given Doc Entry (Dicom Element)
- *          when it exists. Create it with the given value when unexistant.
+ *          when it exists. Creates it with the given value when unexistant.
  * @param   value (string) Value to be set
  * @param   group   Group number of the Entry 
  * @param   elem  Element number of the Entry
@@ -273,12 +214,12 @@ bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry)
  *          failed).
  */ 
 DataEntry *DocEntrySet::InsertEntryString(std::string const &value, 
-                                             uint16_t group, uint16_t elem,
-                                             TagName const &vr )
+                                          uint16_t group, uint16_t elem,
+                                          VRKey const &vr )
 {
    DataEntry *dataEntry = 0;
    DocEntry *currentEntry = GetDocEntry( group, elem );
-   
+   VRKey localVR = vr;
    if (currentEntry)
    {
       dataEntry = dynamic_cast<DataEntry *>(currentEntry);
@@ -298,19 +239,35 @@ DataEntry *DocEntrySet::InsertEntryString(std::string const &value,
          }
       }
    }
+  
+   else // the 'currentEntry' was not found
+   {
+      if ( vr == GDCM_VRUNKNOWN ) // user didn't specify a VR.
+                                  //  Probabely he trusts the Dicom Dict !
+      {
+          DictEntry *e = 
+            Global::GetDicts()->GetDefaultPubDict()->GetEntry(group, elem);
+          if ( e )
+          {
+             localVR = e->GetVR();  
+             e->Register(); // ?? JPRx
+         }
+      }
+   }
 
    // Create a new dataEntry if necessary
    if ( !dataEntry )
    {
-      dataEntry = NewDataEntry( group, elem, vr );
+      dataEntry = NewDataEntry( group, elem, localVR );
 
       if ( !AddEntry(dataEntry) )
       {
-         gdcmWarningMacro("AddEntry failed although this is a creation.");
-
-         delete dataEntry;
+         gdcmWarningMacro("AddEntry " << dataEntry->GetKey() 
+                 << " failed although this is a creation.");
+         dataEntry->Delete();
          return NULL;
       }
+      dataEntry->Delete(); // ?!? JPRx
    }
 
    // Set the dataEntry value
@@ -331,8 +288,8 @@ DataEntry *DocEntrySet::InsertEntryString(std::string const &value,
  *          failed).
  */
 DataEntry *DocEntrySet::InsertEntryBinArea(uint8_t *binArea, int lgth, 
-                                              uint16_t group, uint16_t elem,
-                                              TagName const &vr )
+                                           uint16_t group, uint16_t elem,
+                                           VRKey const &vr )
 {
    DataEntry *dataEntry = 0;
    DocEntry *currentEntry = GetDocEntry( group, elem );
@@ -366,10 +323,10 @@ DataEntry *DocEntrySet::InsertEntryBinArea(uint8_t *binArea, int lgth,
       if ( !AddEntry(dataEntry) )
       {
          gdcmWarningMacro( "AddEntry failed although this is a creation.");
-
-         delete dataEntry;
+         dataEntry->Delete();
          return NULL;
       }
+      dataEntry->Delete();
    }
 
    // Set the dataEntry value
@@ -390,16 +347,15 @@ DataEntry *DocEntrySet::InsertEntryBinArea(uint8_t *binArea, int lgth,
          delete[] tmpArea;
       }
    }
-
    return dataEntry;
 }  
 
 /**
- * \brief   Modifies the value of a given Doc Entry (Dicom Element)
- *          when it exists. Creates it when unexistant.
+ * \brief   Creates a new gdcm::SeqEntry and adds it to the current DocEntrySet.
+ *          (remove any existing entry with same group,elem)
  * @param   group   Group number of the Entry 
  * @param   elem  Element number of the Entry
- * \return  pointer to the modified/created SeqEntry (NULL when creation
+ * \return  pointer to the created SeqEntry (NULL when creation
  *          failed).
  */
 SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem)
@@ -421,8 +377,8 @@ SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem)
       {
          if (!RemoveEntry(currentEntry))
          {
-            gdcmWarningMacro( "Removal of previous DocEntry failed.");
-
+            gdcmWarningMacro( "Removal of previous DocEntry failed for ("
+               <<std::hex << group << "|" << elem <<")" );
             return NULL;
          }
       }
@@ -434,20 +390,21 @@ SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem)
 
       if ( !AddEntry(seqEntry) )
       {
-         gdcmWarningMacro( "AddEntry failed although this is a creation.");
-
-         delete seqEntry;
+         gdcmWarningMacro( "AddEntry failed although this is a creation for ("
+            <<std::hex << group << "|" << elem <<")" );
+         seqEntry->Delete();
          return NULL;
       }
+      seqEntry->Delete();
    }
-
-   // TODO : Find a trick to insert a SequenceDelimitationItem 
-   //       in the SeqEntry, at the end.
+   // Remark :
+   // SequenceDelimitationItem will be added at the end of the SeqEntry,
+   // at write time
    return seqEntry;
 } 
  
 /**
- * \brief   Checks if a given Dicom Element exists within the H table
+ * \brief   Checks if a given Dicom Element exists within the DocEntrySet
  * @param   group   Group number of the searched Dicom Element 
  * @param   elem  Element number of the searched Dicom Element 
  * @return true is found
@@ -457,66 +414,50 @@ bool DocEntrySet::CheckIfEntryExist(uint16_t group, uint16_t elem )
    return GetDocEntry(group,elem)!=NULL;
 }
 
+
 /**
- * \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.
+ * \brief   Build a new DataEntry from all the low level arguments. 
  * @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 
+ * \remarks The user of this method must destroy the DataEntry when unused
  */
-DataEntry *DocEntrySet::NewDataEntry(uint16_t group,uint16_t elem,
-                                   TagName const &vr) 
+DataEntry *DocEntrySet::NewDataEntry(uint16_t group, uint16_t elem,
+                                     VRKey const &vr) 
 {
-   DictEntry *dictEntry = GetDictEntry(group, elem, vr);
-   gdcmAssertMacro(dictEntry);
 
-   DataEntry *newEntry = new DataEntry(dictEntry);
+   DataEntry *newEntry = DataEntry::New(group, elem, vr);
    if (!newEntry) 
    {
-      gdcmWarningMacro( "Failed to allocate DataEntry");
+      gdcmWarningMacro( "Failed to allocate DataEntry for ("
+          <<std::hex << group << "|" << elem <<")" );
       return 0;
    }
    return newEntry;
 }
 
 /**
- * \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.
+ * \brief   Build a new SeqEntry from all the low level arguments. 
  * @param   group Group   number of the new Entry
  * @param   elem  Element number of the new Entry
+ * \remarks The user of this method must destroy the SeqEntry when unused
  */
 SeqEntry* DocEntrySet::NewSeqEntry(uint16_t group, uint16_t elem) 
 {
-   DictEntry *dictEntry = GetDictEntry(group, elem, "SQ");
-   gdcmAssertMacro(dictEntry);
+   //DictEntry *dictEntry = GetDictEntry(group, elem, "SQ");
 
-   SeqEntry *newEntry = new SeqEntry( dictEntry );
+   //SeqEntry *newEntry = SeqEntry::New( dictEntry );
+   SeqEntry *newEntry = SeqEntry::New( group, elem );
+   //dictEntry->Unregister(); // GetDictEntry register it
    if (!newEntry)
    {
-      gdcmWarningMacro( "Failed to allocate SeqEntry");
+      gdcmWarningMacro( "Failed to allocate SeqEntry for ("
+         <<std::hex << group << "|" << elem <<")" );
       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
 /**
@@ -527,10 +468,13 @@ DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group, uint16_t elem,
  * @param   group  Group number of the searched DictEntry
  * @param   elem Element number of the searched DictEntry
  * @return  Corresponding DictEntry when it exists, NULL otherwise.
+ * \remarks The returned DictEntry is registered when existing
  */
 DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem) 
 {
    DictEntry *found = 0;
+   /// \todo store the DefaultPubDict somwhere, in order not to access the HTable
+   ///       every time ! --> Done!
    Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
    if (!pubDict) 
    {
@@ -538,54 +482,13 @@ DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem)
    }
    else
    {
-      found = pubDict->GetEntry(group, elem);  
+      found = pubDict->GetEntry(group, elem);
+      if( found )
+         found->Register();
    }
    return found;
 }
 
-/**
- * \brief   Searches [both] the public [and the shadow dictionary (when they
- *          exist)] for the presence of the DictEntry with given
- *          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 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,
-                                     TagName const &vr)
-{
-   DictEntry *dictEntry = GetDictEntry(group,elem);
-   DictEntry *goodEntry = dictEntry;
-   std::string goodVR = vr;
-
-   if (elem == 0x0000) goodVR="UL";
-
-   if ( goodEntry )
-   {
-      if ( goodVR != goodEntry->GetVR()
-        && goodVR != GDCM_UNKNOWN )
-      {
-         goodEntry = NULL;
-      }
-   }
-
-   // Create a new virtual DictEntry if necessary
-   if (!goodEntry)
-   {
-      if (dictEntry)
-      {
-         goodEntry = NewVirtualDictEntry(group, elem, goodVR, "FIXME", 
-                                         dictEntry->GetName() );
-      }
-      else
-      {
-         goodEntry = NewVirtualDictEntry(group, elem, goodVR);
-      }
-   }
-   return goodEntry;
-}
-
 //-----------------------------------------------------------------------------
 // Private