gdcmDocEntrySet.cxx

Go to the documentation of this file.

/*=========================================================================
                                                                                
  Program:   gdcm
  Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
  Language:  C++
  Date:      $Date: 2005/02/05 01:37:08 $
  Version:   $Revision: 1.54 $
                                                                                
  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.
                                                                                
=========================================================================*/
#include "gdcmDocEntrySet.h"

#include "gdcmDebug.h"
#include "gdcmCommon.h"
#include "gdcmDictSet.h"
#include "gdcmGlobal.h"
#include "gdcmDocEntry.h"
#include "gdcmSeqEntry.h"
#include "gdcmValEntry.h"
#include "gdcmBinEntry.h"

namespace gdcm 
{
//-----------------------------------------------------------------------------
// Constructor / Destructor

//-----------------------------------------------------------------------------
// Public
std::string DocEntrySet::GetEntryValue(uint16_t group, uint16_t elem)
{
   ContentEntry *entry = dynamic_cast<ContentEntry *>(GetDocEntry(group,elem));
   if( entry )
      return entry->GetValue();
   return GDCM_UNFOUND;
}

void *DocEntrySet::GetEntryBinArea(uint16_t group, uint16_t elem) 
{
   BinEntry *entry = GetBinEntry(group, elem);
   if( entry )
      return entry->GetBinArea();
   return 0;
}

int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem)
{
   DocEntry *entry = GetDocEntry(group, elem);
   if( entry )
      return entry->GetLength();
   return -1;
}

std::string DocEntrySet::GetEntryVR(uint16_t group, uint16_t elem)
{
   DocEntry *entry = GetDocEntry(group, elem);
   if( entry )
      return entry->GetVR();
   return GDCM_UNFOUND;
}

ValEntry *DocEntrySet::GetValEntry(uint16_t group, uint16_t elem)
{
   DocEntry *currentEntry = GetDocEntry(group, elem);
   if ( !currentEntry )
      return NULL;

   return dynamic_cast<ValEntry*>(currentEntry);
}

BinEntry *DocEntrySet::GetBinEntry(uint16_t group, uint16_t elem)
{
   DocEntry *currentEntry = GetDocEntry(group, elem);
   if ( !currentEntry )
   {
      gdcmWarningMacro( "No corresponding BinEntry " << std::hex << group <<
                         "," << elem);
      return NULL;
   }

   return dynamic_cast<BinEntry*>(currentEntry);
}

SeqEntry *DocEntrySet::GetSeqEntry(uint16_t group, uint16_t elem)
{
   DocEntry *currentEntry = GetDocEntry(group, elem);
   if ( !currentEntry )
   {
      gdcmWarningMacro( "No corresponding SeqEntry " << std::hex << group <<
                        "," << elem);
      return NULL;
   }

   return dynamic_cast<SeqEntry*>(currentEntry);
}

bool DocEntrySet::SetValEntry(std::string const &content, 
                              uint16_t group, uint16_t elem) 
{
   ValEntry *entry = GetValEntry(group, elem);
   if (!entry )
   {
      gdcmWarningMacro( "No corresponding ValEntry " << std::hex << group <<
                         "," << elem << " element (try promotion first).");
      return false;
   }
   return SetValEntry(content,entry);
}

bool DocEntrySet::SetBinEntry(uint8_t *content, int lgth, 
                              uint16_t group, uint16_t elem) 
{
   BinEntry *entry = GetBinEntry(group, elem);
   if (!entry )
   {
      gdcmWarningMacro( "No corresponding ValEntry " << std::hex << group <<
                        "," << elem << " element (try promotion first).");
      return false;
   }

   return SetBinEntry(content,lgth,entry);
} 

bool DocEntrySet::SetValEntry(std::string const &content, ValEntry *entry)
{
   if(entry)
   {
      entry->SetValue(content);
      return true;
   }
   return false;
}

bool DocEntrySet::SetBinEntry(uint8_t *content, int lgth, BinEntry *entry)
{
   if(entry)
   {
      entry->SetBinArea(content);  
      entry->SetLength(lgth);
      entry->SetValue(GDCM_BINLOADED);
      return true;
   }
   return false;
}

ValEntry *DocEntrySet::InsertValEntry(std::string const &value, 
                                      uint16_t group, uint16_t elem,
                                      TagName const &vr )
{
   ValEntry *valEntry = 0;
   DocEntry *currentEntry = GetDocEntry( group, elem );
   
   if (currentEntry)
   {
      valEntry = dynamic_cast<ValEntry *>(currentEntry);

      // Verify the VR
      if( valEntry )
         if( valEntry->GetVR()!=vr )
            valEntry = NULL;

      // if currentEntry doesn't correspond to the requested valEntry
      if( !valEntry)
      {
         if( !RemoveEntry(currentEntry) )
         {
            gdcmWarningMacro( "Removal of previous DocEntry failed.");

            return NULL;
         }
      }
   }

   // Create a new valEntry if necessary
   if( !valEntry )
   {
      valEntry = NewValEntry( group, elem, vr );

      if ( !AddEntry(valEntry) )
      {
         gdcmWarningMacro("AddEntry failed although this is a creation.");

         delete valEntry;
         return NULL;
      }
   }

   // Set the binEntry value
   SetValEntry(value, valEntry); // The std::string value
   return valEntry;
}

BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth, 
                                      uint16_t group, uint16_t elem,
                                      TagName const &vr )
{
   BinEntry *binEntry = 0;
   DocEntry *currentEntry = GetDocEntry( group, elem );

   // Verify the currentEntry
   if (currentEntry)
   {
      binEntry = dynamic_cast<BinEntry *>(currentEntry);

      // Verify the VR
      if( binEntry )
         if( binEntry->GetVR()!=vr )
            binEntry = NULL;

      // if currentEntry doesn't correspond to the requested valEntry
      if( !binEntry)
      {
         if( !RemoveEntry(currentEntry) )
         {
            gdcmWarningMacro( "Removal of previous DocEntry failed.");

            return NULL;
         }
      }
   }

   // Create a new binEntry if necessary
   if( !binEntry)
   {
      binEntry = NewBinEntry(group, elem, vr);

      if ( !AddEntry(binEntry) )
      {
         gdcmWarningMacro( "AddEntry failed allthough this is a creation.");

         delete binEntry;
         return NULL;
      }
   }

   // Set the binEntry value
   uint8_t *tmpArea;
   if( lgth>0 && binArea )
   {
      tmpArea = new uint8_t[lgth];
      memcpy(tmpArea,binArea,lgth);
   }
   else
   {
      tmpArea = 0;
   }
   if( !SetBinEntry(tmpArea,lgth,binEntry) )
   {
      if( tmpArea )
      {
         delete[] tmpArea;
      }
   }

   return binEntry;
}  

SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem)
{
   SeqEntry *seqEntry = 0;
   DocEntry *currentEntry = GetDocEntry( group, elem );

   // Verify the currentEntry
   if( currentEntry )
   {
      seqEntry = dynamic_cast<SeqEntry *>(currentEntry);

      // Verify the VR
      if( seqEntry )
         seqEntry = NULL;

      // if currentEntry doesn't correspond to the requested seqEntry
      if( !seqEntry )
      {
         if (!RemoveEntry(currentEntry))
         {
            gdcmWarningMacro( "Removal of previous DocEntry failed.");

            return NULL;
         }
      }
   }
   // Create a new seqEntry if necessary
   if( !seqEntry )
   {
      seqEntry = NewSeqEntry(group, elem);

      if( !AddEntry(seqEntry) )
      {
         gdcmWarningMacro( "AddEntry failed allthough this is a creation.");

         delete seqEntry;
         return NULL;
      }
   }

   // TODO : Find a trick to insert a SequenceDelimitationItem 
        //       in the SeqEntry, at the end.
   return seqEntry;
} 


 
bool DocEntrySet::CheckIfEntryExist(uint16_t group, uint16_t elem )
{
   return GetDocEntry(group,elem)!=NULL;
}

ValEntry *DocEntrySet::NewValEntry(uint16_t group,uint16_t elem,
                                   TagName const &vr) 
{
   DictEntry *dictEntry = GetDictEntry(group, elem, vr);
   gdcmAssertMacro(dictEntry);

   ValEntry *newEntry = new ValEntry(dictEntry);
   if (!newEntry) 
   {
      gdcmWarningMacro( "Failed to allocate ValEntry");
      return 0;
   }
   return newEntry;
}


BinEntry *DocEntrySet::NewBinEntry(uint16_t group, uint16_t elem,
                                   TagName const &vr) 
{
   DictEntry *dictEntry = GetDictEntry(group, elem, vr);
   gdcmAssertMacro(dictEntry);

   BinEntry *newEntry = new BinEntry(dictEntry);
   if (!newEntry) 
   {
      gdcmWarningMacro( "Failed to allocate BinEntry");
      return 0;
   }
   return newEntry;
}

SeqEntry* DocEntrySet::NewSeqEntry(uint16_t group, uint16_t elem) 
{
   DictEntry *dictEntry = GetDictEntry(group, elem, "SQ");
   gdcmAssertMacro(dictEntry);

   SeqEntry *newEntry = new SeqEntry( dictEntry );
   if (!newEntry)
   {
      gdcmWarningMacro( "Failed to allocate SeqEntry");
      return 0;
   }
   return newEntry;
}

DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group, uint16_t elem,
                                             TagName const &vr,
                                             TagName const &vm,
                                             TagName const &name )
{
   return Global::GetDicts()->NewVirtualDictEntry(group,elem,vr,vm,name);
}

//-----------------------------------------------------------------------------
// Protected
DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem) 
{
   DictEntry *found = 0;
   Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
   if (!pubDict) 
   {
      gdcmWarningMacro( "We SHOULD have a default dictionary");
   }
   else
   {
      found = pubDict->GetEntry(group, elem);  
   }
   return found;
}

DictEntry *DocEntrySet::GetDictEntry(uint16_t group, uint16_t elem,
                                     TagName const &vr)
{
   DictEntry *dictEntry = GetDictEntry(group,elem);
   DictEntry *goodEntry = dictEntry;
   std::string goodVR = vr;

   if (elem == 0x0000) goodVR="UL";

   if ( goodEntry )
   {
      if ( goodVR != goodEntry->GetVR()
        && goodVR != GDCM_UNKNOWN )
      {
         goodEntry = NULL;
      }
   }

   // Create a new virtual DictEntry if necessary
   if (!goodEntry)
   {
      if (dictEntry)
      {
         goodEntry = NewVirtualDictEntry(group, elem, goodVR, "FIXME", 
                                         dictEntry->GetName() );
      }
      else
      {
         goodEntry = NewVirtualDictEntry(group, elem, goodVR);
      }
   }
   return goodEntry;
}

//-----------------------------------------------------------------------------
// Private

//-----------------------------------------------------------------------------
// Print

//-----------------------------------------------------------------------------
} // end namespace gdcm

---