]> Creatis software - gdcm.git/blobdiff - src/gdcmDocEntrySet.cxx
ENH: NEW FEATURE: TagKey is now a union of two uint16_t instead of string this greatl...
[gdcm.git] / src / gdcmDocEntrySet.cxx
index 3ff3e607828479f313df832dad81e3381f1cbb8a..19b7d39d15e54d2e2a1eb1ebbe551642e6bc37d6 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/25 15:44:23 $
-  Version:   $Revision: 1.45 $
+  Date:      $Date: 2005/06/24 10:55:59 $
+  Version:   $Revision: 1.57 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 
 namespace gdcm 
 {
+//-----------------------------------------------------------------------------
+// Constructor / Destructor
 
 //-----------------------------------------------------------------------------
 // Public
 /**
- * \brief   Get the (std::string representable) value of the Dicom entry
+ * \brief   Get the "std::string representable" value of the Dicom entry
  * @param   group  Group number of the searched tag.
  * @param   elem Element number of the searched tag.
  * @return  Corresponding element value when it exists,
@@ -40,23 +42,22 @@ namespace gdcm
  */
 std::string DocEntrySet::GetEntryValue(uint16_t group, uint16_t elem)
 {
-   ValEntry *entry = GetValEntry(group,elem);
-   if( entry )
+   ContentEntry *entry = dynamic_cast<ContentEntry *>(GetDocEntry(group,elem));
+   if ( entry )
       return entry->GetValue();
    return GDCM_UNFOUND;
 }
 
 /**
  * \brief   Gets (from Header) a 'non string' element value 
- *          (LoadElementValues has already be executed)  
  * @param group   group number of the Entry 
  * @param elem  element number of the Entry
  * @return Pointer to the 'non string' area
  */
 void *DocEntrySet::GetEntryBinArea(uint16_t group, uint16_t elem) 
 {
-   BinEntry *entry = GetBinEntry(group,elem);
-   if( entry )
+   BinEntry *entry = GetBinEntry(group, elem);
+   if ( entry )
       return entry->GetBinArea();
    return 0;
 }
@@ -71,15 +72,15 @@ 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 )
+   DocEntry *entry = GetDocEntry(group, elem);
+   if ( entry )
       return entry->GetLength();
    return -1;
 }
 
 /**
  * \brief   Searches within Header Entries (Dicom Elements) parsed with 
- *          the public and private dictionaries 
+ *          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 
@@ -92,8 +93,8 @@ 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 )
+   DocEntry *entry = GetDocEntry(group, elem);
+   if ( entry )
       return entry->GetVR();
    return GDCM_UNFOUND;
 }
@@ -119,15 +120,19 @@ ValEntry *DocEntrySet::GetValEntry(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
  *         BinEntry.
- * @param   group  Group number of the searched Dicom Element 
- * @param   elem Element number of the searched Dicom Element  
+ * @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 *DocEntrySet::GetBinEntry(uint16_t group, uint16_t elem)
 {
    DocEntry *currentEntry = GetDocEntry(group, elem);
    if ( !currentEntry )
+   {
+      gdcmWarningMacro( "No corresponding BinEntry " << std::hex << group <<
+                         "," << elem);
       return NULL;
+   }
 
    return dynamic_cast<BinEntry*>(currentEntry);
 }
@@ -144,7 +149,11 @@ 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);
 }
@@ -157,13 +166,14 @@ SeqEntry *DocEntrySet::GetSeqEntry(uint16_t group, uint16_t elem)
  * @param   group  group number of the Dicom Element to modify
  * @param   elem element number of the Dicom Element to modify
  */
-bool DocEntrySet::SetValEntry(std::string constcontent, 
+bool DocEntrySet::SetValEntry(std::string const &content, 
                               uint16_t group, uint16_t elem) 
 {
    ValEntry *entry = GetValEntry(group, elem);
    if (!entry )
    {
-      gdcmVerboseMacro( "No corresponding ValEntry (try promotion first).");
+      gdcmWarningMacro( "No corresponding ValEntry " << std::hex << group <<
+                         "," << elem << " element (try promotion first).");
       return false;
    }
    return SetValEntry(content,entry);
@@ -178,13 +188,14 @@ bool DocEntrySet::SetValEntry(std::string const& content,
  * @param   group  group number of the Dicom Element to modify
  * @param   elem element number of the Dicom Element to modify
  */
-bool DocEntrySet::SetBinEntry(uint8_t*content, int lgth, 
+bool DocEntrySet::SetBinEntry(uint8_t *content, int lgth, 
                               uint16_t group, uint16_t elem) 
 {
    BinEntry *entry = GetBinEntry(group, elem);
    if (!entry )
    {
-      gdcmVerboseMacro( "No corresponding ValEntry (try promotion first).");
+      gdcmWarningMacro( "No corresponding ValEntry " << std::hex << group <<
+                        "," << elem << " element (try promotion first).");
       return false;
    }
 
@@ -199,7 +210,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;
@@ -216,7 +227,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);
@@ -241,23 +252,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;
          }
@@ -265,13 +276,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;
@@ -283,23 +294,24 @@ 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-
  * \return  pointer to the modified/created Header Entry (NULL when creation
  *          failed).
  */
-BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea,int lgth, 
+BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth, 
                                       uint16_t group, uint16_t elem,
                                       TagName const &vr )
 {
    BinEntry *binEntry = 0;
-   DocEntry *currentEntry = GetDocEntry( group, elem);
+   DocEntry *currentEntry = GetDocEntry( group, elem );
 
    // Verify the currentEntry
    if (currentEntry)
@@ -307,16 +319,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;
          }
@@ -324,13 +336,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;
@@ -339,7 +351,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);
@@ -348,9 +360,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;
       }
@@ -359,8 +371,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
@@ -370,42 +382,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;
 } 
  
@@ -420,34 +434,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);
-}
-
-//-----------------------------------------------------------------------------
-// Protected
 /**
  * \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);
@@ -455,7 +451,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;
@@ -466,12 +462,12 @@ 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) 
+BinEntry *DocEntrySet::NewBinEntry(uint16_t group, uint16_t elem,
+                                   TagName const &vr) 
 {
    DictEntry *dictEntry = GetDictEntry(group, elem, vr);
    gdcmAssertMacro(dictEntry);
@@ -479,7 +475,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;
@@ -489,10 +485,10 @@ 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) 
+SeqEntry* DocEntrySet::NewSeqEntry(uint16_t group, uint16_t elem) 
 {
    DictEntry *dictEntry = GetDictEntry(group, elem, "SQ");
    gdcmAssertMacro(dictEntry);
@@ -500,19 +496,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) 
@@ -521,7 +535,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
    {
@@ -530,18 +544,17 @@ DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem)
    return found;
 }
 
-
 /**
- * \brief   Searches both the public and the shadow dictionary (when they
- *          exist) for the presence of the DictEntry with given
+ * \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 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,
-                                             TagName const & vr)
+                                     TagName const &vr)
 {
    DictEntry *dictEntry = GetDictEntry(group,elem);
    DictEntry *goodEntry = dictEntry;
@@ -577,5 +590,8 @@ DictEntry *DocEntrySet::GetDictEntry(uint16_t group, uint16_t elem,
 //-----------------------------------------------------------------------------
 // Private
 
+//-----------------------------------------------------------------------------
+// Print
+
 //-----------------------------------------------------------------------------
 } // end namespace gdcm