-// gdcmSQItem.cxx
-//-----------------------------------------------------------------------------
-//
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmSQItem.cxx,v $
+ Language: C++
+ Date: $Date: 2006/02/16 20:06:15 $
+ Version: $Revision: 1.84 $
+
+ 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.html for details.
+
+ This software is distributed WITHOUT ANY WARRANTY; without even
+ the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ PURPOSE. See the above copyright notices for more information.
+
+=========================================================================*/
+
#include "gdcmSQItem.h"
+#include "gdcmSeqEntry.h"
#include "gdcmGlobal.h"
+#include "gdcmDictSet.h"
#include "gdcmUtil.h"
+#include "gdcmDebug.h"
+#include <fstream>
+namespace gdcm
+{
//-----------------------------------------------------------------------------
// Constructor / Destructor
/**
- * \ingroup gdcmSQItem
- * \brief Constructor from a given gdcmSQItem
+ * \brief Constructor from a given SQItem
*/
-gdcmSQItem::gdcmSQItem( )
- : gdcmDocEntrySet() {
+SQItem::SQItem(int depthLevel )
+ : DocEntrySet( )
+{
+ SQDepthLevel = depthLevel;
+ SQItemNumber = 0;
}
/**
* \brief Canonical destructor.
*/
-gdcmSQItem::~gdcmSQItem()
+SQItem::~SQItem()
{
- for(ListDocEntry::iterator cc = docEntries.begin();
- cc != docEntries.end();
- ++cc)
- {
- delete *cc;
- }
+ ClearEntry();
}
-
//-----------------------------------------------------------------------------
-// Print
+// Public
/*
- * \ingroup gdcmSQItem
- * \brief canonical Printer
+ * \brief canonical Writer
+ * @param fp file pointer to an already open file.
+ * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
*/
- void gdcmSQItem::Print(std::ostream & os) {
- std::ostringstream s;
- s << " | " ;
- for (ListDocEntry::iterator i = docEntries.begin();
- i != docEntries.end();
- ++i)
+void SQItem::WriteContent(std::ofstream *fp, FileType filetype)
+{
+ 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)
{
- os << s.str();
- //(*i)->SetPrintLevel(printLevel); //self->GetPrintLevel() ?
- (*i)->SetPrintLevel(2);
- (*i)->Print(os);
+ 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 )
+ {
+ 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 ( (*it)->GetGroup() == 0xfffe && (*it)->GetElement() == 0x0000 )
+ {
+ break; // FIXME : break or continue; ?!?
+ // --> makes no difference since the only bugged file we have
+ // contains 'impossible tag' fffe|0000 in last position !
+ }
+
+ (*it)->WriteContent(fp, filetype);
+ }
+
+ //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 Compute the full length of the SQItem (not only value length)
+ * depending on the VR.
+ */
+uint32_t SQItem::ComputeFullLength()
+{
+ 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;
+}
-bool gdcmSQItem::AddEntry(gdcmDocEntry *entry) {
- std::cout << " === entree ds gdcmSQItem::AddEntry "
- << hex << entry->GetGroup()
- << " "
- << entry->GetElement()
- << " lgt "
- << entry->GetReadLength()
- << std::endl;
-
- docEntries.push_back(entry);
- //TODO : check if it worked
+/**
+ * \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--;
+
+ 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;
}
-
+
+/**
+ * \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 )
+ {
+ DocEntries.erase(it);
+ gdcmDebugMacro( "One element erased: " << entryToRemove->GetKey() );
+ entryToRemove->Unregister();
+ return true;
+ }
+ }
+ gdcmWarningMacro( "Entry not found: " << entryToRemove->GetKey() );
+ return false ;
+}
+
+/**
+ * \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 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
+ */
+DocEntry *SQItem::GetNextEntry()
+{
+ ++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() == elem )
+ return *i;
+ }
+ return NULL;
+}
+
+/**
+ * \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)
+{
+ // Remove all previous entries
+ ClearEntry();
+
+ DocEntrySet::Copy(set);
+
+ SQItem *sq = dynamic_cast<SQItem *>(set);
+ if( sq )
+ {
+ SQDepthLevel = sq->SQDepthLevel;
+ SQItemNumber = sq->SQItemNumber;
+
+ DocEntries = sq->DocEntries;
+ for(ItDocEntries = DocEntries.begin();ItDocEntries != DocEntries.end();++ItDocEntries)
+ (*ItDocEntries)->Register();
+ }
+}
+
//-----------------------------------------------------------------------------
// Protected
//-----------------------------------------------------------------------------
// Private
-// end-user intended : the guy *wants* to create his own SeQuence ?!?
-gdcmDocEntry *gdcmSQItem::NewDocEntryByNumber(guint16 group,
- guint16 element) {
-// TODO
- gdcmDocEntry *a;
- return a;
-}
+//-----------------------------------------------------------------------------
+// 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;
-gdcmDocEntry *gdcmSQItem::NewDocEntryByName (std::string Name) {
-// TODO :
- gdcmDocEntry *a;
- return a;
+ os << s.str();
+ Entry->SetPrintLevel(PrintLevel);
+ Entry->Print(os);
+ if ( dynamic_cast<SeqEntry*>(Entry) )
+ {
+ PrintEndLine = false;
+ }
+ if (PrintEndLine)
+ {
+ os << std::endl;
+ }
+ }
}
+
//-----------------------------------------------------------------------------
+} // end namespace gdcm