src/gdcmSQItem.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSQItem.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2004/06/25 03:06:38 $
   7   Version:   $Revision: 1.18 $
   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.htm 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
  26 #include "gdcmDebug.h"
  27
  28
  29 //-----------------------------------------------------------------------------
  30 // Constructor / Destructor
  31 /**
  32  * \ingroup gdcmSQItem
  33  * \brief   Constructor from a given gdcmSQItem
  34  */
  35 gdcmSQItem::gdcmSQItem(int depthLevel )
  36           : gdcmDocEntrySet(depthLevel) {
  37    SQDepthLevel = depthLevel +1;
  38 }
  39
  40 /**
  41  * \brief   Canonical destructor.
  42  */
  43 gdcmSQItem::~gdcmSQItem()
  44 {
  45    for(ListDocEntry::iterator cc = docEntries.begin();
  46        cc != docEntries.end();
  47        ++cc)
  48    {
  49       delete (*cc);
  50    }
  51    docEntries.clear();
  52 }
  53
  54 //-----------------------------------------------------------------------------
  55 // Print
  56 /*
  57  * \brief   canonical Printer
  58  */
  59  void gdcmSQItem::Print(std::ostream & os) {
  60    std::ostringstream s;
  61
  62    if (SQDepthLevel>0)
  63    {
  64       for (int i=0;i<SQDepthLevel;i++)
  65          s << "   | " ;
  66    }
  67    std::cout << s.str() << " --- SQItem number " << SQItemNumber  << std::endl;
  68    for (ListDocEntry::iterator i  = docEntries.begin();
  69                                i != docEntries.end();
  70                              ++i)
  71    {
  72       gdcmDocEntry* Entry = *i;
  73       bool PrintEndLine = true;
  74
  75       os << s.str();
  76       Entry->SetPrintLevel(2);
  77       Entry->Print(os);
  78       if ( gdcmSeqEntry* SeqEntry = dynamic_cast<gdcmSeqEntry*>(Entry) )
  79       {
  80          (void)SeqEntry;  //not used
  81          PrintEndLine = false;
  82       }
  83       if (PrintEndLine)
  84          os << std::endl;
  85    }
  86 }
  87
  88 /*
  89  * \ingroup gdcmSQItem
  90  * \brief   canonical Writer
  91  */
  92 void gdcmSQItem::Write(FILE *fp,FileType filetype)
  93 {
  94    for (ListDocEntry::iterator i = docEntries.begin();
  95         i != docEntries.end();
  96         ++i)
  97    {
  98       // Item Delimitor Item IS the last one of a 'no length' SQItem
  99       // (when it exists) we don't write it right now
 100       // It will be written outside, because ALL the SQItems are written
 101       // as 'no length'
 102       if ( (*i)->isItemDelimitor() )
 103          break;
 104       if ( ((*i)->GetGroup() == 0xfffe) && ((*i)->GetElement() == 0x0000) )
 105         // Fix in order to make some MR PHILIPS images e-film readable
 106         // see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
 107         // we just *always* ignore spurious fffe|0000 tag !
 108          return;
 109       // It's up to the gdcmDocEntry Writter to write the SQItem begin element
 110       // (fffe|e000) as a 'no length' one
 111       (*i)->Write(fp, filetype);
 112    }
 113 }
 114
 115 //-----------------------------------------------------------------------------
 116 // Public
 117 /**
 118  * \brief   adds any Entry (Dicom Element) to the Sequence Item
 119  */
 120 bool gdcmSQItem::AddEntry(gdcmDocEntry *entry)
 121 {
 122    docEntries.push_back(entry);
 123    //TODO : check if it worked
 124    return true;
 125 }
 126
 127 /**
 128  * \brief   Sets Entry (Dicom Element) value of an element,
 129  *          specified by it's tag (Group, Number)
 130  *          and the length, too ...  inside a SQ Item
 131  *          If the Element is not found, it's just created !
 132  * \warning we suppose, right now, the element belongs to a Public Group
 133  *          (NOT a shadow one)
 134  * @param   val string value to set
 135  * @param   group Group number of the searched tag.
 136  * @param   element Element number of the searched tag.
 137  * @return  true if element was found or created successfully
 138  */
 139
 140 bool gdcmSQItem::SetEntryByNumber(std::string val,guint16 group,
 141                                   guint16 element)
 142 {
 143    for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i)
 144    {
 145       if ( (*i)->GetGroup() == 0xfffe && (*i)->GetElement() == 0xe000 )
 146          continue;
 147
 148       if (  ( group   < (*i)->GetGroup() )
 149           ||( group == (*i)->GetGroup() && element < (*i)->GetElement()) )
 150       {
 151          // instead of ReplaceOrCreateByNumber
 152          // that is a method of gdcmDocument :-(
 153          gdcmValEntry* Entry = (gdcmValEntry*)0;
 154          TagKey key = gdcmDictEntry::TranslateToKey(group, element);
 155
 156          if ( ! ptagHT->count(key))
 157          {
 158             // we assume a Public Dictionnary *is* loaded
 159             gdcmDict *PubDict = gdcmGlobal::GetDicts()->GetDefaultPubDict();
 160             // if the invoked (group,elem) doesn't exist inside the Dictionary
 161             // we create a VirtualDictEntry
 162             gdcmDictEntry *DictEntry = PubDict->GetDictEntryByNumber(group,
 163                                                                      element);
 164             if (DictEntry == NULL)
 165             {
 166               DictEntry=gdcmGlobal::GetDicts()->NewVirtualDictEntry(group,
 167                                                                     element,
 168                                                                     "UN",
 169                                                                     "??","??");
 170             }
 171             // we assume the constructor didn't fail
 172             Entry = new gdcmValEntry(DictEntry);
 173             /// \todo
 174             /// ----
 175             /// better we don't assume too much !
 176             /// gdcmSQItem is now used to describe any DICOMDIR related object
 177          } else {
 178             gdcmDocEntry* FoundEntry = ptagHT->find(key)->second;
 179             Entry = dynamic_cast<gdcmValEntry*>(FoundEntry);
 180             if (!Entry)
 181                dbg.Verbose(0, "gdcmSQItem::SetEntryByNumber: docEntries"
 182                               " contains non gdcmValEntry occurences");
 183          }
 184          if (Entry)
 185             Entry->SetValue(val);
 186          Entry->SetLength(val.length());
 187          docEntries.insert(i,Entry);
 188          return true;
 189       }
 190       if (group == (*i)->GetGroup() && element == (*i)->GetElement() )
 191       {
 192          if ( gdcmValEntry* Entry = dynamic_cast<gdcmValEntry*>(*i) )
 193             Entry->SetValue(val);
 194          (*i)->SetLength(val.length());
 195          return true;
 196       }
 197    }
 198    return false;
 199 }
 200 //-----------------------------------------------------------------------------
 201 // Protected
 202
 203
 204 /**
 205  * \brief   Gets a Dicom Element inside a SQ Item Entry, by number
 206  * @return
 207  */
 208 gdcmDocEntry *gdcmSQItem::GetDocEntryByNumber(guint16 group, guint16 element) {
 209    for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i) {
 210       if ( (*i)->GetGroup()==group && (*i)->GetElement()==element)
 211          return (*i);
 212    }
 213    return NULL;
 214 }
 215
 216 /**
 217  * \brief   Get the value of a Dicom Element inside a SQ Item Entry, by number
 218  * @return
 219  */
 220
 221 std::string gdcmSQItem::GetEntryByNumber(guint16 group, guint16 element) {
 222    for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i) {
 223       if ( (*i)->GetGroup()==group && (*i)->GetElement()==element) {
 224          return ((gdcmValEntry *)(*i))->GetValue();
 225       }
 226    }
 227    return GDCM_UNFOUND;
 228 }
 229 //-----------------------------------------------------------------------------
 230 // Private
 231
 232
 233 //-----------------------------------------------------------------------------