]> Creatis software - gdcm.git/blob - src/gdcmDocEntry.h
In order to allow to use current version (1.3) of gdcm *and* ITK (that includes
[gdcm.git] / src / gdcmDocEntry.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDocEntry.h,v $
5   Language:  C++
6   Date:      $Date: 2007/05/23 14:18:09 $
7   Version:   $Revision: 1.67 $
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 "gdcmRefCounter.h"
23 #include "gdcmDictEntry.h"
24
25 #include <iostream>
26 #include <fstream>
27
28 namespace GDCM_NAME_SPACE 
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 RefCounter
39 {
40    gdcmTypeMacro(DocEntry);
41
42 public:
43    virtual void Print (std::ostream &os = std::cout, std::string const &indent = ""); 
44    virtual void WriteContent(std::ofstream *fp, FileType filetype);
45
46    /// \brief  Gets the DicEntry of the current Dicom entry
47    /// @return The DicEntry of the current Dicom entry
48    DictEntry * GetDictEntry() { return DicomDict; } 
49
50    /// Returns the Dicom Group number of the current Dicom entry
51    uint16_t const &GetGroup() const   { return Key[0];  }
52    //const uint16_t &GetGroup() const   { return DicomDict->GetGroup();  }
53
54    /// Returns the Dicom Element number of the current Dicom entry
55    uint16_t const &GetElement() const { return Key[1];}   
56    //const uint16_t &GetElement() const { return DicomDict->GetElement();}
57
58    /// Returns the 'key' of the current Dicom entry
59    TagKey const &GetKey() const { return Key; }   
60    //TagKey GetKey() const { return DicomDict->GetKey(); }
61
62    /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
63    /// Dictionnary of the current Dicom Header Entry
64    std::string const &GetName();
65
66    /// \brief Returns the 'Value Representation' (e.g. "PN" : Person Name,
67    /// "SL" : Signed Long), found in the Dicom header or in the Dicom
68    /// Dictionnary, of the current Dicom entry
69    VRKey const &GetVR() const { return VR; }   
70    //VRKey const &GetVR() const { return DicomDict->GetVR(); }
71
72    /// \brief Returns the 'Value Multiplicity' (e.g. "1", "6", "1-n", "3-n"),
73    /// found in the Dicom entry or in the Dicom Dictionnary
74    /// of the current Dicom entry
75    std::string const &GetVM();
76
77    /// Sets the 'Value Multiplicity' of the current Dicom entry
78    //void SetVM( TagName const &v) { DicomDict->SetVM(v); } 
79    void SetVM( TagName &) { std::cout << "-----------------FIXME : SetVM "; }
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 of 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 known bugs
101    const uint32_t &GetLength() const { return Length; }
102
103    uint32_t GetFullLength();
104    virtual uint32_t ComputeFullLength() = 0;
105
106 // The following members, for internal use only !
107
108    /// \brief   Sets the offset of the Dicom entry
109    /// \warning use with caution !
110    /// @param   of offset to be set
111    void SetOffset(size_t of) { Offset = of; }
112
113    /// Sets to TRUE the ImplicitVr flag of the current Dicom entry
114    void SetImplicitVR() { ImplicitVR = true; }
115  
116     /// Sets the 'Value Representation' of the current Dicom entry
117    /// @param   vr VR to be set    
118    void SetVR( VRKey const &vr) { VR = vr; } 
119
120     /// Sets the 'Value Representation' of the current Dicom entry
121    /// @param   key TagKey to be set
122    void SetTag( TagKey const &key) { Key = key; } 
123   
124 // -----------end of members to be used with caution
125    
126    /// \brief Tells us if the current Dicom entry was checked as ImplicitVr
127    /// @return true if the current Dicom entry was checked as ImplicitVr
128    bool IsImplicitVR() const { return ImplicitVR; }
129
130    /// \brief Tells us if the VR of the current Dicom entry is Unknown
131    /// @return true if the VR is unknown
132 //   bool IsVRUnknown() const { return DicomDict->IsVRUnknown(); }
133      bool IsVRUnknown() const { return VR == GDCM_VRUNKNOWN; }
134
135    /// \brief Tells us if the VM of the current Dicom entry is Unknown
136    /// @return true if the VM is unknown
137 //   bool IsVMUnknown() const { return DicomDict->IsVMUnknown(); }
138    bool IsVMUnknown() { return GetVM() == GDCM_UNKNOWN; }
139
140 /// \brief   tells us if entry is the last one of a 'no length' SequenceItem 
141 ///        (fffe,e00d) 
142    bool IsItemDelimitor() 
143                       {return (GetGroup() == 0xfffe && GetElement() == 0xe00d);}
144 ///\brief   tells us if entry is the last one of a 'no length' Sequence 
145 ///         (fffe,e0dd)       
146    bool IsItemStarter(){ if (GetGroup() != 0xfffe) return false;
147                          return (GetElement() == 0xe000); }
148  /// \brief   tells us if entry is the last one of a 'no length' Sequence 
149  ///          (fffe,e0dd) 
150    bool IsSequenceDelimitor() { return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);}  
151
152    virtual void Copy(DocEntry *doc);
153
154 protected:
155   // DocEntry(DictEntry*);
156    DocEntry(uint16_t group, uint16_t elem, VRKey const &vr);
157    virtual ~DocEntry();
158
159    /// \brief pointer to the underlying Dicom dictionary element
160    DictEntry *DicomDict;
161       
162    /// \brief Corresponds to the real length of the data
163    /// This length might always be even
164    uint32_t Length; 
165   
166    /// \brief Length to read in the file to obtain data
167    uint32_t ReadLength;
168
169    /// \brief Even when reading explicit vr files, some elements happen to
170    /// be implicit. Flag them here since we can't use the entry->vr without
171    /// breaking the underlying dictionary.
172    bool ImplicitVR;
173
174    /// Offset from the beginning of file for direct user access
175    size_t Offset; 
176
177    /// \brief Value Representation (to avoid accessing Dicom Dict every time!)
178    VRKey VR; // JPRx
179       
180    /// \brief Dicom \ref TagKey. Contains Dicom Group number and Dicom Element number
181    ///        (to avoid accessing Dicom Dict every time !) // JPRx
182    TagKey Key; // JPRx
183 private:
184
185 };
186 } // end namespace gdcm
187 //-----------------------------------------------------------------------------
188 #endif