gdcmDocEntrySet.cxx

Go to the documentation of this file.

/*=========================================================================
                                                                                
  Program:   gdcm
  Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
  Language:  C++
  Date:      $Date: 2005/11/21 09:41:46 $
  Version:   $Revision: 1.68 $
                                                                                
  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 "gdcmUtil.h"
#include "gdcmDataEntry.h"
#include "gdcmVR.h"

namespace gdcm 
{
//-----------------------------------------------------------------------------
// Constructor / Destructor
DocEntrySet::DocEntrySet() 
{ 
   PreviousDocEntry = 0;
}
//-----------------------------------------------------------------------------
// Public
std::string DocEntrySet::GetEntryString(uint16_t group, uint16_t elem)
{
   DataEntry *entry = dynamic_cast<DataEntry *>(GetDocEntry(group,elem));
   if ( entry )
   {
      if( entry->IsNotLoaded() )
         return GDCM_NOTLOADED;
      if( entry->IsUnfound() )
         return GDCM_UNFOUND;
      if( entry->IsUnread() )
         return GDCM_UNREAD;
      return entry->GetString();
   }
   return GDCM_UNFOUND;
}

void *DocEntrySet::GetEntryBinArea(uint16_t group, uint16_t elem) 
{
   DataEntry *entry = GetDataEntry(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;
}

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

   return dynamic_cast<DataEntry*>(currentEntry);
}

SeqEntry *DocEntrySet::GetSeqEntry(uint16_t group, uint16_t elem)
{
   DocEntry *currentEntry = GetDocEntry(group, elem);
   if ( !currentEntry )
      return NULL;
      
   return dynamic_cast<SeqEntry*>(currentEntry);
}

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

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

   return SetEntryBinArea(content,lgth,entry);
} 

bool DocEntrySet::SetEntryString(std::string const &content, DataEntry *entry)
{
   if (entry)
   {
      entry->SetString(content);
      return true;
   }
   return false;
}

bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry)
{
   if (entry)
   {
      entry->SetLength(lgth);
      entry->SetBinArea(content);  
      return true;
   }
   return false;
}

DataEntry *DocEntrySet::InsertEntryString(std::string const &value, 
                                             uint16_t group, uint16_t elem,
                                             VRKey const &vr )
{
   DataEntry *dataEntry = 0;
   DocEntry *currentEntry = GetDocEntry( group, elem );
   
   if (currentEntry)
   {
      dataEntry = dynamic_cast<DataEntry *>(currentEntry);

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

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

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

      if ( !AddEntry(dataEntry) )
      {
         gdcmWarningMacro("AddEntry failed although this is a creation.");
         dataEntry->Delete();
         return NULL;
      }
      dataEntry->Delete();
   }

   // Set the dataEntry value
   SetEntryString(value, dataEntry); // The std::string value
   return dataEntry;
}

DataEntry *DocEntrySet::InsertEntryBinArea(uint8_t *binArea, int lgth, 
                                              uint16_t group, uint16_t elem,
                                              VRKey const &vr )
{
   DataEntry *dataEntry = 0;
   DocEntry *currentEntry = GetDocEntry( group, elem );

   // Verify the currentEntry
   if (currentEntry)
   {
      dataEntry = dynamic_cast<DataEntry *>(currentEntry);

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

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

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

      if ( !AddEntry(dataEntry) )
      {
         gdcmWarningMacro( "AddEntry failed although this is a creation.");
         dataEntry->Delete();
         return NULL;
      }
      dataEntry->Delete();
   }

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

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 for ("
               <<std::hex << group << "|" << elem <<")" );
            return NULL;
         }
      }
   }
   // Create a new seqEntry if necessary
   if ( !seqEntry )
   {
      seqEntry = NewSeqEntry(group, elem);

      if ( !AddEntry(seqEntry) )
      {
         gdcmWarningMacro( "AddEntry failed although this is a creation for ("
            <<std::hex << group << "|" << elem <<")" );
         seqEntry->Delete();
         return NULL;
      }
      seqEntry->Delete();
   }
   // Remark :
   // SequenceDelimitationItem will be added at the end of the SeqEntry,
   // at write time
   return seqEntry;
} 
 
bool DocEntrySet::CheckIfEntryExist(uint16_t group, uint16_t elem )
{
   return GetDocEntry(group,elem)!=NULL;
}

DataEntry *DocEntrySet::NewDataEntry(uint16_t group,uint16_t elem,
                                     VRKey const &vr) 
{
   DictEntry *dictEntry = GetDictEntry(group, elem, vr);

   DataEntry *newEntry = DataEntry::New(dictEntry);
   dictEntry->Unregister(); // GetDictEntry register it
   if (!newEntry) 
   {
      gdcmWarningMacro( "Failed to allocate DataEntry for ("
          <<std::hex << group << "|" << elem <<")" );
      return 0;
   }
   return newEntry;
}

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

   SeqEntry *newEntry = SeqEntry::New( dictEntry );
   dictEntry->Unregister(); // GetDictEntry register it
   if (!newEntry)
   {
      gdcmWarningMacro( "Failed to allocate SeqEntry for ("
         <<std::hex << group << "|" << elem <<")" );
      return 0;
   }
   return newEntry;
}

//-----------------------------------------------------------------------------
// 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);
      if( found )
         found->Register();
   }
   return found;
}

DictEntry *DocEntrySet::GetDictEntry(uint16_t group, uint16_t elem,
                                     VRKey const &vr)
{
   DictEntry *dictEntry = GetDictEntry(group,elem);
   DictEntry *goodEntry = dictEntry;
   VRKey goodVR = vr;
   TagName vm;
   if (elem == 0x0000) 
      goodVR="UL";

   if ( goodEntry )
   {
      if ( goodVR != goodEntry->GetVR()
        && goodVR != GDCM_VRUNKNOWN )
      { 
         gdcmWarningMacro("For (" << std::hex << group << "|"
            << elem << "), found VR : [" << vr << "]"
            << " expected: [" << goodEntry->GetVR() << "]" ) ;
        // avoid confusing further validator with "FIXME" VM
        // when possible      
         vm = dictEntry->GetVM();
         goodEntry = NULL;
      }
      dictEntry->Unregister();
   }
   else
   {
      vm = "FIXME";
   }
   // Create a new virtual DictEntry if necessary
   if (!goodEntry)
   {
      if (dictEntry)
      {

         goodEntry = DictEntry::New(group, elem, goodVR, vm,//"FIXME", 
                                    dictEntry->GetName() );
      }
      else
      {
         goodEntry = DictEntry::New(group, elem, goodVR);
      }
   }
   else
   {
      goodEntry->Register();
   }
   return goodEntry;
}

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

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

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

---