Program: gdcm
Module: $RCSfile: gdcmSQItem.cxx,v $
Language: C++
- Date: $Date: 2004/08/01 00:59:21 $
- Version: $Revision: 1.22 $
+ Date: $Date: 2007/08/29 15:30:49 $
+ Version: $Revision: 1.87 $
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.htm for details.
+ 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
#include "gdcmSQItem.h"
#include "gdcmSeqEntry.h"
-#include "gdcmValEntry.h"
-#include "gdcmBinEntry.h"
#include "gdcmGlobal.h"
+#include "gdcmDictSet.h"
#include "gdcmUtil.h"
-
#include "gdcmDebug.h"
+#include <fstream>
+namespace GDCM_NAME_SPACE
+{
//-----------------------------------------------------------------------------
// Constructor / Destructor
/**
- * \ingroup gdcmSQItem
- * \brief Constructor from a given gdcmSQItem
+ * \brief Constructor from a given SQItem
*/
-gdcmSQItem::gdcmSQItem(int depthLevel )
- : gdcmDocEntrySet(depthLevel)
+SQItem::SQItem(int depthLevel )
+ : DocEntrySet( )
{
- SQDepthLevel = depthLevel +1;
+ SQDepthLevel = depthLevel;
+ SQItemNumber = 0;
}
/**
* \brief Canonical destructor.
*/
-gdcmSQItem::~gdcmSQItem()
+SQItem::~SQItem()
{
- for(ListDocEntry::iterator cc = docEntries.begin();
- cc != docEntries.end();
- ++cc)
- {
- delete (*cc);
- }
- docEntries.clear();
+ ClearEntry();
}
//-----------------------------------------------------------------------------
-// Print
-/*
- * \brief canonical Printer
- */
- void gdcmSQItem::Print(std::ostream & os)
- {
- std::ostringstream s;
-
- if (SQDepthLevel > 0)
- {
- for (int i = 0; i < SQDepthLevel; ++i)
- {
- s << " | " ;
- }
- }
- std::cout << s.str() << " --- SQItem number " << SQItemNumber << std::endl;
- for (ListDocEntry::iterator i = docEntries.begin();
- i != docEntries.end();
- ++i)
- {
- gdcmDocEntry* Entry = *i;
- bool PrintEndLine = true;
-
- os << s.str();
- Entry->SetPrintLevel(2);
- Entry->Print(os);
- if ( gdcmSeqEntry* SeqEntry = dynamic_cast<gdcmSeqEntry*>(Entry) )
- {
- (void)SeqEntry; //not used
- PrintEndLine = false;
- }
- if (PrintEndLine)
- {
- os << std::endl;
- }
- }
-}
-
+// Public
/*
- * \ingroup gdcmSQItem
* \brief canonical Writer
+ * @param fp file pointer to an already open file.
+ * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
*/
-void gdcmSQItem::Write(FILE *fp,FileType filetype)
+void SQItem::WriteContent(std::ofstream *fp, FileType filetype,
+ bool insideMetaElements, bool dummy2)
{
- for (ListDocEntry::iterator i = docEntries.begin();
- i != docEntries.end();
- ++i)
+ int j;
+ uint16_t item[4] = { 0xfffe, 0xe000, 0xffff, 0xffff };
+ uint16_t itemt[4]= { 0xfffe, 0xe00d, 0x0000, 0x0000 };
+
+ //we force the writting of an 'Item' Start Element
+ // because we want to write the Item as a 'No Length' item
+ for(j=0;j<4;++j)
{
- // Item Delimitor Item IS the last one of a 'no length' SQItem
- // (when it exists) we don't write it right now
- // It will be written outside, because ALL the SQItems are written
- // as 'no length'
- if ( (*i)->isItemDelimitor() )
+ binary_write( *fp, item[j]); // fffe e000 ffff ffff
+ }
+
+ for (ListDocEntry::iterator it = DocEntries.begin();
+ it != DocEntries.end();
+ ++it)
+ {
+ // we skip delimitors (start and end one) because
+ // we force them as 'no length'
+ if ( (*it)->GetGroup() == 0xfffe )
{
- break;
+ continue;
}
// Fix in order to make some MR PHILIPS images e-film readable
// see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
// we just *always* ignore spurious fffe|0000 tag !
- if ( (*i)->GetGroup() == 0xfffe && (*i)->GetElement() == 0x0000 )
+ if ( (*it)->GetGroup() == 0xfffe && (*it)->GetElement() == 0x0000 )
{
- break;
+ break; // FIXME : break or continue; ?!?
+ // --> makes no difference since the only bugged file we have
+ // contains 'impossible tag' fffe|0000 in last position !
}
-
- // It's up to the gdcmDocEntry Writter to write the SQItem begin element
- // (fffe|e000) as a 'no length' one
- (*i)->Write(fp, filetype);
+ // false : we are not in MetaElements
+ // true : we are inside a Sequence
+ (*it)->WriteContent(fp, filetype, false, true);
+ }
+
+ //we force the writting of an 'Item Delimitation' item
+ // because we wrote the Item as a 'no Length' item
+ for(j=0;j<4;++j)
+ {
+ binary_write( *fp, itemt[j]); // fffe e000 0000 0000
}
}
-//-----------------------------------------------------------------------------
-// Public
/**
- * \brief adds any Entry (Dicom Element) to the Sequence Item
+ * \brief Compute the full length of the SQItem (not only value length)
+ * depending on the VR.
*/
-bool gdcmSQItem::AddEntry(gdcmDocEntry *entry)
+uint32_t SQItem::ComputeFullLength()
{
- docEntries.push_back(entry);
- //TODO : check if it worked
- return true;
-}
+ uint32_t l = 8; // Item Starter length
+ for (ListDocEntry::iterator it = DocEntries.begin();
+ it != DocEntries.end();
+ ++it)
+ {
+ // we skip delimitors (start and end one) because
+ // we force them as 'no length'
+ if ( (*it)->GetGroup() == 0xfffe )
+ {
+ continue;
+ }
+ l += (*it)->ComputeFullLength();
+ }
+ l += 8; // 'Item Delimitation' item
+ return l;
+}
/**
- * \brief Sets Entry (Dicom Element) value of an element,
- * specified by it's tag (Group, Number)
- * and the length, too ... inside a SQ Item
- * If the Element is not found, it's just created !
- * \warning we suppose, right now, the element belongs to a Public Group
- * (NOT a shadow one)
- * @param val string value to set
- * @param group Group number of the searched tag.
- * @param element Element number of the searched tag.
- * @return true if element was found or created successfully
+ * \brief Inserts *in the right place* any Entry (Dicom Element)
+ * into the Sequence Item
+ * @param entry Entry to add
+ * @return always true
*/
+bool SQItem::AddEntry(DocEntry *entry)
+{
+ if (DocEntries.empty() )
+ {
+ DocEntries.push_back(entry);
+ entry->Register();
+ return true;
+ }
+
+ ListDocEntry::iterator insertSpot;
+ ListDocEntry::iterator it = DocEntries.end();
+ do
+ {
+ it--;
-bool gdcmSQItem::SetEntryByNumber(std::string val,uint16_t group,
- uint16_t element)
-{
- for(ListDocEntry::iterator i = docEntries.begin(); i != docEntries.end(); ++i)
- {
- if ( (*i)->GetGroup() == 0xfffe && (*i)->GetElement() == 0xe000 )
+ if ( (*it)->IsItemDelimitor() )
{
continue;
}
+ if ( (*it)->GetGroup() < entry->GetGroup() )
+ break;
+ else
+ if ( (*it)->GetGroup() == entry->GetGroup() &&
+ (*it)->GetElement() < entry->GetElement() )
+ break;
+ } while (it != DocEntries.begin() );
+
+ ++it;
+ insertSpot = it;
+ DocEntries.insert(insertSpot, entry);
+ entry->Register();
+ return true;
+}
- if ( ( group < (*i)->GetGroup() )
- ||( group == (*i)->GetGroup() && element < (*i)->GetElement()) )
+/**
+ * \brief Clear the std::list from given entry AND delete the entry.
+ * @param entryToRemove Entry to remove AND delete.
+ * @return true if the entry was found and removed; false otherwise
+ */
+bool SQItem::RemoveEntry( DocEntry *entryToRemove )
+{
+ for(ListDocEntry::iterator it = DocEntries.begin();
+ it != DocEntries.end();
+ ++it)
+ {
+ if ( *it == entryToRemove )
{
- // instead of ReplaceOrCreateByNumber
- // that is a method of gdcmDocument :-(
- gdcmValEntry* entry = 0;
- gdcmTagKey key = gdcmDictEntry::TranslateToKey(group, element);
-
- if ( ! PtagHT->count(key))
- {
- // we assume a Public Dictionnary *is* loaded
- gdcmDict *pubDict = gdcmGlobal::GetDicts()->GetDefaultPubDict();
- // if the invoked (group,elem) doesn't exist inside the Dictionary
- // we create a VirtualDictEntry
- gdcmDictEntry *dictEntry = pubDict->GetDictEntryByNumber(group,
- element);
- if (dictEntry == NULL)
- {
- dictEntry =
- gdcmGlobal::GetDicts()->NewVirtualDictEntry(group, element,
- "UN", "??", "??");
- }
- // we assume the constructor didn't fail
- entry = new gdcmValEntry(dictEntry);
- /// \todo
- /// ----
- /// better we don't assume too much !
- /// gdcmSQItem is now used to describe any DICOMDIR related object
- }
- else
- {
- gdcmDocEntry* foundEntry = PtagHT->find(key)->second;
- entry = dynamic_cast<gdcmValEntry*>(foundEntry);
- if (!entry)
- {
- dbg.Verbose(0, "gdcmSQItem::SetEntryByNumber: docEntries"
- " contains non gdcmValEntry occurences");
- }
- }
- if (entry)
- {
- entry->SetValue(val);
- }
- entry->SetLength(val.length());
- docEntries.insert(i,entry);
-
+ DocEntries.erase(it);
+ gdcmDebugMacro( "One element erased: " << entryToRemove->GetKey() );
+ entryToRemove->Unregister();
return true;
- }
- if (group == (*i)->GetGroup() && element == (*i)->GetElement() )
- {
- if ( gdcmValEntry* entry = dynamic_cast<gdcmValEntry*>(*i) )
- {
- entry->SetValue(val);
- }
- (*i)->SetLength(val.length());
- return true;
}
}
- return false;
+ gdcmWarningMacro( "Entry not found: " << entryToRemove->GetKey() );
+ return false ;
}
-//-----------------------------------------------------------------------------
-// Protected
+/**
+ * \brief Remove all entry in the Sequence Item
+ */
+void SQItem::ClearEntry()
+{
+ for(ListDocEntry::iterator cc = DocEntries.begin();
+ cc != DocEntries.end();
+ ++cc)
+ {
+ (*cc)->Unregister();
+ }
+ DocEntries.clear();
+}
/**
- * \brief Gets a Dicom Element inside a SQ Item Entry, by number
- * @return
+ * \brief Get the first Dicom entry while visiting the SQItem
+ * \return The first DocEntry if found, otherwhise 0
+ */
+DocEntry *SQItem::GetFirstEntry()
+{
+ ItDocEntries = DocEntries.begin();
+ if ( ItDocEntries != DocEntries.end() )
+ return *ItDocEntries;
+ return 0;
+}
+
+/**
+ * \brief Get the next Dicom entry while visiting the SQItem
+ * \return The next DocEntry if found, otherwhise NULL
*/
-gdcmDocEntry *gdcmSQItem::GetDocEntryByNumber(uint16_t group, uint16_t element)
+DocEntry *SQItem::GetNextEntry()
{
- for(ListDocEntry::iterator i = docEntries.begin();
- i != docEntries.end(); ++i)
+ ++ItDocEntries;
+ if ( ItDocEntries != DocEntries.end() )
+ return *ItDocEntries;
+ return NULL;
+}
+
+/**
+ * \brief Gets a Dicom Element inside a SQ Item Entry
+ * @param group Group number of the Entry
+ * @param elem Element number of the Entry
+ * @return Entry whose (group,elem) was passed. 0 if not found
+ */
+DocEntry *SQItem::GetDocEntry(uint16_t group, uint16_t elem)
+{
+ for(ListDocEntry::iterator i = DocEntries.begin();
+ i != DocEntries.end();
+ ++i)
{
- if ( (*i)->GetGroup() == group && (*i)->GetElement() == element )
- {
+ if ( (*i)->GetGroup() == group && (*i)->GetElement() == elem )
return *i;
- }
}
- return 0;
+ return NULL;
}
/**
- * \brief Get the value of a Dicom Element inside a SQ Item Entry, by number
- * @return
- */
-
-std::string gdcmSQItem::GetEntryByNumber(uint16_t group, uint16_t element)
+ * \brief Copies all the attributes from an other DocEntrySet
+ * @param set entry to copy from
+ * @remarks The contained DocEntries a not copied, only referenced
+ */
+void SQItem::Copy(DocEntrySet *set)
{
- for(ListDocEntry::iterator i = docEntries.begin();
- i != docEntries.end(); ++i)
+ // Remove all previous entries
+ ClearEntry();
+
+ DocEntrySet::Copy(set);
+
+ SQItem *sq = dynamic_cast<SQItem *>(set);
+ if( sq )
{
- if ( (*i)->GetGroup() == group && (*i)->GetElement() == element)
- {
- return ((gdcmValEntry *)(*i))->GetValue(); //FIXME
- }
+ SQDepthLevel = sq->SQDepthLevel;
+ SQItemNumber = sq->SQItemNumber;
+
+ DocEntries = sq->DocEntries;
+ for(ItDocEntries = DocEntries.begin();ItDocEntries != DocEntries.end();++ItDocEntries)
+ (*ItDocEntries)->Register();
}
- return GDCM_UNFOUND;
}
+
+//-----------------------------------------------------------------------------
+// Protected
+
//-----------------------------------------------------------------------------
// Private
+//-----------------------------------------------------------------------------
+// Print
+/*
+ * \brief canonical Printer
+ * @param os Stream to print to.
+ * @param indent Indentation string to be prepended during printing.
+ */
+void SQItem::Print(std::ostream &os, std::string const &)
+{
+ std::ostringstream s;
+
+ if (SQDepthLevel > 0)
+ {
+ for (int i = 0; i < SQDepthLevel; ++i)
+ {
+ s << " | " ;
+ }
+ }
+ os << s.str() << " --- SQItem number " << SQItemNumber << std::endl;
+ for (ListDocEntry::iterator i = DocEntries.begin();
+ i != DocEntries.end();
+ ++i)
+ {
+ DocEntry *Entry = *i;
+ bool PrintEndLine = true;
+
+ os << s.str();
+ Entry->SetPrintLevel(PrintLevel);
+ Entry->Print(os);
+ if ( dynamic_cast<SeqEntry*>(Entry) )
+ {
+ PrintEndLine = false;
+ }
+ if (PrintEndLine)
+ {
+ os << std::endl;
+ }
+ }
+}
//-----------------------------------------------------------------------------
+} // end namespace gdcm