src/gdcmDataEntry.h

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