]> Creatis software - gdcm.git/blobdiff - src/gdcmDocEntry.cxx
* src/gdcmCommon.h : add the GDCM_UNKNOWN constant. This constant is to
[gdcm.git] / src / gdcmDocEntry.cxx
index 668fbefcfc057662ceb3ae6c7bd5199daf377b36..6ada3fad82bedaa863be4935606edd7ae17947ae 100644 (file)
@@ -1,13 +1,32 @@
-// gdcmDocEntry.cxx
-//-----------------------------------------------------------------------------
-//
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDocEntry.cxx,v $
+  Language:  C++
+  Date:      $Date: 2005/01/05 15:38:28 $
+  Version:   $Revision: 1.36 $
+                                                                                
+  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.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 "gdcmDocEntry.h"
 #include "gdcmTS.h"
+#include "gdcmVR.h"
 #include "gdcmGlobal.h"
 #include "gdcmUtil.h"
 
 #include <iomanip> // for std::ios::left, ...
+#include <fstream>
+
+namespace gdcm 
+{
 
 // CLEAN ME
 #define MAX_SIZE_PRINT_ELEMENT_VALUE 64
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup gdcmDocEntry
- * \brief   Constructor from a given gdcmDictEntry
+ * \ingroup DocEntry
+ * \brief   Constructor from a given DictEntry
  * @param   in Pointer to existing dictionary entry
  */
-gdcmDocEntry::gdcmDocEntry(gdcmDictEntry* in) {
+DocEntry::DocEntry(DictEntry* in)
+{
    ImplicitVR = false;
-   entry = in;
-}
+   DicomDict  = in;
+   SetKey( in->GetKey( ) );
+   Offset     = 0 ; // To avoid further missprinting
 
-void gdcmDocEntry::Print(std::ostream & os) {
-   std::ostringstream s;
-   s << std::endl;
-   PrintCommonPart(os);
-   os << s.str();
+   // init some variables
+   ReadLength = 0;
+   UsableLength = 0;
 }
 
 //-----------------------------------------------------------------------------
 // Print
 /**
- * \ingroup gdcmDocEntry
- * \brief   Prints the common part of gdcmValEntry, gdcmBinEntry, gdcmSeqEntry
+ * \ingroup DocEntry
+ * \brief   Prints the common part of ValEntry, BinEntry, SeqEntry
+ * @param   os ostream we want to print in
  */
-void gdcmDocEntry::PrintCommonPart(std::ostream & os) {
-
-   printLevel=2; // FIXME
-   
+void DocEntry::Print(std::ostream& os)
+{
    size_t o;
-   unsigned short int g, e;
-   char st[20];
+   std::string st;
    TSKey v;
    std::string d2, vr;
    std::ostringstream s;
-   guint32 lgth;
-   char greltag[10];  //group element tag
+   uint32_t lgth;
 
-   g  = GetGroup();
-   e  = GetElement();
    o  = GetOffset();
    vr = GetVR();
-   sprintf(greltag,"%04x|%04x ",g,e);           
-   s << greltag ;
-       
-   if (printLevel>=2) { 
-      s << "lg : ";
+
+   s << DictEntry::TranslateToKey(GetGroup(),GetElement()); 
+
+   if (PrintLevel >= 2)
+   {
+      s << " lg : ";
       lgth = GetReadLength(); // ReadLength, as opposed to UsableLength
-      if (lgth == 0xffffffff) {
-         sprintf(st,"x(ffff)");  // I said : "x(ffff)" !
+      if (lgth == 0xffffffff)
+      {
+         st = Util::Format("x(ffff)");  // I said : "x(ffff)" !
          s.setf(std::ios::left);
-         s << std::setw(10-strlen(st)) << " ";  
+         s << std::setw(10-st.size()) << " ";  
          s << st << " ";
          s.setf(std::ios::left);
-         s << std::setw(8) << "-1";      
-      } else {
-         sprintf(st,"x(%x)",lgth);
+         s << std::setw(8) << "-1"; 
+      }
+      else
+      {
+         st = Util::Format("x(%x)",lgth);
          s.setf(std::ios::left);
-         s << std::setw(10-strlen(st)) << " ";  
+         s << std::setw(10-st.size()) << " ";
          s << st << " ";
          s.setf(std::ios::left);
          s << std::setw(8) << lgth; 
       }
       s << " Off.: ";
-      sprintf(st,"x(%x)",o); 
-      s << std::setw(10-strlen(st)) << " ";
+      st = Util::Format("x(%x)",o); 
+      s << std::setw(10-st.size()) << " ";
       s << st << " ";
       s << std::setw(8) << o; 
    }
 
    s << "[" << vr  << "] ";
 
-   if (printLevel>=1) {      
+   if (PrintLevel >= 1)
+   {
       s.setf(std::ios::left);
       s << std::setw(66-GetName().length()) << " ";
    }
@@ -93,53 +112,163 @@ void gdcmDocEntry::PrintCommonPart(std::ostream & os) {
    os << s.str();      
 }
 
+/**
+ * \ingroup DocEntry
+ * \brief   Writes the common part of any ValEntry, BinEntry, SeqEntry
+ * @param fp already open file pointer
+ * @param filetype type of the file to be written
+ */
+void DocEntry::WriteContent(std::ofstream* fp, FileType filetype)
+{
+   uint32_t ffff  = 0xffffffff;
+   uint16_t group = GetGroup();
+   VRKey vr   = GetVR();
+   uint16_t el    = GetElement();
+   uint32_t lgr   = GetReadLength();
+
+   if ( group == 0xfffe && el == 0x0000 )
+   {
+     // Fix in order to make some MR PHILIPS images e-film readable
+     // see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
+     // we just *always* ignore spurious fffe|0000 tag !   
+      return;
+   }
+
+   //
+   // ----------- Writes the common part
+   //
+   binary_write( *fp, group);  //group
+   binary_write( *fp, el);  //element
+
+   if ( filetype == ExplicitVR )
+   {
+      // Special case of delimiters:
+      if (group == 0xfffe)
+      {
+         // Delimiters have NO Value Representation
+         // Hence we skip writing the VR.
+         // In order to avoid further troubles, we choose to write them
+         // as 'no-length' Item Delimitors (we pad by writing 0xffffffff)
+         // The end of a given Item will be found when  :
+         //  - a new Item Delimitor Item is encountered (the Seq goes on)
+         //  - a Sequence Delimitor Item is encountered (the Seq just ended)
+
+         // TODO : verify if the Sequence Delimitor Item was forced during Parsing 
+
+         uint32_t ff = 0xffffffff;
+         binary_write(*fp, ff);
+         return;
+      }
+
+      uint16_t z = 0;
+      uint16_t shortLgr = lgr;
+
+      if (vr == GDCM_UNKNOWN)
+      {
+         // Unknown was 'written'
+         // deal with Little Endian            
+         binary_write(*fp, shortLgr);
+         binary_write(*fp, z);
+      }
+      else
+      {
+         binary_write(*fp, vr);
+         assert( vr.size() == 2 );
+                  
+         if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") || (vr == "UN") )
+         {
+            binary_write(*fp, z);
+            if (vr == "SQ")
+            {
+               // we set SQ length to ffffffff
+               // and  we shall write a Sequence Delimitor Item 
+               // at the end of the Sequence! 
+               binary_write(*fp, ffff);
+            }
+            else
+            {
+               binary_write(*fp, lgr);
+            }
+         }
+         else
+         {
+            binary_write(*fp, shortLgr);
+         }
+      }
+   } 
+   else // IMPLICIT VR 
+   { 
+      if (vr == "SQ")
+      {
+         binary_write(*fp, ffff);
+      }
+      else
+      {
+         binary_write(*fp, lgr);
+      }
+   }
+}
+
 //-----------------------------------------------------------------------------
 // Public
 
 /**
- * \ingroup gdcmDocEntry
- * \brief   Gets the full length of the elementary DocEntry (not only value length)
+ * \ingroup DocEntry
+ * \brief   Gets the full length of the elementary DocEntry (not only value
+ *          length) depending on the VR.
  */
-guint32 gdcmDocEntry::GetFullLength(void) {
-   guint32 l;
-   l = GetReadLength();
-   if ( IsImplicitVR() ) 
+uint32_t DocEntry::GetFullLength()
+{
+   uint32_t l = GetReadLength();
+   if ( IsImplicitVR() )
+   {
       l = l + 8;  // 2 (gr) + 2 (el) + 4 (lgth) 
-   else    
+   }
+   else
+   {
       if ( GetVR()=="OB" || GetVR()=="OW" || GetVR()=="SQ" )
+      {
          l = l + 12; // 2 (gr) + 2 (el) + 2 (vr) + 2 (unused) + 4 (lgth)
+      }
       else
+      {
          l = l + 8;  // 2 (gr) + 2 (el) + 2 (vr) + 2 (lgth)
-   return(l);
+      }
+   }
+   return l;
 }
 
 /**
- * \ingroup gdcmDocEntry
+ * \ingroup DocEntry
  * \brief   Copies all the attributes from an other DocEntry 
  */
-
-void gdcmDocEntry::Copy (gdcmDocEntry* e) {
-   this->entry        = e->entry;
-   this->UsableLength = e->UsableLength;
-   this->ReadLength   = e->ReadLength;
-   this->ImplicitVR   = e->ImplicitVR;
-   this->Offset       = e->Offset;
-   this->printLevel   = e->printLevel;
-   // TODO : remove gdcmDocEntry SQDepth
+void DocEntry::Copy (DocEntry* e)
+{
+//   DicomDict    = e->DicomDict;
+   UsableLength = e->UsableLength;
+   ReadLength   = e->ReadLength;
+   ImplicitVR   = e->ImplicitVR;
+   Offset       = e->Offset;
+   // TODO : remove DocEntry SQDepth
 }
 
-bool gdcmDocEntry::isItemDelimitor() {
-   if ( (GetGroup() == 0xfffe) && (GetElement() == 0xe00d) )
-      return true;
-   else
-      return false;      
+/**
+ * \ingroup DocEntry
+ * \brief   tells us if entry is the last one of a 'no length' SequenceItem 
+ *          (fffe,e00d) 
+ */
+bool DocEntry::IsItemDelimitor()
+{
+   return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
 }
-
-bool gdcmDocEntry::isSequenceDelimitor() {
-   if (GetGroup() == 0xfffe && GetElement() == 0xe0dd)
-      return true;
-   else
-      return false; 
+/**
+ * \ingroup DocEntry
+ * \brief   tells us if entry is the last one of a 'no length' Sequence 
+ *          (fffe,e0dd) 
+ */
+bool DocEntry::IsSequenceDelimitor()
+{
+   return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);
 }
 
 //-----------------------------------------------------------------------------
@@ -150,3 +279,5 @@ bool gdcmDocEntry::isSequenceDelimitor() {
 // Private
 
 //-----------------------------------------------------------------------------
+
+} // end namespace gdcm