]> Creatis software - gdcm.git/blobdiff - src/gdcmDocEntrySet.cxx
Doxygenation
[gdcm.git] / src / gdcmDocEntrySet.cxx
index 8ed29fb1a51a30ce6908c30dd9ecc61f99fd0cf1..8c817b5a927a680b7443739258be9456089c459f 100644 (file)
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/06/22 13:47:33 $
-  Version:   $Revision: 1.10 $
+  Date:      $Date: 2005/01/06 16:29:22 $
+  Version:   $Revision: 1.31 $
                                                                                 
   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.
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html 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 "gdcmDocEntrySet.h"
 
-#include <errno.h>
 #include "gdcmDebug.h"
 #include "gdcmCommon.h"
+#include "gdcmDictSet.h"
 #include "gdcmGlobal.h"
-#include "gdcmDocEntrySet.h"
 #include "gdcmException.h"
 #include "gdcmDocEntry.h"
 #include "gdcmSeqEntry.h"
 #include "gdcmValEntry.h"
 #include "gdcmBinEntry.h"
 
-//-----------------------------------------------------------------------------
-// Constructor / Destructor
-/**
- * \ingroup gdcmDocEntrySet
- * \brief   Constructor from a given gdcmDocEntrySet
- */
-gdcmDocEntrySet::gdcmDocEntrySet(int depthLevel) {
-   SQDepthLevel = depthLevel + 1;
-}
-/**
- * \brief   Canonical destructor.
- */
-gdcmDocEntrySet::~gdcmDocEntrySet(){
-}
-//-----------------------------------------------------------------------------
-// Print
-/*
- * \ingroup gdcmDocEntrySet
- * \brief   canonical Printer
- */
+#include <assert.h>
 
+namespace gdcm 
+{
 
 //-----------------------------------------------------------------------------
 // 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
+ * \brief  Gets a Dicom Element inside a SQ Item Entry, by name
+ * @param  name of the element to be found.
+ * @return
  */
-gdcmBinEntry *gdcmDocEntrySet::NewBinEntryByNumber(guint16 Group, guint16 Elem) 
+DocEntry* DocEntrySet::GetDocEntryByName( TagName const & name )
 {
-   // 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) 
+   Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
+   DictEntry *dictEntry = pubDict->GetDictEntryByName(name);
+   if( !dictEntry )
    {
-      dbg.Verbose(1, "gdcmDocument::NewBinEntryByNumber",
-                  "failed to allocate gdcmBinEntry");
-      return NULL;
+      return 0;
    }
-   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());      
 }
 
@@ -124,93 +58,151 @@ gdcmBinEntry *gdcmDocEntrySet::NewBinEntryByNumber(guint16 Group, guint16 Elem)
  * @return
  */ 
 
-std::string gdcmDocEntrySet::GetEntryByName(TagName name)  {
-   gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();
-   gdcmDictEntry *dictEntry = (*PubDict).GetDictEntryByName(name); 
+std::string DocEntrySet::GetEntryByName(TagName const & name)
+{
+   Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
+   DictEntry *dictEntry = pubDict->GetDictEntryByName(name); 
 
-   if( dictEntry == NULL)
+   if( !dictEntry )
+   {
       return GDCM_UNFOUND;
-   return GetEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement()); 
-}
+   }
 
+   return GetEntryByNumber(dictEntry->GetGroup(), dictEntry->GetElement()); 
+}
 
 /**
  * \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   elem  element number of the underlying DictEntry
  * @param   vr     VR of the underlying DictEntry
  * @param   fourth owner group
  * @param   name   english name
  */
