src/gdcmDocEntry.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocEntry.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/28 15:10:56 $
   7   Version:   $Revision: 1.42 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMDOCENTRY_H
  20 #define GDCMDOCENTRY_H
  21
  22 #include "gdcmBase.h"
  23 #include "gdcmDictEntry.h"
  24
  25 #include <iostream>
  26 #include <fstream>
  27
  28 namespace gdcm
  29 {
  30 class File;
  31 class ValEntry;
  32 class BinEntry;
  33 class SeqEntry;
  34
  35 //-----------------------------------------------------------------------------
  36 /**
  37  * \brief   The dicom header of a Dicom file contains a set of such entries
  38  *          (when successfuly parsed against a given Dicom dictionary)
  39  */
  40 class GDCM_EXPORT DocEntry : public Base
  41 {
  42 public:
  43    DocEntry(DictEntry*);
  44    virtual ~DocEntry() {};
  45
  46    /// Returns the Dicom Group number of the current Dicom entry
  47    uint16_t      GetGroup()     { return DicomDict->GetGroup();  };
  48
  49    /// Returns the Dicom Element number of the current Dicom entry
  50    uint16_t      GetElement()   { return DicomDict->GetElement();};
  51
  52    /// Returns the 'key' of the current Dicom entry
  53    void  SetKey( TagKey const &key ) { Key = key; }
  54
  55    /// Returns the 'key' of the current Dicom entry
  56    std::string const &GetKey() const { return Key; }
  57
  58    /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
  59    /// Dictionnary of the current Dicom Header Entry
  60    std::string const &GetName() const { return DicomDict->GetName(); };
  61
  62    /// \brief Returns the 'Value Representation' (e.g. "PN" : Person Name,
  63    /// "SL" : Signed Long), found in the Dicom header or in the Dicom
  64    /// Dictionnary, of the current Dicom entry
  65    std::string const &GetVR() const { return DicomDict->GetVR(); };
  66
  67    /// \brief Returns the 'Value Multiplicity' (e.g. "1", "1-n", "6"),
  68    /// found in the Dicom entry or in the Dicom Dictionnary
  69    /// of the current Dicom entry
  70    std::string const &GetVM() const { return DicomDict->GetVM(); };
  71
  72    /// Sets the 'Value Multiplicity' of the current Dicom entry
  73    void SetVM( TagName const &v) { DicomDict->SetVM(v); };
  74
  75    /// \brief Returns offset (since the beginning of the file, including
  76    /// the File Preamble, if any) of the value of the current Dicom entry
  77    /// \warning offset of the *value*, not of the Dicom entry
  78    size_t GetOffset() { return Offset; };
  79
  80
  81    /// \brief Sets only 'Read Length' (*not* 'Usable Length') of the current
  82    /// Dicom entry
  83    void SetReadLength(uint32_t l) { ReadLength = l; };
  84
  85    /// \brief Returns the 'read length' of the current Dicom entry
  86    /// \warning this value is the one stored in the Dicom header but not
  87    ///          mandatoryly the one thats's used (in case on SQ, or delimiters,
  88    ///          the usable length is set to zero)
  89    uint32_t GetReadLength() { return ReadLength; };
  90
  91    /// \brief Sets both 'Read Length' and 'Usable Length' of the current
  92    /// Dicom entry
  93    void SetLength(uint32_t l) { Length = l; };
  94
  95    /// \brief Returns the actual value length of the current Dicom entry
  96    /// \warning this value is not *always* the one stored in the Dicom header
  97    ///          in case of well knowned bugs
  98    uint32_t GetLength() { return Length; };
  99
 100
 101    // The following 3 members, for internal use only !
 102
 103    /// \brief   Sets the offset of the Dicom entry
 104    /// \warning use with caution !
 105    /// @param   of offset to be set
 106    void SetOffset(size_t of) { Offset = of; };
 107
 108    /// Sets to TRUE the ImplicitVr flag of the current Dicom entry
 109    void SetImplicitVR() { ImplicitVR = true; };
 110
 111    /// \brief Tells us if the current Dicom entry was checked as ImplicitVr
 112    /// @return true if the current Dicom entry was checked as ImplicitVr
 113    bool IsImplicitVR() { return ImplicitVR; };
 114
 115    /// \brief Tells us if the VR of the current Dicom entry is Unknown
 116    /// @return true if the VR is unknown
 117    bool IsVRUnknown() { return DicomDict->IsVRUnknown(); };
 118
 119    /// \brief Tells us if the VM of the current Dicom entry is Unknown
 120    /// @return true if the VM is unknown
 121    bool IsVMUnknown() { return DicomDict->IsVMUnknown(); };
 122
 123    /// \brief  Gets the DicEntry of the current Dicom entry
 124    /// @return The DicEntry of the current Dicom entry
 125    DictEntry * GetDictEntry() { return DicomDict; };
 126
 127    virtual void WriteContent(std::ofstream *fp, FileType filetype);
 128
 129    uint32_t GetFullLength();
 130
 131    virtual void Copy(DocEntry *doc);
 132
 133    bool IsItemDelimitor();
 134    bool IsSequenceDelimitor();
 135
 136    virtual void Print (std::ostream &os = std::cout, std::string const & indent = "");
 137
 138 protected:
 139    /// \brief pointer to the underlying Dicom dictionary element
 140    DictEntry *DicomDict;
 141
 142    /// \brief Correspond to the real length of the data
 143    /// This length might always be even
 144    uint32_t Length;
 145
 146    /// \brief Length to read in the file to obtain data
 147    uint32_t ReadLength;
 148
 149    /// \brief Even when reading explicit vr files, some elements happen to
 150    /// be implicit. Flag them here since we can't use the entry->vr without
 151    /// breaking the underlying dictionary.
 152    bool ImplicitVR;
 153
 154    /// Offset from the begining of file for direct user access
 155    size_t Offset;
 156
 157    /// \brief Generalized key of this DocEntry (for details on
 158    ///        the generalized key refer to \ref TagKey documentation).
 159    TagKey Key;
 160
 161 private:
 162 };
 163 } // end namespace gdcm
 164 //-----------------------------------------------------------------------------
 165 #endif