src/gdcmSQItem.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSQItem.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2004/10/22 03:05:42 $
   7   Version:   $Revision: 1.30 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #include "gdcmSQItem.h"
  20 #include "gdcmSeqEntry.h"
  21 #include "gdcmValEntry.h"
  22 #include "gdcmBinEntry.h"
  23 #include "gdcmGlobal.h"
  24 #include "gdcmUtil.h"
  25 #include "gdcmDebug.h"
  26 #include <fstream>
  27
  28 namespace gdcm
  29 {
  30
  31 //-----------------------------------------------------------------------------
  32 // Constructor / Destructor
  33 /**
  34  * \ingroup SQItem
  35  * \brief   Constructor from a given SQItem
  36  */
  37 SQItem::SQItem(int depthLevel )
  38           : DocEntrySet( )
  39 {
  40    SQDepthLevel = depthLevel;
  41 }
  42
  43 /**
  44  * \brief   Canonical destructor.
  45  */
  46 SQItem::~SQItem()
  47 {
  48    for(ListDocEntry::iterator cc = docEntries.begin();
  49        cc != docEntries.end();
  50        ++cc)
  51    {
  52       delete (*cc);
  53    }
  54    docEntries.clear();
  55 }
  56
  57 //-----------------------------------------------------------------------------
  58 // Print
  59 /*
  60  * \brief   canonical Printer
  61  */
  62  void SQItem::Print(std::ostream& os)
  63  {
  64    std::ostringstream s;
  65
  66    if (SQDepthLevel > 0)
  67    {
  68       for (int i = 0; i < SQDepthLevel; ++i)
  69       {
  70          s << "   | " ;
  71       }
  72    }
  73    std::cout << s.str() << " --- SQItem number " << SQItemNumber  << std::endl;
  74    for (ListDocEntry::iterator i  = docEntries.begin();
  75                                i != docEntries.end();
  76                              ++i)
  77    {
  78       DocEntry* Entry = *i;
  79       bool PrintEndLine = true;
  80
  81       os << s.str();
  82       Entry->SetPrintLevel(2);
  83       Entry->Print(os);
  84       if ( SeqEntry* seqEntry = dynamic_cast<SeqEntry*>(Entry) )
  85       {
  86          (void)seqEntry;  //not used
  87          PrintEndLine = false;
  88       }
  89       if (PrintEndLine)
  90       {
  91          os << std::endl;
  92       }
  93    }
  94 }
  95
  96 /*
  97  * \ingroup SQItem
  98  * \brief   canonical Writer
  99  */
 100 void SQItem::Write(std::ofstream* fp,FileType filetype)
 101 {
 102    uint16_t item[4] = { 0xfffe, 0xe000, 0xffff, 0xffff };
 103    uint16_t itemt[4]= { 0xfffe, 0xe00d, 0xffff, 0xffff };
 104
 105     //we force the writting of an 'Item' Start Element
 106     // because we want to write the Item as a 'no Length' item
 107    fp->write((char*)&item[0],8);  // fffe e000 ffff ffff
 108
 109    for (ListDocEntry::iterator i = docEntries.begin();
 110         i != docEntries.end();
 111         ++i)
 112    {
 113       // we skip delimitors (start and end one) because
 114       // we force them as 'no length'
 115       if ( (*i)->GetGroup() == 0xfffe )
 116       {
 117          continue;
 118       }
 119
 120       // Fix in order to make some MR PHILIPS images e-film readable
 121       // see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
 122       // we just *always* ignore spurious fffe|0000 tag !
 123       if ( (*i)->GetGroup() == 0xfffe && (*i)->GetElement() == 0x0000 )
 124       {
 125          break; // FIXME : continue; ?!?
 126       }
 127
 128       (*i)->Write(fp, filetype);
 129    }
 130
 131     //we force the writting of an 'Item Delimitation' item
 132     // because we wrote the Item as a 'no Length' item
 133    fp->write((char*)&itemt[0],8);  // fffe e000 ffff ffff
 134
 135 }
 136
 137 //-----------------------------------------------------------------------------
 138 // Public
 139 /**
 140  * \brief   adds any Entry (Dicom Element) to the Sequence Item
 141  */
 142 bool SQItem::AddEntry(DocEntry* entry)
 143 {
 144    docEntries.push_back(entry);
 145    //TODO : check if it worked
 146    return true;
 147 }
 148
 149 /**
 150  * \brief   Sets Entry (Dicom Element) value of an element,
 151  *          specified by it's tag (Group, Number)
 152  *          and the length, too ...  inside a SQ Item
 153  *          If the Element is not found, it's just created !
 154  * \warning we suppose, right now, the element belongs to a Public Group
 155  *          (NOT a shadow one)
 156  * @param   val string value to set
 157  * @param   group Group number of the searched tag.
 158  * @param   element Element number of the searched tag.
 159  * @return  true if element was found or created successfully
 160  */
 161
 162 bool SQItem::SetEntryByNumber(std::string val, uint16_t group,
 163                                   uint16_t element)
 164 {
 165    for(ListDocEntry::iterator i = docEntries.begin(); i != docEntries.end(); ++i)
 166    {
 167       if ( (*i)->GetGroup() == 0xfffe && (*i)->GetElement() == 0xe000 )
 168       {
 169          continue;
 170       }
 171
 172       if (  ( group   < (*i)->GetGroup() )
 173           ||( group == (*i)->GetGroup() && element < (*i)->GetElement()) )
 174       {
 175          // instead of ReplaceOrCreateByNumber
 176          // that is a method of Document :-(
 177          ValEntry* entry = 0;
 178          TagKey key = DictEntry::TranslateToKey(group, element);
 179
 180          if ( ! PtagHT->count(key))
 181          {
 182             // we assume a Public Dictionnary *is* loaded
 183             Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
 184             // if the invoked (group,elem) doesn't exist inside the Dictionary
 185             // we create a VirtualDictEntry
 186             DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group,
 187                                                                      element);
 188             if (dictEntry == NULL)
 189             {
 190                dictEntry =
 191                   Global::GetDicts()->NewVirtualDictEntry(group, element,
 192                                                               "UN", "??", "??");
 193             }
 194             // we assume the constructor didn't fail
 195             entry = new ValEntry(dictEntry);
 196             /// \todo
 197             /// ----
 198             /// better we don't assume too much !
 199             /// SQItem is now used to describe any DICOMDIR related object
 200          }
 201          else
 202          {
 203             DocEntry* foundEntry = PtagHT->find(key)->second;
 204             entry = dynamic_cast<ValEntry*>(foundEntry);
 205             if (!entry)
 206             {
 207                dbg.Verbose(0, "SQItem::SetEntryByNumber: docEntries"
 208                               " contains non ValEntry occurences");
 209             }
 210          }
 211          if (entry)
 212          {
 213             entry->SetValue(val);
 214          }
 215          entry->SetLength(val.length());
 216          docEntries.insert(i,entry);
 217
 218          return true;
 219       }
 220       if (group == (*i)->GetGroup() && element == (*i)->GetElement() )
 221       {
 222          if ( ValEntry* entry = dynamic_cast<ValEntry*>(*i) )
 223          {
 224             entry->SetValue(val);
 225          }
 226          (*i)->SetLength(val.length());
 227          return true;
 228       }
 229    }
 230    return false;
 231 }
 232 //-----------------------------------------------------------------------------
 233 // Protected
 234
 235
 236 /**
 237  * \brief   Gets a Dicom Element inside a SQ Item Entry, by number
 238  * @return
 239  */
 240 DocEntry* SQItem::GetDocEntryByNumber(uint16_t group, uint16_t element)
 241 {
 242    for(ListDocEntry::iterator i = docEntries.begin();
 243                               i != docEntries.end(); ++i)
 244    {
 245       if ( (*i)->GetGroup() == group && (*i)->GetElement() == element )
 246       {
 247          return *i;
 248       }
 249    }
 250    return 0;
 251 }
 252
 253 /**
 254  * \brief   Get the value of a Dicom Element inside a SQ Item Entry, by number
 255  * @return
 256  */
 257
 258 std::string SQItem::GetEntryByNumber(uint16_t group, uint16_t element)
 259 {
 260    for(ListDocEntry::iterator i = docEntries.begin();
 261                               i != docEntries.end(); ++i)
 262    {
 263       if ( (*i)->GetGroup() == group && (*i)->GetElement() == element)
 264       {
 265          return ((ValEntry *)(*i))->GetValue();   //FIXME
 266       }
 267    }
 268    return GDCM_UNFOUND;
 269 }
 270 //-----------------------------------------------------------------------------
 271 // Private
 272
 273
 274 //-----------------------------------------------------------------------------
 275
 276 } // end namespace gdcm