Program: gdcm
Module: $RCSfile: gdcmDocEntry.h,v $
Language: C++
- Date: $Date: 2004/09/15 03:50:48 $
- Version: $Revision: 1.21 $
+ Date: $Date: 2005/11/28 16:31:23 $
+ Version: $Revision: 1.58 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
- http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+ http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
#ifndef GDCMDOCENTRY_H
#define GDCMDOCENTRY_H
-#include <iostream>
-#include <stdio.h>
-
+#include "gdcmRefCounter.h"
#include "gdcmDictEntry.h"
-class gdcmHeader;
-class gdcmValEntry;
-class gdcmBinEntry;
-class gdcmSeqEntry;
+#include <iostream>
+#include <fstream>
+
+namespace gdcm
+{
+class File;
+class SeqEntry;
//-----------------------------------------------------------------------------
/**
- * \ingroup gdcmDocEntry
* \brief The dicom header of a Dicom file contains a set of such entries
* (when successfuly parsed against a given Dicom dictionary)
*/
-class GDCM_EXPORT gdcmDocEntry
+class GDCM_EXPORT DocEntry : public RefCounter
{
+ gdcmTypeMacro(DocEntry);
+
public:
- gdcmDocEntry(gdcmDictEntry*);
- virtual ~gdcmDocEntry() {};
+ virtual void Print (std::ostream &os = std::cout, std::string const &indent = "");
+ virtual void WriteContent(std::ofstream *fp, FileType filetype);
- /// Returns the Dicom Group number of the current Dicom Header Entry
- uint16_t GetGroup() { return DictEntry->GetGroup(); };
+ /// \brief Gets the DicEntry of the current Dicom entry
+ /// @return The DicEntry of the current Dicom entry
+ DictEntry * GetDictEntry() { return DicomDict; }
- /// Returns the Dicom Element number of the current Dicom Header Entry
- uint16_t GetElement() { return DictEntry->GetElement();};
+ /// Returns the Dicom Group number of the current Dicom entry
+ const uint16_t &GetGroup() const { return DicomDict->GetGroup(); }
- /// Returns the 'key' of the current Dicom Header Entry
- void SetKey( gdcmTagKey key ) { Key = key; }
+ /// Returns the Dicom Element number of the current Dicom entry
+ const uint16_t &GetElement() const { return DicomDict->GetElement();}
- /// Returns the 'key' of the current Dicom Header Entry
- std::string GetKey() { return Key; }
+ /// Returns the 'key' of the current Dicom entry
+ TagKey GetKey() const { return DicomDict->GetKey(); }
/// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
/// Dictionnary of the current Dicom Header Entry
- std::string GetName() { return DictEntry->GetName(); };
+ std::string const &GetName() const { return DicomDict->GetName(); }
/// \brief Returns the 'Value Representation' (e.g. "PN" : Person Name,
- /// "SL" : Signed Long), found in the Dicom Header or in the Dicom
- /// Dictionnary, of the current Dicom Header Entry
- std::string GetVR() { return DictEntry->GetVR(); };
+ /// "SL" : Signed Long), found in the Dicom header or in the Dicom
+ /// Dictionnary, of the current Dicom entry
+ VRKey const &GetVR() const { return DicomDict->GetVR(); }
+
+ /// \brief Returns the 'Value Multiplicity' (e.g. "1", 6", "1-n", "3-n"),
+ /// found in the Dicom entry or in the Dicom Dictionnary
+ /// of the current Dicom entry
+ std::string const &GetVM() const { return DicomDict->GetVM(); }
+
+ /// Sets the 'Value Multiplicity' of the current Dicom entry
+ void SetVM( TagName const &v) { DicomDict->SetVM(v); }
/// \brief Returns offset (since the beginning of the file, including
- /// the File Preamble, if any) of the value of the current Dicom HeaderEntry
- /// \warning offset of the *value*, not of the Dicom Header Entry
- size_t GetOffset() { return Offset; };
-
- /// \brief Returns the actual value length of the current Dicom Header Entry
- /// \warning this value is not *always* the one stored in the Dicom Header
- /// in case of well knowned bugs
- uint32_t GetLength() { return UsableLength; };
-
- /// \brief Returns the 'read length' of the current Dicom Header Entry
- /// \warning this value is the one stored in the Dicom Header but not
+ /// the File Preamble, if any) of the value of the current Dicom entry
+ /// \warning offset of the *value*, not of the Dicom entry
+ const size_t &GetOffset() const { return Offset; }
+
+ /// \brief Sets only 'Read Length' (*not* 'Usable Length') of the current
+ /// Dicom entry
+ void SetReadLength(uint32_t l) { ReadLength = l; }
+ /// \brief Returns the 'read length' of the current Dicom entry
+ /// \warning this value is the one stored in the Dicom header but not
/// mandatoryly the one thats's used (in case on SQ, or delimiters,
/// the usable length is set to zero)
- uint32_t GetReadLength() { return ReadLength; };
-
- /// Sets the 'Value Representation' of the current Dicom Header Entry
- void SetVR(std::string const & v) { DictEntry->SetVR(v); };
+ const uint32_t &GetReadLength() const { return ReadLength; }
/// \brief Sets both 'Read Length' and 'Usable Length' of the current
- /// Dicom Header Entry
- void SetLength(uint32_t l) { ReadLength = UsableLength = l;};
-
- // The following 3 members, for internal use only !
-
- /// \brief Sets only 'Read Length' (*not* 'Usable Length') of the current
- /// Dicom Header Entry
- void SetReadLength(uint32_t l) { ReadLength = l; };
+ /// Dicom entry
+ virtual void SetLength(uint32_t l) { Length = l; }
+ /// \brief Returns the actual value length of the current Dicom entry
+ /// \warning this value is not *always* the one stored in the Dicom header
+ /// in case of well known bugs
+ const uint32_t &GetLength() const { return Length; }
- /// \brief Sets only 'Usable Length' (*not* 'Read Length') of the current
- /// Dicom Header Entry
- void SetUsableLength(uint32_t l) { UsableLength = l; };
-
- /// \brief Sets the offset of the Dicom Element
+ uint32_t GetFullLength();
+ virtual uint32_t ComputeFullLength() = 0;
+
+// The following 3 members, for internal use only !
+ /// \brief Sets the offset of the Dicom entry
/// \warning use with caution !
/// @param of offset to be set
- void SetOffset(size_t of) { Offset = of; };
+ void SetOffset(size_t of) { Offset = of; }
- /// Sets to TRUE the ImplicitVr flag of the current Dicom Element
- void SetImplicitVR() { ImplicitVR = true; };
+ /// Sets to TRUE the ImplicitVr flag of the current Dicom entry
+ void SetImplicitVR() { ImplicitVR = true; }
- /// \brief Tells us if the current Dicom Element was checked as ImplicitVr
- /// @return true if the current Dicom Element was checked as ImplicitVr
- bool IsImplicitVR() { return ImplicitVR; };
+ /// \brief Tells us if the current Dicom entry was checked as ImplicitVr
+ /// @return true if the current Dicom entry was checked as ImplicitVr
+ bool IsImplicitVR() const { return ImplicitVR; }
- /// \brief Tells us if the VR of the current Dicom Element is Unknown
+ /// \brief Tells us if the VR of the current Dicom entry is Unknown
/// @return true if the VR is unknown
- bool IsVRUnknown() { return DictEntry->IsVRUnknown(); };
-
- /// \brief Sets the DicEntry of the current Dicom Element
- /// @param newEntry pointer to the DictEntry
- void SetDictEntry(gdcmDictEntry *newEntry) { DictEntry = newEntry; };
-
- /// \brief Gets the DicEntry of the current Dicom Element
- /// @return The DicEntry of the current Dicom Element
- gdcmDictEntry * GetDictEntry() { return DictEntry; };
-
- /// \brief Sets the print level for the Dicom Header Elements
- /// \note 0 for Light Print; 1 for 'medium' Print, 2 for Heavy
- void SetPrintLevel(int level) { PrintLevel = level; };
+ bool IsVRUnknown() const { return DicomDict->IsVRUnknown(); }
- /// \brief Gets the print level for the Dicom Header Elements
- int GetPrintLevel() { return PrintLevel; };
-
- virtual void Print (std::ostream & os = std::cout);
- virtual void Write(FILE *fp, FileType filetype);
-
- uint32_t GetFullLength();
-
- void Copy(gdcmDocEntry *doc);
+ /// \brief Tells us if the VM of the current Dicom entry is Unknown
+ /// @return true if the VM is unknown
+ bool IsVMUnknown() const { return DicomDict->IsVMUnknown(); }
bool IsItemDelimitor();
+ bool IsItemStarter();
bool IsSequenceDelimitor();
-
-private:
- // FIXME: In fact we should be more specific and use :
- // friend gdcmDocEntry * gdcmHeader::ReadNextElement(void);
- friend class gdcmHeader;
+
+ virtual void Copy(DocEntry *e);
protected:
-// Variables
+ DocEntry(DictEntry*);
+ virtual ~DocEntry();
/// \brief pointer to the underlying Dicom dictionary element
- gdcmDictEntry *DictEntry;
+ DictEntry *DicomDict;
- /// \brief Updated from ReadLength, by FixFoungLentgh() for fixing a bug
- /// in the header or helping the parser going on
- uint32_t UsableLength;
+ /// \brief Correspond to the real length of the data
+ /// This length might always be even
+ uint32_t Length;
- /// \brief Length actually read on disk (before FixFoundLength). ReadLength
- /// will be updated only when FixFoundLength actually fixes a bug in the
- /// header, not when it performs a trick to help the Parser going on.
+ /// \brief Length to read in the file to obtain data
uint32_t ReadLength;
/// \brief Even when reading explicit vr files, some elements happen to
/// breaking the underlying dictionary.
bool ImplicitVR;
- /// Offset from the begining of file for direct user access
+ /// Offset from the beginning of file for direct user access
size_t Offset;
- /// How many details are to be printed (value : 0,1,2)
- int PrintLevel;
-
- /// \brief Generalized key (i.e. a gdcmBaseTagKey prepending a gdcmTagKey)
- /// of this gdcmDocEntry
- gdcmTagKey Key;
+private:
};
-
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff