1 /*=========================================================================
4 Module: $RCSfile: gdcmDataEntry.h,v $
6 Date: $Date: 2005/11/07 09:46:36 $
7 Version: $Revision: 1.7 $
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.
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.
17 =========================================================================*/
19 #ifndef GDCMDATAENTRY_H
20 #define GDCMDATAENTRY_H
22 #include "gdcmDocEntry.h"
28 //-----------------------------------------------------------------------------
30 * \brief Any Dicom Document (File or DicomDir, or ...) contains
31 * a set of DocEntry - Dicom entries -
32 * (when successfuly parsed against a given Dicom dictionary)
33 * DataEntry is an elementary DocEntry (as opposed to SeqEntry).
34 * Depending on the type of its content,
36 class GDCM_EXPORT DataEntry : public DocEntry
38 gdcmTypeMacro(DataEntry);
41 static DataEntry *New(DictEntry *e) {return new DataEntry(e);}
42 static DataEntry *New(DocEntry *d) {return new DataEntry(d);}
45 void Print(std::ostream &os = std::cout, std::string const &indent = "");
48 virtual void WriteContent(std::ofstream *fp, FileType filetype);
49 uint32_t ComputeFullLength();
52 /// Sets the value (string) of the current Dicom entry
53 //virtual void SetValue(std::string const &val);
54 /// \brief Returns the 'Value' (e.g. "Dupond^Marcel") converted
55 /// into a 'string', event if it's physically stored on disk as an integer
56 /// (e.g. : 0x000c returned as "12")
57 //virtual std::string const &GetValue() const { return Value; }
59 /// \brief Returns the area value of the current Dicom Entry
60 /// when it's not string-translatable (e.g : LUT table, overlay, icon)
61 uint8_t *GetBinArea() { return BinArea; }
62 void SetBinArea( uint8_t *area, bool self = true );
63 void CopyBinArea( uint8_t *area, uint32_t length );
65 void SetValue(const uint32_t &id,const double &val);
66 double GetValue(const uint32_t &id) const;
67 uint32_t GetValueCount(void) const;
68 bool IsValueCountValid() const;
70 void SetString(std::string const &value);
71 std::string const &GetString() const;
73 /// \brief Sets SelfArea
74 void SetSelfArea(bool area) { SelfArea = area; }
75 /// \brief True if Entry owns its BinArea
76 bool IsSelfArea() { return SelfArea; }
78 ///\brief values for current state of a DataEntry (internal use only)
82 STATE_NOTLOADED = 0x01,
87 ///\brief values for current pixel status of a DataEntry (internal use only)
95 void SetState(const TValueState &state) { State = state; }
96 const TValueState &GetState() const { return State; }
97 /// \brief true when value Entry not loaded
98 bool IsNotLoaded() { return State == STATE_NOTLOADED; }
99 /// \brief true if Entry not found
100 bool IsUnfound() { return State == STATE_UNFOUND; }
101 /// \brief true if Entry not read
102 bool IsUnread() { return State == STATE_UNREAD; }
103 /// \brief true if Entry value properly loaded
104 bool IsGoodValue() { return State == 0; }
107 /// \brief sets the 'pixel data flag'
108 void SetFlag(const TValueFlag &flag) { Flag = flag; }
109 /// \brief returns the 'pixel data flag'
110 const TValueFlag &GetFlag() const { return Flag; }
111 /// \brief true id Entry is a Pixel Data entry
112 bool IsPixelData() { return (Flag & FLAG_PIXELDATA) != 0; }
114 void Copy(DocEntry *doc);
116 /// \brief returns the size threshold above which an element value
117 /// will NOT be *printed* in order no to polute the screen output
118 static const uint32_t &GetMaxSizePrintEntry() { return MaxSizePrintEntry; }
119 /// \brief Header Elements too long will not be printed
120 static void SetMaxSizePrintEntry(const uint32_t &size) { MaxSizePrintEntry = size; }
123 DataEntry(DictEntry *e);
124 DataEntry(DocEntry *d);
128 void NewBinArea(void);
129 void DeleteBinArea(void);
132 /// \brief memory area to hold 'non std::string' representable values
133 /// (ie : Lookup Tables, overlays, icons)
135 /// \brief Whether DataEntry has its own BinArea or not
137 /// \brief std::string representable value of the Entry.
138 /// Parts of a multivaluated data are separated by back-slash
139 mutable std::string StrArea;
142 /// \brief 0 for straight entries, FLAG_PIXELDATA for Pixel Data entries
144 /// \brief Entry status : STATE_NOTLOADED,STATE_UNFOUND, STATE_UNREAD, 0
147 /// \brief Size threshold above which an element val
148 /// By default, this upper bound is fixed to 64 bytes.
149 static uint32_t MaxSizePrintEntry;
152 } // end namespace gdcm
154 //-----------------------------------------------------------------------------