src/gdcmElementSet.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmElementSet.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/24 16:00:47 $
   7   Version:   $Revision: 1.67 $
   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 "gdcmElementSet.h"
  20 #include "gdcmDebug.h"
  21 #include "gdcmSeqEntry.h"
  22 #include "gdcmDataEntry.h"
  23
  24 namespace gdcm
  25 {
  26 //-----------------------------------------------------------------------------
  27 // Constructor / Destructor
  28 /**
  29  * \brief   Constructor for a given ElementSet
  30  */
  31 ElementSet::ElementSet()
  32           : DocEntrySet()
  33 {
  34 }
  35
  36 /**
  37  * \brief   Canonical destructor.
  38  */
  39 ElementSet::~ElementSet()
  40 {
  41    ClearEntry();
  42 }
  43
  44 //-----------------------------------------------------------------------------
  45 // Public
  46 /**
  47   * \brief   Writes the Header Entries (Dicom Elements)
  48   *          from the H Table
  49   * @param fp ofstream to write to
  50   * @param filetype filetype
  51   */
  52 void ElementSet::WriteContent(std::ofstream *fp, FileType filetype)
  53 {
  54    for (TagDocEntryHT::const_iterator i = TagHT.begin();
  55                                      i != TagHT.end();
  56                                     ++i)
  57    {
  58       i->second->WriteContent(fp, filetype);
  59    }
  60 }
  61
  62 /**
  63  * \brief   add a new Dicom Element pointer to the H Table
  64  * @param   newEntry entry to add
  65  */
  66 bool ElementSet::AddEntry(DocEntry *newEntry)
  67 {
  68    const TagKey &key = newEntry->GetKey();
  69
  70    if ( TagHT.count(key) == 1 )
  71    {
  72       gdcmWarningMacro( "Key already present: " << key );
  73       return false;
  74    }
  75    else
  76    {
  77       TagHT.insert(TagDocEntryHT::value_type(newEntry->GetKey(), newEntry));
  78       newEntry->Register();
  79       return true;
  80    }
  81 }
  82
  83 /**
  84  * \brief   Clear the hash table from given entry AND delete the entry.
  85  * @param   entryToRemove Entry to remove AND delete.
  86  */
  87 bool ElementSet::RemoveEntry( DocEntry *entryToRemove)
  88 {
  89    const TagKey &key = entryToRemove->GetKey();
  90    if ( TagHT.count(key) == 1 )
  91    {
  92       TagHT.erase(key);
  93       entryToRemove->Unregister();
  94       return true;
  95    }
  96
  97    gdcmWarningMacro( "Key not present : " << key);
  98    return false ;
  99 }
 100
 101 /**
 102  * \brief   delete all entries in the ElementSet
 103  */
 104 void ElementSet::ClearEntry()
 105 {
 106    for(TagDocEntryHT::iterator cc = TagHT.begin();cc != TagHT.end(); ++cc)
 107    {
 108       if ( cc->second )
 109       {
 110          cc->second->Unregister();
 111       }
 112    }
 113    TagHT.clear();
 114 }
 115
 116 /**
 117  * \brief   Get the first entry while visiting *the* 'zero level' DocEntrySet
 118  *              (DocEntries out of any Sequence)
 119  * \return  The first DocEntry if found, otherwhise NULL
 120  */
 121 DocEntry *ElementSet::GetFirstEntry()
 122 {
 123    ItTagHT = TagHT.begin();
 124    if (ItTagHT != TagHT.end())
 125       return  ItTagHT->second;
 126    return NULL;
 127 }
 128
 129 /**
 130  * \brief   Get the next entry while visiting *the* 'zero level' DocEntrySet
 131  *              (DocEntries out of any Sequence)
 132  * \note : meaningfull only if GetFirstEntry already called
 133  * \return  The next DocEntry if found, otherwhise NULL
 134  */
 135 DocEntry *ElementSet::GetNextEntry()
 136 {
 137    gdcmAssertMacro (ItTagHT != TagHT.end());
 138
 139    ++ItTagHT;
 140    if (ItTagHT != TagHT.end())
 141       return  ItTagHT->second;
 142    return NULL;
 143 }
 144
 145 /**
 146  * \brief  retrieves a Dicom Element using (group, element)
 147  * @param   group  Group number of the searched Dicom Element
 148  * @param   elem Element number of the searched Dicom Element
 149  * @return
 150  */
 151 DocEntry *ElementSet::GetDocEntry(uint16_t group, uint16_t elem)
 152 {
 153    TagKey key = DictEntry::TranslateToKey(group, elem);
 154    TagDocEntryHT::iterator it = TagHT.find(key);
 155
 156    if ( it!=TagHT.end() )
 157       return it->second;
 158    return NULL;
 159 }
 160
 161 //-----------------------------------------------------------------------------
 162 // Protected
 163
 164 //-----------------------------------------------------------------------------
 165 // Private
 166
 167 //-----------------------------------------------------------------------------
 168 // Print
 169 /**
 170   * \brief   Prints the Header Entries (Dicom Elements) from the H Table
 171   * @param os ostream to write to
 172   * @param indent Indentation string to be prepended during printing
 173   */
 174 void ElementSet::Print(std::ostream &os, std::string const & )
 175 {
 176    // Let's change the 'warning value' for Pixel Data,
 177    // to avoid human reader to be confused by 'gdcm::NotLoaded'.
 178    DataEntry *pixelElement = GetDataEntry(0x7fe0,0x0010);
 179    if ( pixelElement != 0 )
 180    {
 181       pixelElement->SetFlag( DataEntry::FLAG_PIXELDATA );
 182    }
 183
 184    for( TagDocEntryHT::const_iterator i = TagHT.begin(); i != TagHT.end(); ++i)
 185    {
 186       DocEntry *entry = i->second;
 187
 188       entry->SetPrintLevel(PrintLevel);
 189       entry->Print(os);
 190
 191       if ( dynamic_cast<SeqEntry *>(entry) )
 192       {
 193          // Avoid the newline for a sequence:
 194          continue;
 195       }
 196       os << std::endl;
 197    }
 198 }
 199
 200 //-----------------------------------------------------------------------------
 201 } // end namespace gdcm