src/gdcmSeqEntry.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSeqEntry.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/02/01 10:29:56 $
   7   Version:   $Revision: 1.52 $
   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 "gdcmSeqEntry.h"
  20 #include "gdcmSQItem.h"
  21 #include "gdcmTS.h"
  22 #include "gdcmGlobal.h"
  23 #include "gdcmUtil.h"
  24 #include "gdcmDebug.h"
  25
  26 #include <iostream>
  27 #include <iomanip>
  28 #include <fstream>
  29
  30 namespace gdcm
  31 {
  32 //-----------------------------------------------------------------------------
  33 // Constructor / Destructor
  34 /**
  35  * \brief   Constructor from a given SeqEntry
  36  */
  37 SeqEntry::SeqEntry( DictEntry *e )
  38              : DocEntry(e)
  39 {
  40    Length       = 0;
  41    ReadLength   = 0xffffffff;
  42    SQDepthLevel = -1;
  43
  44    DelimitorMode = false;
  45    SeqTerm  = NULL;
  46 }
  47
  48 /**
  49  * \brief   Constructor from a given SeqEntry
  50  * @param   e Pointer to existing Doc entry
  51  * @param   depth depth level of the current Seq entry
  52  */
  53 SeqEntry::SeqEntry( DocEntry *e, int depth )
  54              : DocEntry( e->GetDictEntry() )
  55 {
  56    Length       = 0;
  57    ReadLength   = 0xffffffff;
  58    SQDepthLevel = depth;
  59
  60    ImplicitVR   = e->IsImplicitVR();
  61    Offset       = e->GetOffset();
  62    SeqTerm = NULL;
  63 }
  64
  65 /**
  66  * \brief   Canonical destructor.
  67  */
  68 SeqEntry::~SeqEntry()
  69 {
  70    for(ListSQItem::iterator cc = Items.begin(); cc != Items.end(); ++cc)
  71    {
  72       delete *cc;
  73    }
  74    if (SeqTerm)
  75    {
  76       delete SeqTerm;
  77    }
  78 }
  79
  80 //-----------------------------------------------------------------------------
  81 // Public
  82 /*
  83  * \brief   canonical Writer
  84  * @param fp pointer to an already open file
  85  * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
  86  */
  87 void SeqEntry::WriteContent(std::ofstream *fp, FileType filetype)
  88 {
  89    uint16_t seq_term_gr = 0xfffe;
  90    uint16_t seq_term_el = 0xe0dd;
  91    uint32_t seq_term_lg = 0xffffffff;
  92
  93    //uint16_t item_term_gr = 0xfffe;
  94    //uint16_t item_term_el = 0xe00d;
  95
  96    DocEntry::WriteContent(fp, filetype);
  97    for(ListSQItem::iterator cc  = Items.begin();
  98                             cc != Items.end();
  99                           ++cc)
 100    {
 101       (*cc)->WriteContent(fp, filetype);
 102    }
 103
 104    // we force the writting of a Sequence Delimitation item
 105    // because we wrote the Sequence as a 'no Length' sequence
 106    binary_write(*fp, seq_term_gr);
 107    binary_write(*fp, seq_term_el);
 108    binary_write(*fp, seq_term_lg);
 109 }
 110
 111 /**
 112  * \brief   Get the first entry while visiting the SeqEntry
 113  * \return  The first SQItem if found, otherwhise NULL
 114  */
 115 SQItem *SeqEntry::GetFirstSQItem()
 116 {
 117    ItSQItem = Items.begin();
 118    if (ItSQItem != Items.end())
 119       return *ItSQItem;
 120    return NULL;
 121 }
 122
 123 /**
 124  * \brief   Get the next SQItem while visiting the SeqEntry
 125  * \note : meaningfull only if GetFirstEntry already called
 126  * \return  The next SQItem if found, otherwhise NULL
 127  */
 128
 129 SQItem *SeqEntry::GetNextSQItem()
 130 {
 131    gdcmAssertMacro (ItSQItem != Items.end())
 132    {
 133       ++ItSQItem;
 134       if (ItSQItem != Items.end())
 135          return *ItSQItem;
 136    }
 137    return NULL;
 138 }
 139
 140 /**
 141  * \brief return a pointer to the SQItem referenced by its ordinal number.
 142  *        Returns the first item when argument is negative.
 143  *        Returns the  last item when argument is bigger than the total
 144  *        item number.
 145  */
 146 SQItem *SeqEntry::GetSQItem(int nb)
 147 {
 148    if (nb<0)
 149    {
 150       return *(Items.begin());
 151    }
 152    int count = 0 ;
 153    for(ListSQItem::iterator cc = Items.begin();
 154                            cc != Items.end();
 155                            count ++, ++cc)
 156    {
 157       if (count == nb)
 158       {
 159          return *cc;
 160       }
 161    }
 162    return *(Items.end());
 163 }
 164
 165 /**
 166  * \brief returns the number of SQItems within the current Sequence
 167  */
 168 unsigned int SeqEntry::GetNumberOfSQItems()
 169 {
 170    return Items.size();
 171 }
 172
 173 /**
 174  * \brief   adds the passed ITEM to the ITEM chained List for this SeQuence.
 175  * @param sqItem SQItem to be pushed back in the SeqEntry
 176  * @param itemNumber ordinal number of the SQItem
 177  *  \note NOT end-user intendend method !
 178  */
 179 void SeqEntry::AddSQItem(SQItem *sqItem, int itemNumber)
 180 {
 181 // FIXME : SQItemNumber is supposed to be the ordinal number of the SQItem
 182 //         within the Sequence.
 183 //         Either only 'push_back' is allowed,
 184 //                and we just have to do something like SeqEntry::lastNb++
 185 //         Or we can add (or remove) anywhere, and SQItemNumber will be broken
 186    sqItem->SetSQItemNumber(itemNumber);
 187    Items.push_back(sqItem);
 188 }
 189
 190 //-----------------------------------------------------------------------------
 191 // Protected
 192
 193
 194 //-----------------------------------------------------------------------------
 195 // Private
 196
 197 //-----------------------------------------------------------------------------
 198 // Print
 199 /**
 200  * \brief   canonical Printer
 201  */
 202 void SeqEntry::Print( std::ostream &os, std::string const & )
 203 {
 204    // First, Print the Dicom Element itself.
 205    os << "S ";
 206    DocEntry::Print(os);
 207    os << std::endl;
 208
 209    if (GetReadLength() == 0)
 210       return;
 211
 212    // Then, Print each SQ Item
 213    for(ListSQItem::iterator cc = Items.begin(); cc != Items.end(); ++cc)
 214    {
 215       (*cc)->SetPrintLevel(PrintLevel);
 216       (*cc)->Print(os);
 217    }
 218
 219    // at end, print the sequence terminator item, if any
 220    if (DelimitorMode)
 221    {
 222       for ( int i = 0; i < SQDepthLevel; i++ )
 223       {
 224          os << "   | " ;
 225       }
 226       if (SeqTerm != NULL)
 227       {
 228          SeqTerm->SetPrintLevel(PrintLevel);
 229          SeqTerm->Print(os);
 230          os << std::endl;
 231       }
 232       else
 233       {
 234          // fuse
 235          gdcmVerboseMacro("  -------- should have a sequence terminator item");
 236       }
 237    }
 238 }
 239
 240 //-----------------------------------------------------------------------------
 241 } // end namespace gdcm