]> Creatis software - gdcm.git/blobdiff - src/gdcmDocEntrySet.cxx
* DEVELOPPER: added a proposition of coding style.
[gdcm.git] / src / gdcmDocEntrySet.cxx
index e0266a541f070c6da3e218ccb3287502dd9e47bc..c5a032736ef8b612bea773230dc02de7e0e11718 100644 (file)
@@ -1,24 +1,46 @@
-// gdcmDocEntrySet.cxx
-//-----------------------------------------------------------------------------
-//
-#include "gdcmDocEntrySet.h"
-#include "gdcmTS.h"
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
+  Language:  C++
+  Date:      $Date: 2004/06/22 14:11:34 $
+  Version:   $Revision: 1.12 $
+                                                                                
+  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
+  l'Image). All rights reserved. See Doc/License.txt or
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
+#include <errno.h>
+#include "gdcmDebug.h"
+#include "gdcmCommon.h"
 #include "gdcmGlobal.h"
-#include "gdcmUtil.h"
-
-#include <iomanip> // for std::ios::left, ...
-
+#include "gdcmDocEntrySet.h"
+#include "gdcmException.h"
+#include "gdcmDocEntry.h"
+#include "gdcmSeqEntry.h"
+#include "gdcmValEntry.h"
+#include "gdcmBinEntry.h"
 
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup gdcmDocEntrySEt
+ * \ingroup gdcmDocEntrySet
  * \brief   Constructor from a given gdcmDocEntrySet
  */
-gdcmDocEntrySet::gdcmDocEntrySet() {
-
+gdcmDocEntrySet::gdcmDocEntrySet(int depthLevel) {
+   SQDepthLevel = depthLevel + 1;
+}
+/**
+ * \brief   Canonical destructor.
+ */
+gdcmDocEntrySet::~gdcmDocEntrySet(){
 }
-
 //-----------------------------------------------------------------------------
 // Print
 /*
@@ -31,195 +53,193 @@ gdcmDocEntrySet::gdcmDocEntrySet() {
 // Public
 
 
+
+/**
+ * \brief   Build a new Element Value 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 underlying DictEntry
+ * @param   Elem  element number of the underlying DictEntry
+ */
+gdcmValEntry *gdcmDocEntrySet::NewValEntryByNumber(guint16 Group, guint16 Elem) 
+{
+   // Find out if the tag we encountered is in the dictionaries:
+   gdcmDictEntry *DictEntry = GetDictEntryByNumber(Group, Elem);
+   if (!DictEntry)
+      DictEntry = NewVirtualDictEntry(Group, Elem);
+
+   gdcmValEntry *NewEntry = new gdcmValEntry(DictEntry);
+   if (!NewEntry) 
+   {
+      dbg.Verbose(1, "gdcmDocument::NewValEntryByNumber",
+                  "failed to allocate gdcmValEntry");
+      return NULL;
+   }
+   return NewEntry;
+}
+
+
+/**
+ * \brief   Build a new Element Value 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 underlying DictEntry
+ * @param   Elem  element number of the underlying DictEntry
+ */
+gdcmBinEntry *gdcmDocEntrySet::NewBinEntryByNumber(guint16 Group, guint16 Elem) 
+{
+   // Find out if the tag we encountered is in the dictionaries:
+   gdcmDictEntry *DictEntry = GetDictEntryByNumber(Group, Elem);
+   if (!DictEntry)
+      DictEntry = NewVirtualDictEntry(Group, Elem);
+
+   gdcmBinEntry *NewEntry = new gdcmBinEntry(DictEntry);
+   if (!NewEntry) 
+   {
+      dbg.Verbose(1, "gdcmDocument::NewBinEntryByNumber",
+                  "failed to allocate gdcmBinEntry");
+      return NULL;
+   }
+   return NewEntry;
+}
 //-----------------------------------------------------------------------------
 // Protected
 
-//-----------------------------------------------------------------------------
-// Private
+/**
+ * \brief   Gets a Dicom Element inside a SQ Item Entry, by name
+ * @return
+ */
+ gdcmDocEntry *gdcmDocEntrySet::GetDocEntryByName(std::string name) {
+   gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();
+   gdcmDictEntry *dictEntry = (*PubDict).GetDictEntryByName(name);
+   if( dictEntry == NULL)
+      return NULL;
+   return GetDocEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement());      
+}
+
+
+/**
+ * \brief   Get the value of a Dicom Element inside a SQ Item Entry, by name
+ * @param   name : name of the searched element.
+ * @return
+ */ 
+
+std::string gdcmDocEntrySet::GetEntryByName(TagName name)  {
+   gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();
+   gdcmDictEntry *dictEntry = (*PubDict).GetDictEntryByName(name); 
+
+   if( dictEntry == NULL)
+      return GDCM_UNFOUND;
+   return GetEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement()); 
+}
+
 
 /**
- * \brief   Parses an EntrySet (Document header or SQ Item )
- * \       and load element values (a voir !)
- * @return  false if file is not ACR-NEMA / PAPYRUS / DICOM 
+ * \brief   Request a new virtual dict entry to the dict set
+ * @param   group     group  number of the underlying DictEntry
+ * @param   element  element number of the underlying DictEntry
+ * @param   vr     VR of the underlying DictEntry
+ * @param   fourth owner group
+ * @param   name   english name
  */
