gdcmDocEntry.h

Go to the documentation of this file.

/*=========================================================================
                                                                                
  Program:   gdcm
  Module:    $RCSfile: gdcmDocEntry.h,v $
  Language:  C++
  Date:      $Date: 2007/08/22 16:14:04 $
  Version:   $Revision: 1.69 $
                                                                                
  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_NAME_SPACE 
{
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, 
                             bool insideMetaElements);

   DictEntry * GetDictEntry() { return DicomDict; } 

   uint16_t const &GetGroup() const   { return Key[0];  }
   //const uint16_t &GetGroup() const   { return DicomDict->GetGroup();  }

   uint16_t const &GetElement() const { return Key[1];}   
   //const uint16_t &GetElement() const { return DicomDict->GetElement();}

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

   std::string const &GetName();

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

   std::string const &GetVM();

   //void SetVM( TagName const &v) { DicomDict->SetVM(v); } 
   void SetVM( TagName &) { std::cout << "-----------------FIXME : SetVM "; }
    
   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 members, for internal use only !

   void SetOffset(size_t of) { Offset = of; }

   void SetImplicitVR() { ImplicitVR = true; }
 
   void SetVR( VRKey const &vr) { VR = vr; } 

   void SetTag( TagKey const &key) { Key = key; } 
  
// -----------end of members to be used with caution
   
   bool IsImplicitVR() const { return ImplicitVR; }

//   bool IsVRUnknown() const { return DicomDict->IsVRUnknown(); }
     bool IsVRUnknown() const { return VR == GDCM_VRUNKNOWN; }

//   bool IsVMUnknown() const { return DicomDict->IsVMUnknown(); }
   bool IsVMUnknown() { return GetVM() == GDCM_UNKNOWN; }

   bool IsItemDelimitor() 
                      {return (GetGroup() == 0xfffe && GetElement() == 0xe00d);}
   bool IsItemStarter(){ if (GetGroup() != 0xfffe) return false;
                         return (GetElement() == 0xe000); }
   bool IsSequenceDelimitor() { return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);}  

   virtual void Copy(DocEntry *doc);

protected:
  // DocEntry(DictEntry*);
   DocEntry(uint16_t group, uint16_t elem, VRKey const &vr);
   virtual ~DocEntry();

   DictEntry *DicomDict;
      
   uint32_t Length; 
  
   uint32_t ReadLength;

   bool ImplicitVR;

   size_t Offset; 

   VRKey VR; // JPRx
      
   TagKey Key; // JPRx
private:

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

---