gdcmDocument.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   gdcm
  Module:    $RCSfile: gdcmDocument.h,v $
  Language:  C++
  Date:      $Date: 2005/11/29 17:21:34 $
  Version:   $Revision: 1.137 $
 
  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  l'Image). All rights reserved. See Doc/License.txt or
  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.
 
=========================================================================*/

#ifndef GDCMDOCUMENT_H
#define GDCMDOCUMENT_H

#include "gdcmVR.h"
#include "gdcmDict.h"
#include "gdcmElementSet.h"
#include "gdcmException.h"
#include "gdcmDebug.h"  // for LEGACY
#include "gdcmCommandManager.h"

#include <map>
#include <list>
#include <fstream>

namespace gdcm 
{
class SeqEntry;
class Dict;

//-----------------------------------------------------------------------------
class GDCM_EXPORT Document : public ElementSet
{
   gdcmTypeMacro(Document);

public:
   typedef std::list<DicomElement> ListElements;

// Loading
   //Deprecated : use SetFileName() + Load()
   //GDCM_LEGACY(  virtual bool Load( std::string const &filename )  ); 
   //virtual bool Load( std::string const &filename );
   virtual bool Load( ); 

// Dictionaries
   Dict *GetPubDict();
   Dict *GetShaDict();
   bool SetShaDict(Dict *dict);
   bool SetShaDict(DictKey const &dictName);

// Informations contained in the gdcm::Document
   bool IsParsable();
   virtual bool IsReadable();
   bool IsDicomV3();
   bool IsPapyrus();
   FileType GetFileType();
   std::string GetTransferSyntax();
   std::string GetTransferSyntaxName();

// Swap code
   int GetSwapCode() { return SwapCode; }
   
// File I/O
   const std::string &GetFileName() const { return Filename; }
   virtual void SetFileName(std::string const &fileName) 
                   { if (Filename != fileName)
                        Filename = fileName, IsDocumentModified = true; }

   std::ifstream *OpenFile();
   bool CloseFile();
   void WriteContent( std::ofstream *fp, FileType type );

// Content entries
   virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
   virtual void LoadEntryBinArea(DataEntry *entry);

   void LoadDocEntrySafe(DocEntry *entry);
   void AddForceLoadElement(uint16_t group, uint16_t elem);
 
// Ordering of Documents
   bool operator<(Document &document);

   void SetLoadMode (int mode) { if (LoadMode != mode) 
                                     LoadMode=mode, IsDocumentModified = true; }

protected:
// Methods
   // Constructor and destructor are protected to forbid end user 
   // to instanciate from this class Document (only gdcm::File and
   // gdcm::DicomDir are meaningfull).
   Document();
   virtual ~Document();

   virtual void CallStartMethod();
   virtual void CallProgressMethod();
   virtual void CallEndMethod();
      
   uint16_t ReadInt16() throw ( FormatError );
   uint32_t ReadInt32() throw ( FormatError );
   void     SkipBytes(uint32_t);
   int ComputeGroup0002Length( );

// Variables
   std::string Filename;

   int SwapCode;

   bool Group0002Parsed;

   bool HasDCMPreamble;

   std::ifstream *Fp;

   FileType Filetype;  

   static const unsigned int HEADER_LENGTH_TO_READ; 
   static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;

   ListElements UserAnonymizeList;

   ListElements UserForceLoadList;

   int LoadMode;
   
   bool IsDocumentAlreadyLoaded; // FIXME : probabely useless now

   bool IsDocumentModified;

private:
// Methods
   void Initialize();
   bool DoTheLoadingDocumentJob(); 
     
      // System access (meaning endian related !?)
   uint16_t SwapShort(uint16_t);
   uint32_t SwapLong(uint32_t);
   double SwapDouble(double);
   uint16_t UnswapShort(uint16_t a) { return SwapShort(a);}
   uint32_t UnswapLong(uint32_t a) { return SwapLong(a);}
   
   // Read
   void ParseDES(DocEntrySet *set, long offset, long l_max, bool delim_mode);
   void ParseSQ (SeqEntry *seq,    long offset, long l_max, bool delim_mode);

   void LoadDocEntry         (DocEntry *e, bool forceLoad = false);
   void FindDocEntryLength   (DocEntry *e) throw ( FormatError );
   uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
   VRKey FindDocEntryVR();
   bool CheckDocEntryVR      (const VRKey &k);

   void SkipDocEntry          (DocEntry *entry);
   void SkipToNextDocEntry    (DocEntry *entry);

   void FixDocEntryFoundLength(DocEntry *entry, uint32_t l);
   bool IsDocEntryAnInteger   (DocEntry *entry);

   bool CheckSwap();
   void SwitchByteSwapCode();
   void SetMaxSizeLoadEntry(long);

   // DocEntry related utilities
   DocEntry *ReadNextDocEntry();

   void HandleBrokenEndian  (uint16_t &group, uint16_t &elem);
   void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
   DocEntry *Backtrack(DocEntry *docEntry);

// Variables
protected:
   float Progress;
   mutable bool Abort;
   
   Dict *RefPubDict;
   Dict *RefShaDict;

   uint32_t MaxSizeLoadEntry;

   uint16_t CurrentGroup;
   uint16_t CurrentElem; 
     
//  uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
//  void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
//                                  DocEntrySet *set );

};

} // end namespace gdcm

//-----------------------------------------------------------------------------
#endif

---