-bool gdcmDocument::LoadDocEntrySet(bool exception_on_error) throw(gdcmFormatError) {
-   (void)exception_on_error;
-   rewind(fp);
-   if (!CheckSwap())
-      return false;
-
-   gdcmDocEntry  *newDocEntry = (gdcmDocEntry *)0;     
-   gdcmValEntry  *newValEntry = (gdcmValEntry *)0; 
-   gdcmBinEntry  *newBinEntry = (gdcmBinEntry *)0; 
-   gdcmSeqEntry  *newSeqEntry = (gdcmSeqEntry *)0;  
-   //gdcmDictEntry *NewTag      = (gdcmDictEntry *)0;
-
-   while (newDocEntry = ReadNextDocEntry())) { 
-   // TODO (?) : liberation du DocEntry ainsi cree, 
-   // apres copie dans un ValEntry, SeqEntry, BinEntry   
-      vr = newDocEntry->getVR();
-         
-      if (vr == "SQ" ) {
-      // --- SeqEntry
-      
-         newSeqEntry = (gdcmSeqEntry *)0;
-        if (!NewSeqEntry) {
-            dbg.Verbose(1, "gdcmDocEntrySet::LoadDocEntrySet",
-                           "failed to allocate gdcmSeqEntry");
-            return false;                               
-         }      
-         newSeqEntry->Copy(newDocEntry);            
-      // TODO
-      // SEQUENCE; appel 'récursif' de ??? pour charger la 'valeur'
-      //           (ensemble d' ITEMs, en fait, 
-      //            chaque ITEM etant chargé avec LoadDocEntrySet)
-            
-         SkipDocEntry(newSeqEntry); // voir ce qu'on fait pour une SeQuence
-         AddDocEntry(newSeqEntry); 
-        
-      } else  if (vr == "AE" || vr == "AS" || vr == "DA" || vr == "PN" || 
-                  vr == "UI" || vr == "TM" ) {
-      // --- ValEntry            
-                 
-         newValEntry = (gdcmValEntry *)0;
-        if (!NewValEntry) {
-            dbg.Verbose(1, "gdcmDocEntrySet::LoadDocEntrySet",
-                           "failed to allocate gdcmValEntry");
-            return false;                               
-         }      
-         newValEntry->Copy(newDocEntry);
-         SkipDocEntry(newValEntry); 
-         AddDocEntry(newValEntry); 
-                                                 
-      }        else {
-      // --- BinEntry
+gdcmDictEntry *gdcmDocEntrySet::NewVirtualDictEntry(guint16 group, guint16 element,
+                                               std::string vr,
+                                               std::string fourth,
+                                               std::string name)
+{
+   return gdcmGlobal::GetDicts()->NewVirtualDictEntry(group,element,vr,fourth,name);
+}
+
+/// \brief 
+
+// 
+// Probabely move, as is, to gdcmDocEntrySet, as a non virtual method
+// an remove gdcmDocument::NewDocEntryByNumber
+gdcmDocEntry *gdcmDocEntrySet::NewDocEntryByNumber(guint16 group,
+                                                   guint16 elem) {
       
-         NewBinEntry = new gdcmBinEntry(DictEntry);     
-        if (!NewValEntry) {
-            dbg.Verbose(1, "gdcmDocEntrySet::LoadDocEntrySet",
-                           "failed to allocate gdcmBinEntry");
-            return false;                               
-         }      
-         newBinEntry->Copy(newDocEntry);
-         SkipDocEntry(newBinEntry); 
-         AddDocEntry(newBinEntry);           
-      }                             
-   }   
-   rewind(fp);
-
-
-   // TODO : il n'y a plus de Chained List qui contient toutes les Entries 
-   //        Le chargement des valeurs devra se faire à la volée  
-   // Be carefull : merging this two loops may cause troubles ...
-   for (ListTag::iterator i = GetListEntry().begin();                           
-        i != GetListEntry().end();                                                
-        ++i)                                                                      
-   {                                                                            
-      LoadDocEntry(*i);                                                      
-   }                                                                            
-   rewind(fp);
-    
-   // --------------------------------------------------------------
-   // Special Patch to allow gdcm to read ACR-LibIDO formated images
-   //
-   // if recognition code tells us we deal with a LibIDO image
-   // we switch lineNumber and columnNumber
-   //
-   std::string RecCode;
-   RecCode = GetEntryByNumber(0x0008, 0x0010); // recognition code
-   if (RecCode == "ACRNEMA_LIBIDO_1.1" ||
-       RecCode == "CANRME_AILIBOD1_1." )  // for brain-damaged softwares
-                                          // with "little-endian strings"
+   // Find out if the tag we encountered is in the dictionaries:
+   gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();
+   gdcmDictEntry *DictEntry = (*PubDict).GetDictEntryByNumber(group, elem);
+   if (!DictEntry)
+      DictEntry = NewVirtualDictEntry(group, elem);
+
+   gdcmDocEntry *NewEntry = new gdcmDocEntry(DictEntry);
+   if (!NewEntry) 
    {
-         filetype = ACR_LIBIDO; 
-         std::string rows    = GetEntryByNumber(0x0028, 0x0010);
-         std::string columns = GetEntryByNumber(0x0028, 0x0011);
-         SetEntryByNumber(columns, 0x0028, 0x0010);
-         SetEntryByNumber(rows   , 0x0028, 0x0011);
+      dbg.Verbose(1, "gdcmSQItem::NewDocEntryByNumber",
+                  "failed to allocate gdcmDocEntry");
+      return (gdcmDocEntry*)0;
    }
-   // ----------------- End of Special Patch ----------------   
-   return true;
+   return NewEntry;
 }
 