-gdcmDictEntry *gdcmDocEntrySet::NewVirtualDictEntry(guint16 group, guint16 element,
-                                               std::string vr,
-                                               std::string fourth,
-                                               std::string name)
+DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group,uint16_t elem,
+                                             TagName const & vr,
+                                             TagName const & fourth,
+                                             TagName const & name )
 {
-   return gdcmGlobal::GetDicts()->NewVirtualDictEntry(group,element,vr,fourth,name);
+   return Global::GetDicts()->NewVirtualDictEntry(group,elem,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) {
-                                             
-   // 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) 
+//-----------------------------------------------------------------------------
+// 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 
+ */
+ValEntry *DocEntrySet::NewValEntryByNumber(uint16_t group,uint16_t elem,
+                                           TagName const & vr) 
+{
+   DictEntry *dictEntry = GetDictEntryByNumber(group, elem, vr);
+   assert(dictEntry);
+
+   ValEntry *newEntry = new ValEntry(dictEntry);
+   if (!newEntry) 
    {
-      dbg.Verbose(1, "gdcmSQItem::NewDocEntryByNumber",
-                  "failed to allocate gdcmDocEntry");
-      return (gdcmDocEntry*)0;
+      dbg.Verbose(1, "Document::NewValEntryByNumber",
+                  "failed to allocate ValEntry");
+      return 0;
    }
-   return NewEntry;                              
+   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   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 
+ */
+BinEntry *DocEntrySet::NewBinEntryByNumber(uint16_t group,uint16_t elem,
+                                           TagName const & vr) 
+{
+   DictEntry *dictEntry = GetDictEntryByNumber(group, elem, vr);
+   assert(dictEntry);
 
-   gdcmDocEntry* NewEntry = new gdcmDocEntry(NewTag);
-   if (!NewEntry) 
+   BinEntry *newEntry = new BinEntry(dictEntry);
+   if (!newEntry) 
    {
-      dbg.Verbose(1, "gdcmSQItem::ObtainDocEntryByName",
-                  "failed to allocate gdcmDocEntry");
-      return (gdcmDocEntry *)0;
+      dbg.Verbose(1, "Document::NewBinEntryByNumber",
+                  "failed to allocate BinEntry");
+      return 0;
    }
-   return NewEntry;                                      
+   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.
+ * @param   group group   number of the new Entry
+ * @param   elem  element number of the new Entry
+ */
+SeqEntry* DocEntrySet::NewSeqEntryByNumber(uint16_t group,uint16_t elem) 
+{
+   DictEntry *dictEntry = GetDictEntryByNumber(group, elem, "SQ");
+   assert(dictEntry);
+
+   SeqEntry *newEntry = new SeqEntry( dictEntry );
+   if (!newEntry)
+   {
+      dbg.Verbose(1, "Document::NewSeqEntryByNumber",
+                  "failed to allocate SeqEntry");
+      return 0;
+   }
+   return newEntry;
+}
+
+/** \brief 
+ * Creates a new DocEntry (without any 'value' ...)
+ * @param   group     group  number of the underlying DictEntry
+ * @param   elem  elem number of the underlying DictEntry 
+ * @param   vr    V(alue) R(epresentation) of the Entry -if private Entry- 
+ */
+DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group, uint16_t elem,
+                                           TagName const & vr)
+{
+   DictEntry *dictEntry = GetDictEntryByNumber(group, elem, vr);
+   assert(dictEntry);
+
+   // Create the DocEntry
+   DocEntry *newEntry = new DocEntry(dictEntry);
+   if (!newEntry) 
+   {
+      dbg.Verbose(1, "SQItem::NewDocEntryByNumber",
+                  "failed to allocate DocEntry");
+      return 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
+ * @param   name Name of the searched DictEntry
  * @return  Corresponding DictEntry when it exists, NULL otherwise.
  */
-gdcmDictEntry *gdcmDocEntrySet::GetDictEntryByName(std::string Name) 
+DictEntry *DocEntrySet::GetDictEntryByName(TagName const & name) 
 {
-   gdcmDictEntry *found = (gdcmDictEntry *)0;
-   gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();      
-   if (!PubDict) 
+   DictEntry *found = 0;
+   Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
+   if (!pubDict) 
    {
-      dbg.Verbose(0, "gdcmDocument::GetDictEntry",
+      dbg.Verbose(0, "Document::GetDictEntry",
                      "we SHOULD have a default dictionary");
    }
-   else 
-     found = PubDict->GetDictEntryByName(Name);  
+   else
+   {
+      found = pubDict->GetDictEntryByName(name);  
+   }
    return found;
 }
 
@@ -220,26 +212,54 @@ gdcmDictEntry *gdcmDocEntrySet::GetDictEntryByName(std::string Name)
  *          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
+ * @param   elem element number of the searched DictEntry
  * @return  Corresponding DictEntry when it exists, NULL otherwise.
  */
-gdcmDictEntry *gdcmDocEntrySet::GetDictEntryByNumber(guint16 group,guint16 element
+DictEntry *DocEntrySet::GetDictEntryByNumber(uint16_t group,uint16_t elem
 {
-   gdcmDictEntry *found = (gdcmDictEntry *)0;
-   gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();      
-   if (!PubDict) 
+   DictEntry *found = 0;
+   Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
+   if (!pubDict) 
    {
-      dbg.Verbose(0, "gdcmDocument::GetDictEntry",
+      dbg.Verbose(0, "Document::GetDictEntry",
                      "we SHOULD have a default dictionary");
    }
-   else 
-     found = PubDict->GetDictEntryByNumber(group, element);  
+   else
+   {
+      found = pubDict->GetDictEntryByNumber(group, elem);  
+   }
    return found;
 }
 
+DictEntry *DocEntrySet::GetDictEntryByNumber(uint16_t group, uint16_t elem,
+                                             TagName const & vr)
+{
+   DictEntry *dictEntry = GetDictEntryByNumber(group,elem);
+   DictEntry *goodEntry = dictEntry;
+   std::string goodVR=vr;
+
+   if (elem==0x0000)
+      goodVR="UL";
+
+   if (goodEntry)
+      if (goodEntry->GetVR() != goodVR && 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
 
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------