src/gdcmDocEntry.h

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