gdcmDocEntry.h

Go to the documentation of this file.

/*=========================================================================
                                                                                
  Program:   gdcm
  Module:    $RCSfile: gdcmDocEntry.h,v $
  Language:  C++
  Date:      $Date: 2005/02/04 14:49:01 $
  Version:   $Revision: 1.46 $
                                                                                
  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 "gdcmBase.h"
#include "gdcmDictEntry.h"

#include <iostream>
#include <fstream>

namespace gdcm 
{
class File;
class ValEntry;
class BinEntry;
class SeqEntry;

//-----------------------------------------------------------------------------
class GDCM_EXPORT DocEntry : public Base
{
public:
   DocEntry(DictEntry*);
   virtual ~DocEntry() {};

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

   DictEntry * GetDictEntry() { return DicomDict; }; 

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

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

   void  SetKey( TagKey const &key ) { Key = key; }
   std::string const &GetKey() const { return Key; }

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

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

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

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

   size_t GetOffset() { return Offset; };

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

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

   uint32_t GetFullLength();

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

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

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

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

   bool IsItemDelimitor();
   bool IsSequenceDelimitor();   
   
   virtual void Copy(DocEntry *e);

protected:
   DictEntry *DicomDict;
   
   uint32_t Length; 
  
   uint32_t ReadLength;

   bool ImplicitVR;

   size_t Offset; 

   TagKey Key;

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

---