gdcmDocEntry.h

Go to the documentation of this file.

/*=========================================================================
                                                                                
  Program:   gdcm
  Module:    $RCSfile: gdcmDocEntry.h,v $
  Language:  C++
  Date:      $Date: 2005/11/29 12:48:46 $
  Version:   $Revision: 1.59 $
                                                                                
  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 GDCMDOCENTRY_H
#define GDCMDOCENTRY_H

#include "gdcmRefCounter.h"
#include "gdcmDictEntry.h"

#include <iostream>
#include <fstream>

namespace gdcm 
{
class File;
class SeqEntry;

//-----------------------------------------------------------------------------
class GDCM_EXPORT DocEntry : public RefCounter
{
   gdcmTypeMacro(DocEntry);

public:
   virtual void Print (std::ostream &os = std::cout, std::string const &indent = ""); 
   virtual void WriteContent(std::ofstream *fp, FileType filetype);

   DictEntry * GetDictEntry() { return DicomDict; } 

   const uint16_t &GetGroup() const   { return DicomDict->GetGroup();  }

   const uint16_t &GetElement() const { return DicomDict->GetElement();}

   TagKey GetKey() const { return DicomDict->GetKey(); }

   std::string const &GetName() const { return DicomDict->GetName(); }

   VRKey const &GetVR() const { return DicomDict->GetVR(); }

   std::string const &GetVM() const { return DicomDict->GetVM(); }

   void SetVM( TagName const &v) { DicomDict->SetVM(v); } 

   const size_t &GetOffset() const { return Offset; }

   void SetReadLength(uint32_t l) { ReadLength = l; }
   const uint32_t &GetReadLength() const { return ReadLength; }

   virtual void SetLength(uint32_t l) { Length = l; }
   const uint32_t &GetLength() const { return Length; }

   uint32_t GetFullLength();
   virtual uint32_t ComputeFullLength() = 0;

// The following 3 members, for internal use only ! 
   void SetOffset(size_t of) { Offset = of; }

   void SetImplicitVR() { ImplicitVR = true; }
 
   bool IsImplicitVR() const { return ImplicitVR; }

   bool IsVRUnknown() const { return DicomDict->IsVRUnknown(); }

   bool IsVMUnknown() const { return DicomDict->IsVMUnknown(); }

   bool IsItemDelimitor();
   bool IsItemStarter();
   bool IsSequenceDelimitor();   

   virtual void Copy(DocEntry *doc);

protected:
   DocEntry(DictEntry*);
   virtual ~DocEntry();

   DictEntry *DicomDict;
   
   uint32_t Length; 
  
   uint32_t ReadLength;

   bool ImplicitVR;

   size_t Offset; 

private:
};
} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif

---