]> Creatis software - gdcm.git/blob - src/gdcmDocEntry.h
ENH: Adding 'gdcm' namespace. Be nice with me this was a ~13000 lines patch. Also...
[gdcm.git] / src / gdcmDocEntry.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDocEntry.h,v $
5   Language:  C++
6   Date:      $Date: 2004/10/12 04:35:45 $
7   Version:   $Revision: 1.25 $
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 "gdcmDictEntry.h"
23 #include <iostream>
24
25 class Header;
26 class ValEntry;
27 class BinEntry;
28 class SeqEntry;
29
30 namespace gdcm 
31 {
32
33
34 //-----------------------------------------------------------------------------
35 /**
36  * \ingroup DocEntry
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
41 {
42 public:
43    DocEntry(DictEntry*);
44    virtual ~DocEntry() {};
45
46    /// Returns the Dicom Group number of the current Dicom Header Entry
47    uint16_t      GetGroup()     { return DicomDict->GetGroup();  };
48
49    /// Returns the Dicom Element number of the current Dicom Header Entry
50    uint16_t      GetElement()   { return DicomDict->GetElement();};
51
52    /// Returns the 'key' of the current Dicom Header Entry
53    void  SetKey( TagKey key ) { Key = key; }
54
55    /// Returns the 'key' of the current Dicom Header Entry
56    std::string GetKey() { 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  GetName()      { 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 Header Entry
65    std::string  GetVR()        { return DicomDict->GetVR();     };
66
67    /// \brief Returns offset (since the beginning of the file, including
68    /// the File Preamble, if any) of the value of the current Dicom HeaderEntry
69    /// \warning offset of the *value*, not of the Dicom Header Entry
70    size_t       GetOffset()    { return Offset;             };
71
72    /// \brief Returns the actual value length of the current Dicom Header Entry
73    /// \warning this value is not *always* the one stored in the Dicom Header
74    ///          in case of well knowned bugs
75    uint32_t GetLength() { return UsableLength; };
76     
77    /// \brief Returns the 'read length' of the current Dicom Header Entry
78    /// \warning this value is the one stored in the Dicom Header but not
79    ///          mandatoryly the one thats's used (in case on SQ, or delimiters,
80    ///          the usable length is set to zero)
81    uint32_t GetReadLength() { return ReadLength; };
82
83    /// Sets the 'Value Representation' of the current Dicom Header Entry
84    void SetVR(std::string const & v) { DicomDict->SetVR(v); };    
85
86    /// \brief Sets both 'Read Length' and 'Usable Length' of the current
87    /// Dicom Header Entry
88    void SetLength(uint32_t l) { ReadLength = UsableLength = l;};
89       
90    // The following 3 members, for internal use only ! 
91    
92    /// \brief Sets only 'Read Length' (*not* 'Usable Length') of the current
93    /// Dicom Header Entry
94    void SetReadLength(uint32_t l) { ReadLength = l; };
95
96    /// \brief Sets only 'Usable Length' (*not* 'Read Length') of the current
97    /// Dicom Header Entry
98    void SetUsableLength(uint32_t l) { UsableLength = l; }; 
99    
100    /// \brief   Sets the offset of the Dicom Element
101    /// \warning use with caution !
102    /// @param   of offset to be set
103    void SetOffset(size_t of) { Offset = of; };
104
105    /// Sets to TRUE the ImplicitVr flag of the current Dicom Element
106    void SetImplicitVR() { ImplicitVR = true; };
107  
108    /// \brief Tells us if the current Dicom Element was checked as ImplicitVr
109    /// @return true if the current Dicom Element was checked as ImplicitVr
110    bool IsImplicitVR() { return ImplicitVR; };
111
112    /// \brief Tells us if the VR of the current Dicom Element is Unknown
113    /// @return true if the VR is unknown
114    bool IsVRUnknown() { return DicomDict->IsVRUnknown(); };
115
116    /// \brief   Sets the DicEntry of the current Dicom Element
117    /// @param   newEntry pointer to the DictEntry
118    void SetDictEntry(DictEntry *newEntry) { DicomDict = newEntry; };
119
120    /// \brief  Gets the DicEntry of the current Dicom Element
121    /// @return The DicEntry of the current Dicom Element
122    DictEntry * GetDictEntry() { return DicomDict; }; 
123
124    /// \brief Sets the print level for the Dicom Header Elements
125    /// \note 0 for Light Print; 1 for 'medium' Print, 2 for Heavy
126    void SetPrintLevel(int level) { PrintLevel = level; };
127
128    /// \brief Gets the print level for the Dicom Header Elements
129    int GetPrintLevel() { return PrintLevel; };
130    
131    virtual void Print (std::ostream & os = std::cout); 
132    virtual void Write(FILE *fp, FileType filetype);
133    
134    uint32_t GetFullLength();
135    
136    void Copy(DocEntry *doc);
137
138    bool IsItemDelimitor();
139    bool IsSequenceDelimitor();   
140
141 private:
142    // FIXME: In fact we should be more specific and use :
143    // friend DocEntry * Header::ReadNextElement(void);
144    friend class Header;    
145
146 protected:
147 // Variables
148
149    /// \brief pointer to the underlying Dicom dictionary element
150    DictEntry *DicomDict;
151    
152    /// \brief Updated from ReadLength, by FixFoungLentgh() for fixing a bug
153    /// in the header or helping the parser going on    
154    uint32_t UsableLength; 
155   
156    /// \brief Length actually read on disk (before FixFoundLength). ReadLength
157    /// will be updated only when FixFoundLength actually fixes a bug in the
158    /// header, not when it performs a trick to help the Parser going on.
159    uint32_t ReadLength;
160
161    /// \brief Even when reading explicit vr files, some elements happen to
162    /// be implicit. Flag them here since we can't use the entry->vr without
163    /// breaking the underlying dictionary.
164    bool ImplicitVR;
165
166    /// Offset from the begining of file for direct user access
167    size_t Offset; 
168
169    /// How many details are to be printed (value : 0,1,2)      
170    int PrintLevel;
171
172    /// \brief Generalized key (i.e. a BaseTagKey prepending a TagKey)
173    ///        of this DocEntry
174    TagKey Key;
175 };
176 } // end namespace gdcm
177 //-----------------------------------------------------------------------------
178 #endif