Doxygenation

[gdcm.git] / src / gdcmDocEntry.h

diff --git a/src/gdcmDocEntry.h b/src/gdcmDocEntry.h
index e3ea3ccff5b8f437924460d684988825b5a3c74e..52707ee18d17733f724079e26467456cb5160133 100644 (file)
--- a/src/gdcmDocEntry.h
+++ b/src/gdcmDocEntry.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntry.h,v $
   Language:  C++
-  Date:      $Date: 2004/10/12 04:35:45 $
-  Version:   $Revision: 1.25 $
+  Date:      $Date: 2004/12/16 13:46:37 $
+  Version:   $Revision: 1.33 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -19,25 +19,25 @@
 #ifndef GDCMDOCENTRY_H
 #define GDCMDOCENTRY_H
 
+#include "gdcmBase.h"
 #include "gdcmDictEntry.h"
+
 #include <iostream>
+#include <fstream>
 
+namespace gdcm 
+{
 class Header;
 class ValEntry;
 class BinEntry;
 class SeqEntry;
 
-namespace gdcm 
-{
-
-
 //-----------------------------------------------------------------------------
 /**
- * \ingroup DocEntry
  * \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 DocEntry
+class GDCM_EXPORT DocEntry : public Base
 {
 public:
    DocEntry(DictEntry*);
@@ -50,24 +50,24 @@ public:
    uint16_t      GetElement()   { return DicomDict->GetElement();};
 
    /// Returns the 'key' of the current Dicom Header Entry
-   void  SetKey( TagKey key ) { Key = key; }
+   void  SetKey( TagKey const & key ) { Key = key; }
 
    /// Returns the 'key' of the current Dicom Header Entry
-   std::string GetKey() { return Key; }
+   std::string const & GetKey() const { return Key; }
 
    /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
    /// Dictionnary of the current Dicom Header Entry
-   std::string  GetName()      { return DicomDict->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 DicomDict->GetVR();     };
+   std::string const & GetVR() const { return DicomDict->GetVR(); };
 
    /// \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;             };
+   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
@@ -81,11 +81,11 @@ public:
    uint32_t GetReadLength() { return ReadLength; };
 
    /// Sets the 'Value Representation' of the current Dicom Header Entry
-   void SetVR(std::string const & v) { DicomDict->SetVR(v); };    
+   void SetVR( TagName const & v) { DicomDict->SetVR(v); };    
 
    /// \brief Sets both 'Read Length' and 'Usable Length' of the current
    /// Dicom Header Entry
-   void SetLength(uint32_t l) { ReadLength = UsableLength = l;};
+   void SetLength(uint32_t l) { ReadLength = UsableLength = l; };
       
    // The following 3 members, for internal use only ! 
    
@@ -120,16 +120,8 @@ public:
    /// \brief  Gets the DicEntry of the current Dicom Element
    /// @return The DicEntry of the current Dicom Element
    DictEntry * GetDictEntry() { return DicomDict; }; 
-
-   /// \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; };
-
-   /// \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);
+   virtual void WriteContent(std::ofstream *fp, FileType filetype);
    
    uint32_t GetFullLength();
    
@@ -138,6 +130,8 @@ public:
    bool IsItemDelimitor();
    bool IsSequenceDelimitor();   
 
+   virtual void Print (std::ostream & os = std::cout); 
+
 private:
    // FIXME: In fact we should be more specific and use :
    // friend DocEntry * Header::ReadNextElement(void);
@@ -166,11 +160,8 @@ protected:
    /// Offset from the begining 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 BaseTagKey prepending a TagKey)
-   ///        of this DocEntry
+   /// \brief Generalized key of this DocEntry (for details on
+   ///        the generalized key refer to \ref TagKey documentation).
    TagKey Key;
 };
 } // end namespace gdcm