]> Creatis software - gdcm.git/blobdiff - src/gdcmDocEntry.h
* Improvement #2 : the CommandManager is now a static class so,
[gdcm.git] / src / gdcmDocEntry.h
index 29a2522eccaebbf9ce8326ae5306412b0cf86b85..c0d4087055b77203acc17f67a5c42a47ea2d7c05 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/09/02 07:10:03 $
-  Version:   $Revision: 1.49 $
+  Date:      $Date: 2005/11/28 16:31:23 $
+  Version:   $Revision: 1.58 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -19,7 +19,7 @@
 #ifndef GDCMDOCENTRY_H
 #define GDCMDOCENTRY_H
 
-#include "gdcmBase.h"
+#include "gdcmRefCounter.h"
 #include "gdcmDictEntry.h"
 
 #include <iostream>
@@ -28,8 +28,6 @@
 namespace gdcm 
 {
 class File;
-class ValEntry;
-class BinEntry;
 class SeqEntry;
 
 //-----------------------------------------------------------------------------
@@ -37,13 +35,11 @@ class SeqEntry;
  * \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 DocEntry : public Base
+class GDCM_EXPORT DocEntry : public RefCounter
 {
-public:
-   DocEntry(DictEntry*);
-   /// \brief Canonical Destructor
-   virtual ~DocEntry() {}
+   gdcmTypeMacro(DocEntry);
 
+public:
    virtual void Print (std::ostream &os = std::cout, std::string const &indent = ""); 
    virtual void WriteContent(std::ofstream *fp, FileType filetype);
 
@@ -52,16 +48,13 @@ public:
    DictEntry * GetDictEntry() { return DicomDict; } 
 
    /// Returns the Dicom Group number of the current Dicom entry
-   uint16_t      GetGroup()     { return DicomDict->GetGroup();  }
+   const uint16_t &GetGroup() const   { return DicomDict->GetGroup();  }
 
    /// Returns the Dicom Element number of the current Dicom entry
-   uint16_t      GetElement()   { return DicomDict->GetElement();}
-
-   /// Set the 'key' of the current Dicom entry
-   void  SetKey( TagKey const &key ) { Key = key; }
+   const uint16_t &GetElement() const { return DicomDict->GetElement();}
 
    /// Returns the 'key' of the current Dicom entry
-   TagKey const &GetKey() const { return Key; }
+   TagKey GetKey() const { return DicomDict->GetKey(); }
 
    /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
    /// Dictionnary of the current Dicom Header Entry
@@ -70,9 +63,9 @@ public:
    /// \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 entry
-   std::string const &GetVR() const { return DicomDict->GetVR(); }
+   VRKey const &GetVR() const { return DicomDict->GetVR(); }
 
-   /// \brief Returns the 'Value Multiplicity' (e.g. "1", "1-n", "6"),
+   /// \brief Returns the 'Value Multiplicity' (e.g. "1", 6", "1-n", "3-n"),
    /// found in the Dicom entry or in the Dicom Dictionnary
    /// of the current Dicom entry
    std::string const &GetVM() const { return DicomDict->GetVM(); }
@@ -83,7 +76,7 @@ public:
    /// \brief Returns offset (since the beginning of the file, including
    /// the File Preamble, if any) of the value of the current Dicom entry
    /// \warning offset of the *value*, not of the Dicom entry
-   size_t GetOffset() { return Offset; }
+   const size_t &GetOffset() const { return Offset; }
 
    /// \brief Sets only 'Read Length' (*not* 'Usable Length') of the current
    /// Dicom entry
@@ -92,17 +85,18 @@ public:
    /// \warning this value is the one stored in the Dicom header but not
    ///          mandatoryly the one thats's used (in case on SQ, or delimiters,
    ///          the usable length is set to zero)
-   uint32_t GetReadLength() { return ReadLength; }
+   const uint32_t &GetReadLength() const { return ReadLength; }
 
    /// \brief Sets both 'Read Length' and 'Usable Length' of the current
    /// Dicom entry
-   void SetLength(uint32_t l) { Length = l; }
+   virtual void SetLength(uint32_t l) { Length = l; }
    /// \brief Returns the actual value length of the current Dicom entry
    /// \warning this value is not *always* the one stored in the Dicom header
-   ///          in case of well knowned bugs
-   uint32_t GetLength() { return Length; }
+   ///          in case of well known bugs
+   const uint32_t &GetLength() const { return Length; }
 
    uint32_t GetFullLength();
+   virtual uint32_t ComputeFullLength() = 0;
 
 // The following 3 members, for internal use only ! 
    /// \brief   Sets the offset of the Dicom entry
@@ -115,15 +109,15 @@ public:
  
    /// \brief Tells us if the current Dicom entry was checked as ImplicitVr
    /// @return true if the current Dicom entry was checked as ImplicitVr
-   bool IsImplicitVR() { return ImplicitVR; }
+   bool IsImplicitVR() const { return ImplicitVR; }
 
    /// \brief Tells us if the VR of the current Dicom entry is Unknown
    /// @return true if the VR is unknown
-   bool IsVRUnknown() { return DicomDict->IsVRUnknown(); }
+   bool IsVRUnknown() const { return DicomDict->IsVRUnknown(); }
 
    /// \brief Tells us if the VM of the current Dicom entry is Unknown
    /// @return true if the VM is unknown
-   bool IsVMUnknown() { return DicomDict->IsVMUnknown(); }
+   bool IsVMUnknown() const { return DicomDict->IsVMUnknown(); }
 
    bool IsItemDelimitor();
    bool IsItemStarter();
@@ -132,6 +126,9 @@ public:
    virtual void Copy(DocEntry *e);
 
 protected:
+   DocEntry(DictEntry*);
+   virtual ~DocEntry();
+
    /// \brief pointer to the underlying Dicom dictionary element
    DictEntry *DicomDict;
    
@@ -150,10 +147,6 @@ protected:
    /// Offset from the beginning of file for direct user access
    size_t Offset; 
 
-   /// \brief Generalized key of this DocEntry (for details on
-   ///        the generalized key refer to \ref TagKey documentation).
-   TagKey Key;
-
 private:
 };
 } // end namespace gdcm