]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.h
* FIX : remove so many friend between classes
[gdcm.git] / src / gdcmDocument.h
index 0a74dcf478119edf2ecf9499beae90015d364142..4166b318315212890507a498e458598a19f81144 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/13 09:23:27 $
-  Version:   $Revision: 1.86 $
+  Date:      $Date: 2005/01/25 15:44:24 $
+  Version:   $Revision: 1.101 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -22,6 +22,7 @@
 #include "gdcmVR.h"
 #include "gdcmDict.h"
 #include "gdcmElementSet.h"
+#include "gdcmException.h"
 
 #include <map>
 #include <list>
@@ -38,23 +39,22 @@ class JPEGFragmentsInfo;
 
 //-----------------------------------------------------------------------------
 /**
- * \brief Derived by both Header and DicomDir
+ * \brief Derived by both gdcm::File and gdcm::DicomDir
  */
 class GDCM_EXPORT Document : public ElementSet
 {
 public:
-// Informations contained in the parser
+// Informations contained in the gdcm::Document
    virtual bool IsReadable();
    FileType GetFileType();
 
    std::string GetTransferSyntax();
-
-   bool IsDicomV3();
-
+   /// returns RLEFramesInfo 
    RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
+   /// returns JPEGFragmentsInfo
    JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; }
 
-// Dictionnaries
+// Dictionaries
    virtual void PrintPubDict (std::ostream &os = std::cout);
    virtual void PrintShaDict (std::ostream &os = std::cout);
 
@@ -67,10 +67,10 @@ public:
    /// 'Swap code' accessor (see \ref SwapCode )
    int GetSwapCode() { return SwapCode; }
    // System access (meaning endian related !?)
-   uint16_t SwapShort(uint16_t);   // needed by File
-   uint32_t SwapLong(uint32_t);    // needed by File
-   uint16_t UnswapShort(uint16_t); // needed by File
-   uint32_t UnswapLong(uint32_t);  // needed by File
+   uint16_t SwapShort(uint16_t);   // needed by Document
+   uint32_t SwapLong(uint32_t);    // needed by Document
+   uint16_t UnswapShort(uint16_t); // needed by Document
+   uint32_t UnswapLong(uint32_t);  // needed by Document
    
 // Ordering of Documents
    bool operator<(Document &document);
@@ -88,48 +88,22 @@ public:
 
 // Content entries
 
-   virtual bool SetEntry(std::string const &content,
-                         uint16_t group, uint16_t element);
-   virtual bool SetEntry(uint8_t *content, int lgth,
-                         uint16_t group, uint16_t element);
-   virtual bool SetEntry(std::string const &content, ValEntry *entry);
-   virtual bool SetEntry(uint8_t *content, int lgth, BinEntry *entry);
-
-   virtual void *GetEntryBinArea(uint16_t group, uint16_t elem);   
-
-   virtual std::string GetEntry  (uint16_t group, uint16_t elem);
-   virtual std::string GetEntryVR(uint16_t group, uint16_t elem);
-   virtual int GetEntryLength(uint16_t group, uint16_t elem);
-
-   DocEntry *GetDocEntry(uint16_t group, uint16_t element); 
-   ValEntry *GetValEntry(uint16_t group, uint16_t element); 
-   BinEntry *GetBinEntry(uint16_t group, uint16_t element); 
-
-   ValEntry *ReplaceOrCreate(std::string const &value,
-                             uint16_t group, uint16_t elem,
-                             TagName const &vr = GDCM_UNKNOWN);
-   BinEntry *ReplaceOrCreate(uint8_t* binArea, int lgth,
-                             uint16_t group, uint16_t elem,
-                             TagName const &vr = GDCM_UNKNOWN);
-   SeqEntry *ReplaceOrCreate(uint16_t group, uint16_t elem);
-
-   bool ReplaceIfExist(std::string const &value,
-                       uint16_t group, uint16_t elem );
-   
    virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
    virtual void LoadEntryBinArea(BinEntry *entry);
 
    void LoadDocEntrySafe(DocEntry *entry);
-   TagDocEntryHT *BuildFlatHashTable();
 
    /// Return the Transfer Syntax as a string
    std::string GetTransferSyntaxName();
 
+   bool IsDicomV3();
+   bool IsPapyrus();
+
 protected:
 // Methods
    // Constructor and destructor are protected to forbid end user 
-   // to instanciate from this class Document (only Header and
-   // DicomDir are meaningfull).
+   // to instanciate from this class Document (only gdcm::File and
+   // gdcm::DicomDir are meaningfull).
    Document();
    Document( std::string const &filename );
    virtual ~Document();
@@ -138,7 +112,6 @@ protected:
    void ComputeRLEInfo();
    void ComputeJPEGFragmentInfo();
    // Entry
-   bool CheckIfEntryExist(uint16_t group, uint16_t elem );
 
    int ComputeGroup0002Length( FileType filetype );
 
@@ -157,16 +130,16 @@ protected:
    /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be
    /// swapped)
    /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
-   /// the well knowed 'Bad Big Endian' and 'Bad Little Endian' codes
+   /// the well known 'Bad Big Endian' and 'Bad Little Endian' codes
    int SwapCode;
 
-   ///\brief whether we already parsed group 0002
+   ///\brief whether we already parsed group 0002 (Meta Elements)
    bool Group0002Parsed;
 
    ///\brief whether file has a DCM Preamble
    bool HasDCMPreamble;
 
-   /// File Pointer, opened during Header parsing.
+   /// File Pointer, opened during Document parsing.
    std::ifstream *Fp;
 
    /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
@@ -181,9 +154,6 @@ protected:
 
    /// \brief Elements whose value is longer than  MAX_SIZE_PRINT_ELEMENT_VALUE
    /// are NOT printed.
-   /// \todo Currently not used since collides with #define in
-   ///       class DocEntry . See also
-   ///       method ref Document::SetMaxSizePrintEntry()
    static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
 
    /// Store the RLE frames info obtained during parsing of pixels.
@@ -220,7 +190,7 @@ private:
    bool     ReadTag(uint16_t, uint16_t);
    uint32_t ReadTagLength(uint16_t, uint16_t);
 
-   void Initialise();
+   void Initialize();
    bool CheckSwap();
    void SwitchByteSwapCode();
    void SetMaxSizeLoadEntry(long);
@@ -229,11 +199,11 @@ private:
    // DocEntry related utilities
    DocEntry *ReadNextDocEntry();
 
-   uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
-   void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
-                                   DocEntrySet* set );
+//  uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
+//  void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
+//                                   DocEntrySet *set );
 
-   void HandleBrokenEndian(uint16_t &group, uint16_t &elem);
+   void HandleBrokenEndian  (uint16_t &group, uint16_t &elem);
    void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
 
 // Variables
@@ -256,8 +226,9 @@ private:
    uint32_t MaxSizePrintEntry;   
 
 private:
-   friend class File;
+
 };
+
 } // end namespace gdcm
 
 //-----------------------------------------------------------------------------