]> Creatis software - gdcm.git/blobdiff - src/gdcmDocEntrySet.cxx
According to Mathieu's suggestion, Print now display FL BinEntries in a human
[gdcm.git] / src / gdcmDocEntrySet.cxx
index 9a44fc31942338bdafbe6a76873aac49f9c8fb51..666b72a100c506ae9fc422eb4a208d88980e14be 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/26 09:49:54 $
-  Version:   $Revision: 1.47 $
+  Date:      $Date: 2005/08/24 12:09:13 $
+  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
 
 namespace gdcm 
 {
-
+//-----------------------------------------------------------------------------
+// Constructor / Destructor
+DocEntrySet::DocEntrySet() 
+{ 
+   PreviousDocEntry = 0;
+}
 //-----------------------------------------------------------------------------
 // Public
 /**
@@ -41,7 +46,7 @@ namespace gdcm
 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;
 }
@@ -54,8 +59,8 @@ 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 )
+   BinEntry *entry = GetBinEntry(group, elem);
+   if ( entry )
       return entry->GetBinArea();
    return 0;
 }
@@ -70,8 +75,8 @@ 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;
 }
@@ -91,8 +96,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;
 }
@@ -127,7 +132,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;
    }
@@ -148,7 +153,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;
    }
@@ -164,13 +169,13 @@ 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 " << std::hex << group <<
+      gdcmWarningMacro( "No corresponding ValEntry " << std::hex << group <<
                          "," << elem << " element (try promotion first).");
       return false;
    }
@@ -192,7 +197,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;
    }
@@ -208,7 +213,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;
@@ -225,7 +230,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);
@@ -250,23 +255,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;
          }
@@ -274,13 +279,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;
@@ -292,23 +297,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)
@@ -316,16 +322,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;
          }
@@ -333,13 +339,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;
@@ -348,7 +354,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);
@@ -357,9 +363,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;
       }
@@ -368,8 +374,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
@@ -379,42 +385,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;
 } 
  
@@ -429,34 +437,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);
@@ -464,7 +454,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,12 +465,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);
@@ -488,7 +478,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,10 +488,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);
@@ -509,19 +499,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) 
@@ -530,7 +538,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
    {
@@ -539,18 +547,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
  *          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;
@@ -586,5 +593,8 @@ DictEntry *DocEntrySet::GetDictEntry(uint16_t group, uint16_t elem,
 //-----------------------------------------------------------------------------
 // Private
 
+//-----------------------------------------------------------------------------
+// Print
+
 //-----------------------------------------------------------------------------
 } // end namespace gdcm