X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDataEntry.h;h=eba677c719869b9995c90711a2dc1f84e7cf4f2c;hb=0e030c69b4fec60eaf0c92a6c1701a3e8de5e794;hp=7bd598302a1cb02dc72cfa1ef3670c3ccb6829c7;hpb=4331b970c740503e6827e72a172101a86d630907;p=gdcm.git

diff --git a/src/gdcmDataEntry.h b/src/gdcmDataEntry.h
index 7bd59830..eba677c7 100644
--- a/src/gdcmDataEntry.h
+++ b/src/gdcmDataEntry.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDataEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/10/21 14:09:41 $
-  Version:   $Revision: 1.3 $
+  Date:      $Date: 2005/11/14 14:23:43 $
+  Version:   $Revision: 1.9 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -27,7 +27,7 @@ namespace gdcm
 {
 //-----------------------------------------------------------------------------
 /**
- * \brief   Any Dicom Document (File or DicomDir) contains 
+ * \brief   Any Dicom Document (File or DicomDir, or ...) contains 
  *           a set of DocEntry  - Dicom entries -
  *           (when successfuly parsed against a given Dicom dictionary)
  *          DataEntry is an elementary DocEntry (as opposed to SeqEntry).
@@ -35,19 +35,21 @@ namespace gdcm
  */
 class GDCM_EXPORT DataEntry  : public DocEntry
 {
+   gdcmTypeMacro(DataEntry);
+
 public:
-   DataEntry(DictEntry *e);
-   DataEntry(DocEntry *d); 
-   ~DataEntry();
+   static DataEntry *New(DictEntry *e) {return new DataEntry(e);}
+   static DataEntry *New(DocEntry *d)  {return new DataEntry(d);}
 
 // Print
    void Print(std::ostream &os = std::cout, std::string const &indent = "");
 
 // Write
    virtual void WriteContent(std::ofstream *fp, FileType filetype);
-
-// Set/Get datas
-   /// Sets the value (string) of the current Dicom entry
+   uint32_t ComputeFullLength();
+   
+// Set/Get data
+   // Sets the value (string) of the current Dicom entry
    //virtual void SetValue(std::string const &val);
    /// \brief Returns the 'Value' (e.g. "Dupond^Marcel") converted 
    /// into a 'string', event if it's physically stored on disk as an integer
@@ -55,7 +57,7 @@ public:
    //virtual std::string const &GetValue() const { return Value; }
 
    /// \brief Returns the area value of the current Dicom Entry
-   ///  when it's not string-translatable (e.g : LUT table, overlay, icon)         
+   ///  when it's not string-translatable (e.g : LUT table, overlay, icon)   
    uint8_t *GetBinArea()  { return BinArea; }
    void SetBinArea( uint8_t *area, bool self = true );
    void CopyBinArea( uint8_t *area, uint32_t length );
@@ -70,21 +72,44 @@ public:
 
    /// \brief Sets SelfArea
    void SetSelfArea(bool area) { SelfArea = area; }
-   /// \brief Returns SelfArea
+   /// \brief True if Entry owns its BinArea
    bool IsSelfArea() { return SelfArea; }
 
+   ///\brief values for current state of a DataEntry (internal use only)
+   enum TValueState
+   {
+      STATE_LOADED    = 0x00,
+      STATE_NOTLOADED = 0x01,
+      STATE_UNFOUND   = 0x02,
+      STATE_UNREAD    = 0x03
+   };
+   
+   ///\brief values for current pixel status of a DataEntry (internal use only)
+   enum TValueFlag
+   {
+      FLAG_NONE       = 0x00,
+      FLAG_PIXELDATA  = 0x01
+   };
+
    // State
-   void SetState(const char &state) { State = state; }
-   const char &GetState() const { return State; }
+   void SetState(const TValueState &state) { State = state; }
+   const TValueState &GetState() const { return State; }
+   /// \brief true when value Entry not loaded  
    bool IsNotLoaded() { return State == STATE_NOTLOADED; }
+   /// \brief true if Entry not found  
    bool IsUnfound()   { return State == STATE_UNFOUND; }
+   /// \brief true if Entry not read    
    bool IsUnread()    { return State == STATE_UNREAD; }
-   bool IsGoodValue() { return State == 0; }
+   /// \brief true if Entry value properly loaded
+   bool IsGoodValue() { return State == STATE_LOADED; }
 
    // Flags
-   void SetFlag(const char &flag) { Flag = flag; }
-   const char &GetFlag() const { return Flag; }
-   bool IsPixelData() { return (Flag & FLAG_PIXELDATA) != 0; }
+   /// \brief sets the 'pixel data flag'   
+   void SetFlag(const TValueFlag &flag) { Flag = flag; }
+   /// \brief returns the 'pixel data flag'    
+   const TValueFlag &GetFlag() const { return Flag; }
+   /// \brief true id Entry is a Pixel Data entry
+   bool IsPixelData() { return (Flag &FLAG_PIXELDATA) != 0; }
 
    void Copy(DocEntry *doc);
 
@@ -92,23 +117,14 @@ public:
    ///        will NOT be *printed* in order no to polute the screen output
    static const uint32_t &GetMaxSizePrintEntry() { return MaxSizePrintEntry; }
    /// \brief Header Elements too long will not be printed
-   static void SetMaxSizePrintEntry(const uint32_t &size) { MaxSizePrintEntry = size; }
-
-   typedef enum
-   {
-      STATE_LOADED    = 0x00,
-      STATE_NOTLOADED = 0x01,
-      STATE_UNFOUND   = 0x02,
-      STATE_UNREAD    = 0x03
-   } TValueState;
-
-   typedef enum
-   {
-      FLAG_NONE       = 0x00,
-      FLAG_PIXELDATA  = 0x01
-   } TValueFlag;
+   static void SetMaxSizePrintEntry(const uint32_t &size) 
+                                                 { MaxSizePrintEntry = size; }
 
 protected:
+   DataEntry(DictEntry *e);
+   DataEntry(DocEntry *d); 
+   ~DataEntry();
+
 // Methods :
    void NewBinArea(void);
    void DeleteBinArea(void);
@@ -119,12 +135,15 @@ protected:
    uint8_t *BinArea;
    /// \brief Whether DataEntry has its own BinArea or not
    bool SelfArea;
-
+   /// \brief  std::string representable value of the Entry. 
+   ///        Parts of a multivaluated data are separated by back-slash
    mutable std::string StrArea;
 
 private:
-   char Flag;
-   char State;
+   /// \brief 0 for straight entries, FLAG_PIXELDATA for Pixel Data entries
+   TValueFlag Flag;
+   /// \brief Entry status:STATE_NOTLOADED,STATE_UNFOUND,STATE_UNREAD,STATE_LOADED
+   TValueState State;
 
    /// \brief Size threshold above which an element val
    ///        By default, this upper bound is fixed to 64 bytes.