+/// \brief 
+gdcmDocEntry *gdcmDocEntrySet::NewDocEntryByName  (std::string Name) {
 
+  gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();
+  gdcmDictEntry *NewTag = (*PubDict).GetDictEntryByName(Name);
+   if (!NewTag)
+      NewTag = NewVirtualDictEntry(0xffff, 0xffff, "LO", "unkn", Name);
 
-/**
- * \brief     Check the correspondance between the VR of the header entry
- *            and the taken VR. If they are different, the header entry is 
- *            updated with the new VR.
- * @param     Entry Header Entry to check
- * @param     vr    Dicom Value Representation
- * @return    false if the VR is incorrect of if the VR isn't referenced
- *            otherwise, it returns true
-*/
-
-// NE MARCHE PAS EN L'ETAT :
-// On a besoin de VR pour 'fabriquer', au choix ValEntry, BinEntry, ou SeqEntry.
-//
-
-bool gdcmDocEntrySet::CheckEntryVR(gdcmHeaderEntry *Entry, VRKey vr)
-{
-   char msg[100]; // for sprintf
-   bool RealExplicit = true;
-
-   // Assume we are reading a falsely explicit VR file i.e. we reached
-   // a tag where we expect reading a VR but are in fact we read the
-   // first to bytes of the length. Then we will interogate (through find)
-   // the dicom_vr dictionary with oddities like "\004\0" which crashes
-   // both GCC and VC++ implementations of the STL map. Hence when the
-   // expected VR read happens to be non-ascii characters we consider
-   // we hit falsely explicit VR tag.
-
-   if ( (!isalpha(vr[0])) && (!isalpha(vr[1])) )
-      RealExplicit = false;
-
-   // CLEANME searching the dicom_vr at each occurence is expensive.
-   // PostPone this test in an optional integrity check at the end
-   // of parsing or only in debug mode.
-   if ( RealExplicit && !gdcmGlobal::GetVR()->Count(vr) )
-      RealExplicit= false;
-
-   if ( !RealExplicit ) 
+   gdcmDocEntry* NewEntry = new gdcmDocEntry(NewTag);
+   if (!NewEntry) 
    {
-      // We thought this was explicit VR, but we end up with an
-      // implicit VR tag. Let's backtrack.   
-      sprintf(msg,"Falsely explicit vr file (%04x,%04x)\n", 
-                   Entry->GetGroup(),Entry->GetElement());
-      dbg.Verbose(1, "gdcmParser::FindVR: ",msg);
-      if (Entry->GetGroup()%2 && Entry->GetElement() == 0x0000) { // Group length is UL !
-         gdcmDictEntry* NewEntry = NewVirtualDictEntry(
-                                   Entry->GetGroup(),Entry->GetElement(),
-                                   "UL","FIXME","Group Length");
-         Entry->SetDictEntry(NewEntry);     
-      }
-      return(false);
+      dbg.Verbose(1, "gdcmSQItem::ObtainDocEntryByName",
+                  "failed to allocate gdcmDocEntry");
+      return (gdcmDocEntry *)0;
    }
+   return NewEntry;
+}
+
 
-   if ( Entry->IsVRUnknown() ) 
+/**
+ * \brief   Searches both the public and the shadow dictionary (when they
+ *          exist) for the presence of the DictEntry with given name.
+ *          The public dictionary has precedence on the shadow one.
+ * @param   Name name of the searched DictEntry
+ * @return  Corresponding DictEntry when it exists, NULL otherwise.
+ */
+gdcmDictEntry *gdcmDocEntrySet::GetDictEntryByName(std::string Name) 
+{
+   gdcmDictEntry *found = (gdcmDictEntry *)0;
+   gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();
+   if (!PubDict) 
    {
-      // When not a dictionary entry, we can safely overwrite the VR.
-      if (Entry->GetElement() == 0x0000) { // Group length is UL !
-         Entry->SetVR("UL");
-      } else {
-         Entry->SetVR(vr);
-      }
+      dbg.Verbose(0, "gdcmDocument::GetDictEntry",
+                     "we SHOULD have a default dictionary");
    }
-   else if ( Entry->GetVR() != vr ) 
+   else 
+     found = PubDict->GetDictEntryByName(Name);  
+   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. The public dictionary has precedence on the
+ *          shadow one.
+ * @param   group   group number of the searched DictEntry
+ * @param   element element number of the searched DictEntry
+ * @return  Corresponding DictEntry when it exists, NULL otherwise.
+ */
+gdcmDictEntry *gdcmDocEntrySet::GetDictEntryByNumber(guint16 group,guint16 element) 
+{
+   gdcmDictEntry *found = (gdcmDictEntry *)0;
+   gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();
+   if (!PubDict) 
    {
-      // The VR present in the file and the dictionary disagree. We assume
-      // the file writer knew best and use the VR of the file. Since it would
-      // be unwise to overwrite the VR of a dictionary (since it would
-      // compromise it's next user), we need to clone the actual DictEntry
-      // and change the VR for the read one.
-      gdcmDictEntry* NewEntry = NewVirtualDictEntry(
-                                 Entry->GetGroup(),Entry->GetElement(),
-                                 vr,"FIXME",Entry->GetName());
-      Entry->SetDictEntry(NewEntry);
+      dbg.Verbose(0, "gdcmDocument::GetDictEntry",
+                     "we SHOULD have a default dictionary");
    }
-   return(true); 
+   else 
+     found = PubDict->GetDictEntryByNumber(group, element);  
+   return found;
 }
 
 
+//-----------------------------------------------------------------------------
+// Private
 
 
 //-----------------------------------------------------------------------------