* ENH: added some utility method that builds a flat dictionnary

[gdcm.git] / src / gdcmDocument.h

diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h
index 0923cfb6a430d281b52b0d35d558cca97f140a40..e7518c66d32f69512f38b5a9e60027d1f35de6f8 100644 (file)
--- a/src/gdcmDocument.h
+++ b/src/gdcmDocument.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2004/08/02 14:06:58 $
-  Version:   $Revision: 1.29 $
+  Date:      $Date: 2004/09/17 13:11:16 $
+  Version:   $Revision: 1.38 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -50,10 +50,6 @@ private:
    /// \brief Optional "shadow dictionary" (private elements) used to parse
    /// this header
    gdcmDict *RefShaDict;
-   
-   /// \brief Equals =1 if user wants to skip shadow groups while parsing
-   /// (to save space)
-   int IgnoreShadow;
 
    /// \brief Size threshold above which an element value will NOT be loaded
    /// in memory (to avoid loading the image/volume itself). By default,
@@ -131,22 +127,29 @@ public:
 
    FileType GetFileType();
 
-   FILE* OpenFile(bool exception_on_error = false) throw( gdcmFileError );
+   FILE* OpenFile();
    bool CloseFile();
 
    void Write(FILE* fp, FileType type);
 
    gdcmValEntry* ReplaceOrCreateByNumber(std::string const & value,
-                                         uint16_t group, uint16_t elem);
-
+                                         uint16_t group, uint16_t elem,
+                                         std::string const & VR ="unkn");
+   
    gdcmBinEntry* ReplaceOrCreateByNumber(void *voidArea, int lgth,
-                                         uint16_t group, uint16_t elem);
-   bool ReplaceIfExistByNumber (std::string const & value, uint16_t group, uint16_t elem);
+                                         uint16_t group, uint16_t elem,
+                                         std::string const & VR="unkn");
+
+   gdcmSeqEntry* ReplaceOrCreateByNumber(uint16_t group, uint16_t elem);
+
+   bool ReplaceIfExistByNumber ( std::string const & value,
+                                 uint16_t group,
+                                 uint16_t elem );
    
    virtual void* LoadEntryVoidArea(uint16_t group, uint16_t elem);
    virtual void* LoadEntryVoidArea(gdcmBinEntry* entry);
       
-   // System access
+   // System access (meaning endian related !?)
    uint16_t SwapShort(uint16_t);   // needed by gdcmFile
    uint32_t SwapLong(uint32_t);    // needed by gdcmFile
    uint16_t UnswapShort(uint16_t); // needed by gdcmFile
@@ -156,21 +159,20 @@ protected:
    // Constructor and destructor are protected to forbid end user 
    // to instanciate from this class gdcmDocument (only gdcmHeader and
    // gdcmDicomDir are meaningfull).
-   gdcmDocument(bool exception_on_error  = false);
-   gdcmDocument(std::string const & filename, 
-                bool  exception_on_error = false);
+   gdcmDocument();
+   gdcmDocument( std::string const & filename );
    virtual ~gdcmDocument();
    
    void Parse7FE0 ();   
    // Entry
-   int CheckIfEntryExistByNumber(uint16_t group, uint16_t elem ); // int !
+   bool CheckIfEntryExistByNumber(uint16_t group, uint16_t elem );
 public:
    virtual std::string GetEntryByName    (TagName const & tagName);
    virtual std::string GetEntryVRByName  (TagName const & tagName);
    virtual std::string GetEntryByNumber  (uint16_t group, uint16_t elem);
    virtual std::string GetEntryVRByNumber(uint16_t group, uint16_t elem);
    virtual int     GetEntryLengthByNumber(uint16_t group, uint16_t elem);
-protected:
+//protected:
    virtual bool SetEntryByName  (std::string const & content, 
                                  std::string const & tagName);
    virtual bool SetEntryByNumber(std::string const & content,
@@ -195,11 +197,12 @@ protected:
    gdcmBinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element); 
 
    void LoadDocEntrySafe(gdcmDocEntry* entry);
+   TagDocEntryHT* BuildFlatHashTable();
 
 private:
    // Read
-   long ParseDES(gdcmDocEntrySet *set, long offset, long l_max,bool delim_mode);
-   long ParseSQ (gdcmSeqEntry *seq, long offset, long l_max, bool delim_mode); 
+   long ParseDES(gdcmDocEntrySet *set,long offset, long l_max, bool delim_mode);
+   long ParseSQ (gdcmSeqEntry *seq,   long offset, long l_max, bool delim_mode); 
    
    void LoadDocEntry      (gdcmDocEntry *);
    void FindDocEntryLength(gdcmDocEntry *) throw ( gdcmFormatError );
@@ -233,10 +236,13 @@ private:
    gdcmDocEntry* ReadNextDocEntry();
 
    uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
+   void BuildFlatHashTableRecurse( TagDocEntryHT& builtHT,
+                                   gdcmDocEntrySet* set );
+
 
 public:
 // Accessors:
-   /// Accessor to \ref printLevel
+   /// Accessor to \ref PrintLevel
    void SetPrintLevel(int level) { PrintLevel = level; }
 
    /// Accessor to \ref Filename
@@ -245,7 +251,7 @@ public:
    /// Accessor to \ref Filename
    void SetFileName(std::string const & fileName) { Filename = fileName; }
 
-   /// 'Swap code' accessor (see \ref sw )
+   /// 'Swap code' accessor (see \ref SwapCode )
    int GetSwapCode() { return SwapCode; }
    
    /// File pointer