src/gdcmDocEntry.h

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