/*=========================================================================
                                                                                
  Program:   gdcm
  Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
  Language:  C++
  Date:      $Date: 2005/01/24 14:14:11 $
  Version:   $Revision: 1.44 $
                                                                                
  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 
{

//-----------------------------------------------------------------------------
// Public


/**
 * \brief   Request a new virtual dict entry to the dict set
 * @param   group group  number of the underlying DictEntry
 * @param   elem  element number of the underlying DictEntry
 * @param   vr    VR (Value Representation) of the underlying DictEntry
 * @param   vm    VM (Value Multiplicity)   of the underlying DictEntry
 * @param   name   english name
 */
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
/**
 * \brief   Build a new Val Entry from all the low level arguments. 
 *          Check for existence of dictionary entry, and build
 *          a default one when absent.
 * @param   group group   number of the new Entry
 * @param   elem  element number of the new Entry
 * @param   vr     VR of the new Entry 
 */
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) 
   {
      gdcmVerboseMacro( "Failed to allocate ValEntry");
      return 0;
   }
   return newEntry;
}


/**
 * \brief   Build a new Bin Entry from all the low level arguments. 
 *          Check for existence of dictionary entry, and build
 *          a default one when absent.
 * @param   group group   number of the new Entry
 * @param   elem  element number of the new Entry
 * @param   vr     VR of the new Entry 
 */
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) 
   {
      gdcmVerboseMacro( "Failed to allocate BinEntry");
      return 0;
   }
   return newEntry;
}

/**
 * \brief   Build a new Seq Entry from all the low level arguments. 
 *          Check for existence of dictionary entry, and build
 *          a default one when absent.
 * @param   group group   number of the new Entry
 * @param   elem  element number of the new Entry
 */
SeqEntry* DocEntrySet::NewSeqEntry(uint16_t group,uint16_t elem) 
{
   DictEntry *dictEntry = GetDictEntry(group, elem, "SQ");
   gdcmAssertMacro(dictEntry);

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

/**
 * \brief   Searches [both] the public [and the shadow dictionary (when they
 *          exist)] for the presence of the DictEntry with given
 *          group and element. The public dictionary has precedence on the
 *          shadow one.
 * @param   group  group number of the searched DictEntry
 * @param   elem element number of the searched DictEntry
 * @return  Corresponding DictEntry when it exists, NULL otherwise.
 */
DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem) 
{
   DictEntry *found = 0;
   Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
   if (!pubDict) 
   {
      gdcmVerboseMacro( "We SHOULD have a default dictionary");
   }
   else
   {
      found = pubDict->GetEntry(group, elem);  
   }
   return found;
}


/**
 * \brief   Searches both the public and the shadow dictionary (when they
 *          exist) for the presence of the DictEntry with given
 *          group and element, and create a new virtual DictEntry if necessary
 * @param   group  group number of the searched DictEntry
 * @param   elem element number of the searched DictEntry
 * @param   vr Value Representation to use, if necessary 
 * @return  Corresponding DictEntry when it exists, NULL otherwise.
 */
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

} // end namespace gdcm

//-----------------------------------------------------------------------------