]> Creatis software - gdcm.git/blobdiff - src/gdcmDocEntrySet.cxx
* DEVELOPPER: added a proposition of coding style.
[gdcm.git] / src / gdcmDocEntrySet.cxx
index 00f790da7b16fdb28266efb05b94e5270729cffe..c5a032736ef8b612bea773230dc02de7e0e11718 100644 (file)
@@ -1,6 +1,21 @@
-// gdcmDocEntrySet.cxx
-//-----------------------------------------------------------------------------
-//
+/*=========================================================================
+                                                                                
+  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"
@@ -18,7 +33,8 @@
  * \ingroup gdcmDocEntrySet
  * \brief   Constructor from a given gdcmDocEntrySet
  */
-gdcmDocEntrySet::gdcmDocEntrySet() {
+gdcmDocEntrySet::gdcmDocEntrySet(int depthLevel) {
+   SQDepthLevel = depthLevel + 1;
 }
 /**
  * \brief   Canonical destructor.
@@ -35,148 +51,195 @@ gdcmDocEntrySet::~gdcmDocEntrySet(){
 
 //-----------------------------------------------------------------------------
 // Public
-//bool gdcmDocEntrySet::AddEntry(gdcmDocEntry *Entry){return true;}
 
+
+
+/**
+ * \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
 
+/**
+ * \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()); 
+}
 
-//-----------------------------------------------------------------------------
-// Private
 
 /**
- * \brief   Parses an EntrySet (Document header or SQ Item )
- * \       and load element values (a voir !)
- * @return  false anything wrong happens 
+ * \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
  */
- /* just to keep the code
-bool gdcmDocEntrySet::LoadDocEntrySet(bool exception_on_error) 
-                   throw(gdcmFormatError) {
-   (void)exception_on_error;
-
-   gdcmDocEntry  *newDocEntry = (gdcmDocEntry *)0;     
-   gdcmValEntry  *newValEntry = (gdcmValEntry *)0; 
-   gdcmBinEntry  *newBinEntry = (gdcmBinEntry *)0; 
-   gdcmSeqEntry  *newSeqEntry = (gdcmSeqEntry *)0;  
-   
-   string vr;
-   while (newDocEntry = ReadNextDocEntry()) { 
-   // TODO (?) : liberation du DocEntry ainsi cree, 
-   // apres copie dans un ValEntry, SeqEntry, BinEntry   
-      vr = newDocEntry->GetVR();
-         
-      if (vr == "SQ" ) {
-      // --- SeqEntry
-      
-         newSeqEntry = new gdcmSeqEntry((gdcmDictEntry*)NULL);
-        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
-         AddEntry(newSeqEntry); // on appele la fonction generique, 
-                               // ou une fonction spécialisée ?
-        
-      } else  if (vr == "AE" || vr == "AS" || vr == "DA" || vr == "PN" || 
-                  vr == "UI" || vr == "TM" || vr == "SH" || vr == "LO" ||
-                 vr == "CS" || vr == "IS" || vr == "LO" || vr == "LT" ||
-                 vr == "SH" || vr == "ST" ||             
-                 vr == "SL" || vr == "SS" || vr == "UL" || vr == "US"
-                                                                       ) {
-      // --- ValEntry            
-                 
-         newValEntry = new gdcmValEntry((gdcmDictEntry*)NULL);
-        if (!newValEntry) {
-            dbg.Verbose(1, "gdcmDocEntrySet::LoadDocEntrySet",
-                           "failed to allocate gdcmValEntry");
-            return false;                               
-         }      
-         newValEntry->Copy(newDocEntry);
-         //SkipDocEntry(newValEntry); //le skip devrait etre fait dans le Read 
-         AddEntry(newValEntry); // on appele la fonction generique, 
-                               // ou une fonction spécialisée ? 
-
-        // Maybe the following VR do correspond to a BinEntry 
-               
-        //AT Attribute Tag;         // 2 16-bit unsigned short integers
-        //FL Floating Point Single; // 32-bit IEEE 754:1985 float
-        //FD Floating Point Double; // 64-bit IEEE 754:1985 double
-        //UN Unknown;               // Any length of bytes
-        //UT Unlimited Text;        // At most 2^32 -1 chars
-       //OB Other Byte String;     // String of bytes (VR independant)
-        //OW Other Word String;     // String of 16-bit words (VR dependant)                                             
-      }        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((gdcmDictEntry*)NULL);     
-        if (!newBinEntry) {
-            dbg.Verbose(1, "gdcmDocEntrySet::LoadDocEntrySet",
-                           "failed to allocate gdcmBinEntry");
-            return false;                               
-         }      
-         newBinEntry->Copy(newDocEntry);
-        // SkipDocEntry(newBinEntry); //le skip devrait etre fait dans le Read 
-         AddEntry(newBinEntry); // on appele la fonction generique, 
-                               // ou une fonction spécialisée ?              
-      }                             
-   }   
-
-
-
-   // 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 ...
-   
-/* 
-   rewind(fp);  
-   for (ListTag::iterator i = GetListEntry().begin();                           
-        i != GetListEntry().end();                                                
-        ++i)                                                                      
-   {                                                                            
-      LoadDocEntry(*i);                                                      
-   }                                                                            
-   rewind(fp);
-   
-   */
- /* TO DO : deporter den fin de parsing du DOCUMENT (pas du EntrySet) 
-  
-   // --------------------------------------------------------------
-   // 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);
+
+   gdcmDocEntry* NewEntry = new gdcmDocEntry(NewTag);
+   if (!NewEntry) 
+   {
+      dbg.Verbose(1, "gdcmSQItem::ObtainDocEntryByName",
+                  "failed to allocate gdcmDocEntry");
+      return (gdcmDocEntry *)0;
+   }
+   return NewEntry;
+}
+
+
+/**
+ * \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) 
+   {
+      dbg.Verbose(0, "gdcmDocument::GetDictEntry",
+                     "we SHOULD have a default dictionary");
+   }
+   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) 
+   {
+      dbg.Verbose(0, "gdcmDocument::GetDictEntry",
+                     "we SHOULD have a default dictionary");
+   }
+   else 
+     found = PubDict->GetDictEntryByNumber(group, element);  
+   return found;
+}
+
+
+//-----------------------------------------------------------------------------
+// Private
 
 
 //-----------------------------------------------------------------------------