]> Creatis software - gdcm.git/blobdiff - src/gdcmDocEntry.h
* src/gdcmDocument.cxx: FIX ::ComputeRLEInfo() rleSegmentOffsetTable[]
[gdcm.git] / src / gdcmDocEntry.h
index e3162589e57a68774a59f470a2d04284e93f97a8..7399e23c67632e00418c81a6ffe31202cd913e75 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntry.h,v $
   Language:  C++
-  Date:      $Date: 2004/09/03 20:27:44 $
-  Version:   $Revision: 1.19 $
+  Date:      $Date: 2004/11/16 14:48:19 $
+  Version:   $Revision: 1.29 $
                                                                                 
   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
 #ifndef GDCMDOCENTRY_H
 #define GDCMDOCENTRY_H
 
-#include <iostream>
-#include <stdio.h>
-
 #include "gdcmDictEntry.h"
+#include <iostream>
 
-class gdcmHeader;
-class gdcmValEntry;
-class gdcmBinEntry;
-class gdcmSeqEntry;
+class Header;
+class ValEntry;
+class BinEntry;
+class SeqEntry;
 
+namespace gdcm 
+{
 //-----------------------------------------------------------------------------
 /**
- * \ingroup gdcmDocEntry
  * \brief   The dicom header of a Dicom file contains a set of such entries
  *          (when successfuly parsed against a given Dicom dictionary)
  */
-class GDCM_EXPORT gdcmDocEntry
+class GDCM_EXPORT DocEntry
 {
 public:
-   gdcmDocEntry(gdcmDictEntry*);
+   DocEntry(DictEntry*);
+   virtual ~DocEntry() {};
 
    /// Returns the Dicom Group number of the current Dicom Header Entry
-   uint16_t      GetGroup()     { return DictEntry->GetGroup();  };
+   uint16_t      GetGroup()     { return DicomDict->GetGroup();  };
 
    /// Returns the Dicom Element number of the current Dicom Header Entry
-   uint16_t      GetElement()   { return DictEntry->GetElement();};
+   uint16_t      GetElement()   { return DicomDict->GetElement();};
+
+   /// Returns the 'key' of the current Dicom Header Entry
+   void  SetKey( TagKey const & key ) { Key = key; }
 
    /// Returns the 'key' of the current Dicom Header Entry
-   std::string  GetKey()       { return DictEntry->GetKey();    };
+   std::string const & GetKey() const { return Key; }
 
    /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
    /// Dictionnary of the current Dicom Header Entry
-   std::string  GetName()      { return DictEntry->GetName();   };
+   std::string const & GetName() const { return DicomDict->GetName(); };
 
    /// \brief Returns the 'Value Representation' (e.g. "PN" : Person Name,
    /// "SL" : Signed Long), found in the Dicom Header or in the Dicom
    /// Dictionnary, of the current Dicom Header Entry
-   std::string  GetVR()        { return DictEntry->GetVR();     };
+   std::string const & GetVR() const { return DicomDict->GetVR(); };
 
    /// \brief Returns offset (since the beginning of the file, including
    /// the File Preamble, if any) of the value of the current Dicom HeaderEntry
    /// \warning offset of the *value*, not of the Dicom Header Entry
-   size_t       GetOffset()    { return Offset;             };
+   size_t GetOffset() { return Offset; };
 
    /// \brief Returns the actual value length of the current Dicom Header Entry
    /// \warning this value is not *always* the one stored in the Dicom Header
@@ -75,11 +78,11 @@ public:
    uint32_t GetReadLength() { return ReadLength; };
 
    /// Sets the 'Value Representation' of the current Dicom Header Entry
-   void SetVR(std::string const & v) { DictEntry->SetVR(v); };    
+   void SetVR( TagName const & v) { DicomDict->SetVR(v); };    
 
    /// \brief Sets both 'Read Length' and 'Usable Length' of the current
    /// Dicom Header Entry
-   void SetLength(uint32_t l) { ReadLength = UsableLength = l;};
+   void SetLength(uint32_t l) { ReadLength = UsableLength = l; };
       
    // The following 3 members, for internal use only ! 
    
@@ -105,15 +108,15 @@ public:
 
    /// \brief Tells us if the VR of the current Dicom Element is Unknown
    /// @return true if the VR is unknown
-   bool IsVRUnknown() { return DictEntry->IsVRUnknown(); };
+   bool IsVRUnknown() { return DicomDict->IsVRUnknown(); };
 
    /// \brief   Sets the DicEntry of the current Dicom Element
    /// @param   newEntry pointer to the DictEntry
-   void SetDictEntry(gdcmDictEntry *newEntry) { DictEntry = newEntry; };
+   void SetDictEntry(DictEntry *newEntry) { DicomDict = newEntry; };
 
    /// \brief  Gets the DicEntry of the current Dicom Element
    /// @return The DicEntry of the current Dicom Element
-   gdcmDictEntry * GetDictEntry() { return DictEntry; }; 
+   DictEntry * GetDictEntry() { return DicomDict; }; 
 
    /// \brief Sets the print level for the Dicom Header Elements
    /// \note 0 for Light Print; 1 for 'medium' Print, 2 for Heavy
@@ -123,33 +126,25 @@ public:
    int GetPrintLevel() { return PrintLevel; };
    
    virtual void Print (std::ostream & os = std::cout); 
-   virtual void Write(FILE *fp, FileType filetype);
+   virtual void Write(std::ofstream *fp, FileType filetype);
    
    uint32_t GetFullLength();
    
-   void Copy(gdcmDocEntry *doc);
+   void Copy(DocEntry *doc);
 
    bool IsItemDelimitor();
    bool IsSequenceDelimitor();   
 
-   /// \brief Gets the depth level of a Dicom header entry embedded in
-   ///        a SeQuence
-   int GetDepthLevel() { return SQDepthLevel; }
-
-   /// \brief Sets the depth level of a Dicom header entry embedded in
-   ///        a SeQuence
-   void SetDepthLevel(int depth) { SQDepthLevel = depth; }
-
 private:
    // FIXME: In fact we should be more specific and use :
-   // friend gdcmDocEntry * gdcmHeader::ReadNextElement(void);
-   friend class gdcmHeader;    
+   // friend DocEntry * Header::ReadNextElement(void);
+   friend class Header;    
 
 protected:
 // Variables
 
    /// \brief pointer to the underlying Dicom dictionary element
-   gdcmDictEntry *DictEntry;
+   DictEntry *DicomDict;
    
    /// \brief Updated from ReadLength, by FixFoungLentgh() for fixing a bug
    /// in the header or helping the parser going on    
@@ -170,10 +165,11 @@ protected:
 
    /// How many details are to be printed (value : 0,1,2)      
    int PrintLevel;
-   
-   /// Gives the depth level of elements inside SeQuences   
-   int SQDepthLevel;
-};
 
+   /// \brief Generalized key of this DocEntry (for details on
+   ///        the generalized key refer to \ref TagKey documentation).
+   TagKey Key;
+};
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif