]> Creatis software - gdcm.git/blobdiff - src/gdcmDataEntry.h
add
[gdcm.git] / src / gdcmDataEntry.h
index 24073836c8d62d5f23f4b5a25c0c04373d4581b2..891f7d5cc3b912e9a0b5a91b87c45166e814b6c1 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDataEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/10/18 08:35:51 $
-  Version:   $Revision: 1.1 $
+  Date:      $Date: 2009/02/05 09:50:09 $
+  Version:   $Revision: 1.22 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
      PURPOSE.  See the above copyright notices for more information.
                                                                                 
 =========================================================================*/
-
-#ifndef GDCMDATAENTRY_H
-#define GDCMDATAENTRY_H
+#ifndef G_DCMDATAENTRY_H_
+#define _GDCMDATAENTRY_H_
 
 #include "gdcmDocEntry.h"
 
+#include <vector> // for GetDSValue
 #include <iostream>
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE 
 {
 //-----------------------------------------------------------------------------
 /**
- * \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,82 +36,111 @@ namespace gdcm
  */
 class GDCM_EXPORT DataEntry  : public DocEntry
 {
-public:
-   DataEntry(DictEntry *e);
-   DataEntry(DocEntry *d); 
-   ~DataEntry();
+   gdcmTypeMacro(DataEntry);
 
+public:
+/// \brief Contructs a DataEntry with a RefCounter from DictEntry
+//   static DataEntry *New(DictEntry *e) {return new DataEntry(e);}
+/// \brief Contructs a DataEntry with a RefCounter from DocEntry
+   static DataEntry *New(DocEntry *d)  {return new DataEntry(d);}
+/// \brief Contructs a DataEntry with a RefCounter from elementary items
+   static DataEntry *New(uint16_t group,uint16_t elem, VRKey const &vr)  
+           {return new DataEntry(group,elem,vr);}
+   
 // 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
+   virtual void WriteContent(std::ofstream *fp, FileType filetype,
+                               bool insideMetaElements, bool insideSequence);
+   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
-   /// (e.g. : 0x000c returned as "12")
-   //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 );
 
    void SetValue(const uint32_t &id,const double &val);
    double GetValue(const uint32_t &id) const;
-   uint32_t GetValueCount(void) const;
+   uint32_t GetValueCount() const;
+   bool IsValueCountValid() /*const*/; // GetVM may update the pointer DicomDict
 
    void SetString(std::string const &value);
    std::string const &GetString() const;
 
+   std::string const &GetHexaRepresentation() const;
+
+   bool IsNumerical();
+   bool GetNumerical(std::vector <double> &valueVector);
+    
    /// \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; }
+   /// \brief Sets the state (Loaded, NotLoaded, UnFound, ...) of the DataEntry
+   void SetState(const TValueState &state) { State = state; }
+   /// \brief Returns the state (Loaded, NotLoaded, ...) of the DataEntry
+   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);
+   virtual void Copy(DocEntry *doc);
 
    /// \brief returns the size threshold above which an element value 
    ///        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; }
+   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;
+   bool GetDSValue(std::vector <double> &valueVector);
 
 protected:
+  // DataEntry(DictEntry *e);
+   DataEntry(DocEntry *d);
+   DataEntry(uint16_t group,uint16_t elem,VRKey const &vr); 
+   ~DataEntry();
+
 // Methods :
-   void NewBinArea(void);
-   void DeleteBinArea(void);
+   void NewBinArea( );
+   void DeleteBinArea( );
 
 // Members :
    /// \brief memory area to hold 'non std::string' representable values 
@@ -118,15 +148,20 @@ 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; // to avoid allocating useless std::string
 
-   mutable std::string StrArea;
-
+   /// \brief  std::string Hexadecimal represention of the value Entry. 
+   ///        Parts of a multivaluated data are separated by back-slash
+   mutable std::string *StrHexaArea; // to avoid allocating useless std::string
 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.
+   /// \brief Size threshold above which an element is printed
    static uint32_t MaxSizePrintEntry;   
 };