]> Creatis software - gdcm.git/blob - src/gdcmDocEntry.h
* Add GetFirstValEntry + GetNexxtValEntry, for Python users
[gdcm.git] / src / gdcmDocEntry.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDocEntry.h,v $
5   Language:  C++
6   Date:      $Date: 2005/02/04 14:49:01 $
7   Version:   $Revision: 1.46 $
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    /// \brief Canonical Destructor
45    virtual ~DocEntry() {};
46
47    virtual void Print (std::ostream &os = std::cout, std::string const &indent = ""); 
48    virtual void WriteContent(std::ofstream *fp, FileType filetype);
49
50    /// \brief  Gets the DicEntry of the current Dicom entry
51    /// @return The DicEntry of the current Dicom entry
52    DictEntry * GetDictEntry() { return DicomDict; }; 
53
54    /// Returns the Dicom Group number of the current Dicom entry
55    uint16_t      GetGroup()     { return DicomDict->GetGroup();  };
56
57    /// Returns the Dicom Element number of the current Dicom entry
58    uint16_t      GetElement()   { return DicomDict->GetElement();};
59
60    /// Set the 'key' of the current Dicom entry
61    void  SetKey( TagKey const &key ) { Key = key; }
62    /// Returns the 'key' of the current Dicom entry
63    std::string const &GetKey() const { return Key; }
64
65    /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
66    /// Dictionnary of the current Dicom Header Entry
67    std::string const &GetName() const { return DicomDict->GetName(); };
68
69    /// \brief Returns the 'Value Representation' (e.g. "PN" : Person Name,
70    /// "SL" : Signed Long), found in the Dicom header or in the Dicom
71    /// Dictionnary, of the current Dicom entry
72    std::string const &GetVR() const { return DicomDict->GetVR(); };
73
74    /// \brief Returns the 'Value Multiplicity' (e.g. "1", "1-n", "6"),
75    /// found in the Dicom entry or in the Dicom Dictionnary
76    /// of the current Dicom entry
77    std::string const &GetVM() const { return DicomDict->GetVM(); };
78
79    /// Sets the 'Value Multiplicity' of the current Dicom entry
80    void SetVM( TagName const &v) { DicomDict->SetVM(v); }; 
81
82    /// \brief Returns offset (since the beginning of the file, including
83    /// the File Preamble, if any) of the value of the current Dicom entry
84    /// \warning offset of the *value*, not of the Dicom entry
85    size_t GetOffset() { return Offset; };
86
87    /// \brief Sets only 'Read Length' (*not* 'Usable Length') of the current
88    /// Dicom entry
89    void SetReadLength(uint32_t l) { ReadLength = l; };
90    /// \brief Returns the 'read length' of the current Dicom entry
91    /// \warning this value is the one stored in the Dicom header but not
92    ///          mandatoryly the one thats's used (in case on SQ, or delimiters,
93    ///          the usable length is set to zero)
94    uint32_t GetReadLength() { return ReadLength; };
95
96    /// \brief Sets both 'Read Length' and 'Usable Length' of the current
97    /// Dicom entry
98    void SetLength(uint32_t l) { Length = l; };
99    /// \brief Returns the actual value length of the current Dicom entry
100    /// \warning this value is not *always* the one stored in the Dicom header
101    ///          in case of well knowned bugs
102    uint32_t GetLength() { return Length; };
103
104    uint32_t GetFullLength();
105
106 // The following 3 members, for internal use only ! 
107    /// \brief   Sets the offset of the Dicom entry
108    /// \warning use with caution !
109    /// @param   of offset to be set
110    void SetOffset(size_t of) { Offset = of; };
111
112    /// Sets to TRUE the ImplicitVr flag of the current Dicom entry
113    void SetImplicitVR() { ImplicitVR = true; };
114  
115    /// \brief Tells us if the current Dicom entry was checked as ImplicitVr
116    /// @return true if the current Dicom entry was checked as ImplicitVr
117    bool IsImplicitVR() { return ImplicitVR; };
118
119    /// \brief Tells us if the VR of the current Dicom entry is Unknown
120    /// @return true if the VR is unknown
121    bool IsVRUnknown() { return DicomDict->IsVRUnknown(); };
122
123    /// \brief Tells us if the VM of the current Dicom entry is Unknown
124    /// @return true if the VM is unknown
125    bool IsVMUnknown() { return DicomDict->IsVMUnknown(); };
126
127    bool IsItemDelimitor();
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