src/gdcmDataEntry.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDataEntry.h,v $
   5   Language:  C++
   6   Date:      $Date: 2007/08/29 15:30:48 $
   7   Version:   $Revision: 1.20 $
   8
   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.
  12
  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.
  16
  17 =========================================================================*/
  18
  19 #ifndef G_DCMDATAENTRY_H_
  20 #define _GDCMDATAENTRY_H_
  21
  22 #include "gdcmDocEntry.h"
  23
  24 #include <vector> // for GetDSValue
  25 #include <iostream>
  26
  27 namespace GDCM_NAME_SPACE
  28 {
  29 //-----------------------------------------------------------------------------
  30 /**
  31  * \brief   Any Dicom Document (File or DicomDir, or ...) contains
  32  *           a set of DocEntry  - Dicom entries -
  33  *           (when successfuly parsed against a given Dicom dictionary)
  34  *          DataEntry is an elementary DocEntry (as opposed to SeqEntry).
  35  *          Depending on the type of its content,
  36  */
  37 class GDCM_EXPORT DataEntry  : public DocEntry
  38 {
  39    gdcmTypeMacro(DataEntry);
  40
  41 public:
  42 /// \brief Contructs a DataEntry with a RefCounter from DictEntry
  43 //   static DataEntry *New(DictEntry *e) {return new DataEntry(e);}
  44 /// \brief Contructs a DataEntry with a RefCounter from DocEntry
  45    static DataEntry *New(DocEntry *d)  {return new DataEntry(d);}
  46 /// \brief Contructs a DataEntry with a RefCounter from elementary items
  47    static DataEntry *New(uint16_t group,uint16_t elem, VRKey const &vr)
  48            {return new DataEntry(group,elem,vr);}
  49
  50 // Print
  51    void Print(std::ostream &os = std::cout, std::string const &indent = "");
  52
  53 // Write
  54    virtual void WriteContent(std::ofstream *fp, FileType filetype,
  55                                bool insideMetaElements, bool insideSequence);
  56    uint32_t ComputeFullLength();
  57
  58 // Set/Get data
  59    // Sets the value (string) of the current Dicom entry
  60    //virtual void SetValue(std::string const &val);
  61
  62    /// \brief Returns the area value of the current Dicom Entry
  63    ///  when it's not string-translatable (e.g : LUT table, overlay, icon)
  64    uint8_t *GetBinArea()  { return BinArea; }
  65    void SetBinArea( uint8_t *area, bool self = true );
  66    void CopyBinArea( uint8_t *area, uint32_t length );
  67
  68    void SetValue(const uint32_t &id,const double &val);
  69    double GetValue(const uint32_t &id) const;
  70    uint32_t GetValueCount() const;
  71    bool IsValueCountValid() /*const*/; // GetVM may update the pointer DicomDict
  72
  73    void SetString(std::string const &value);
  74    std::string const &GetString() const;
  75
  76    /// \brief Sets SelfArea
  77    void SetSelfArea(bool area) { SelfArea = area; }
  78    /// \brief True if Entry owns its BinArea
  79    bool IsSelfArea() { return SelfArea; }
  80
  81    ///\brief values for current state of a DataEntry (internal use only)
  82    enum TValueState
  83    {
  84       STATE_LOADED    = 0x00,
  85       STATE_NOTLOADED = 0x01,
  86       STATE_UNFOUND   = 0x02,
  87       STATE_UNREAD    = 0x03
  88    };
  89
  90    ///\brief values for current pixel status of a DataEntry (internal use only)
  91    enum TValueFlag
  92    {
  93       FLAG_NONE       = 0x00,
  94       FLAG_PIXELDATA  = 0x01
  95    };
  96
  97    // State
  98    /// \brief Sets the state (Loaded, NotLoaded, UnFound, ...) of the DataEntry
  99    void SetState(const TValueState &state) { State = state; }
 100    /// \brief Returns the state (Loaded, NotLoaded, ...) of the DataEntry
 101    const TValueState &GetState() const { return State; }
 102    /// \brief true when value Entry not loaded
 103    bool IsNotLoaded() { return State == STATE_NOTLOADED; }
 104    /// \brief true if Entry not found
 105    bool IsUnfound()   { return State == STATE_UNFOUND; }
 106    /// \brief true if Entry not read
 107    bool IsUnread()    { return State == STATE_UNREAD; }
 108    /// \brief true if Entry value properly loaded
 109    bool IsGoodValue() { return State == STATE_LOADED; }
 110
 111    // Flags
 112    /// \brief sets the 'pixel data flag'
 113    void SetFlag(const TValueFlag &flag) { Flag = flag; }
 114    /// \brief returns the 'pixel data flag'
 115    const TValueFlag &GetFlag() const { return Flag; }
 116    /// \brief true id Entry is a Pixel Data entry
 117    bool IsPixelData() { return (Flag &FLAG_PIXELDATA) != 0; }
 118
 119    virtual void Copy(DocEntry *doc);
 120
 121    /// \brief returns the size threshold above which an element value
 122    ///        will NOT be *printed* in order no to polute the screen output
 123    static const uint32_t &GetMaxSizePrintEntry() { return MaxSizePrintEntry; }
 124    /// \brief Header Elements too long will not be printed
 125    static void SetMaxSizePrintEntry(const uint32_t &size)
 126                                                  { MaxSizePrintEntry = size; }
 127
 128    bool GetDSValue(std::vector <double> &valueVector);
 129
 130 protected:
 131   // DataEntry(DictEntry *e);
 132    DataEntry(DocEntry *d);
 133    DataEntry(uint16_t group,uint16_t elem,VRKey const &vr);
 134    ~DataEntry();
 135
 136 // Methods :
 137    void NewBinArea( );
 138    void DeleteBinArea( );
 139
 140 // Members :
 141    /// \brief memory area to hold 'non std::string' representable values
 142    ///       (ie : Lookup Tables, overlays, icons)
 143    uint8_t *BinArea;
 144    /// \brief Whether DataEntry has its own BinArea or not
 145    bool SelfArea;
 146    /// \brief  std::string representable value of the Entry.
 147    ///        Parts of a multivaluated data are separated by back-slash
 148    //mutable std::string StrArea;
 149    mutable std::string *StrArea; // to avoid allocating useless std::string
 150
 151 private:
 152    /// \brief 0 for straight entries, FLAG_PIXELDATA for Pixel Data entries
 153    TValueFlag Flag;
 154    /// \brief Entry status:STATE_NOTLOADED,STATE_UNFOUND,STATE_UNREAD,STATE_LOADED
 155    TValueState State;
 156
 157    /// \brief Size threshold above which an element is printed
 158    static uint32_t MaxSizePrintEntry;
 159 };
 160
 161 } // end namespace gdcm
 162
 163 //-----------------------------------------------------------------------------
 164 #endif
 165