-// gdcmSQItem.cxx
-//-----------------------------------------------------------------------------
-//
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmSQItem.cxx,v $
+ Language: C++
+ Date: $Date: 2005/01/30 17:30:57 $
+ Version: $Revision: 1.62 $
+
+ 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 "gdcmValEntry.h"
+#include "gdcmBinEntry.h"
#include "gdcmGlobal.h"
+#include "gdcmDictSet.h"
#include "gdcmUtil.h"
-#include "gdcmValEntry.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(int depthLevel )
- : gdcmDocEntrySet(depthLevel) {
- SQDepthLevel = depthLevel +1;
+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
/*
- * \ingroup gdcmSQItem
* \brief canonical Printer
+ * @param os Stream to print to.
+ * @param indent Indentation string to be prepended during printing.
*/
- void gdcmSQItem::Print(std::ostream & os) {
+void SQItem::Print(std::ostream &os, std::string const &)
+{
std::ostringstream s;
- if (SQDepthLevel>0) {
- for (int i=0;i<SQDepthLevel;i++)
+ if (SQDepthLevel > 0)
+ {
+ for (int i = 0; i < SQDepthLevel; ++i)
+ {
s << " | " ;
+ }
}
- for (ListDocEntry::iterator i = docEntries.begin();
- i != docEntries.end();
- ++i)
+ os << s.str() << " --- SQItem number " << SQItemNumber << std::endl;
+ for (ListDocEntry::iterator i = DocEntries.begin();
+ i != DocEntries.end();
+ ++i)
{
- os << s.str();
- //(*i)->SetPrintLevel(printLevel); //self->GetPrintLevel() ?
- (*i)->SetPrintLevel(2);
- (*i)->Print(os);
+ 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;
+ }
}
}
+/*
+ * \brief canonical Writer
+ * @param fp file pointer to an already open file.
+ * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
+ */
+void SQItem::WriteContent(std::ofstream *fp, FileType filetype)
+{
+ int j;
+ uint16_t item[4] = { 0xfffe, 0xe000, 0xffff, 0xffff };
+ uint16_t itemt[4]= { 0xfffe, 0xe00d, 0xffff, 0xffff };
+
+ //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)
+ {
+ 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 : continue; ?!?
+ }
+
+ (*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 ffff ffff
+ }
+
+}
+
//-----------------------------------------------------------------------------
// Public
+/**
+ * \brief Remove all entry in the Sequence Item
+ */
+void SQItem::ClearEntry()
+{
+ for(ListDocEntry::iterator cc = DocEntries.begin();
+ cc != DocEntries.end();
+ ++cc)
+ {
+ delete *cc;
+ }
+ DocEntries.clear();
+}
+
/**
* \brief adds any Entry (Dicom Element) to the Sequence Item
+ * @param entry Entry to add
*/
-bool gdcmSQItem::AddEntry(gdcmDocEntry *entry) {
- docEntries.push_back(entry);
- //TODO : check if it worked
+bool SQItem::AddEntry(DocEntry *entry)
+{
+ DocEntries.push_back(entry);
return true;
}
-
/**
- * \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 of the searched tag.
- * @param element Element of the searched tag.
- * @return true if element was found or created successfully
+ * \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 gdcmSQItem::SetEntryByNumber(std::string val,guint16 group,
- guint16 element) {
-
- for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i) {
- if ( (*i)->GetGroup() == 0xfffe && (*i)->GetElement() == 0xe000 )
- continue;
- if ( group < (*i)->GetGroup() ||
- (group == (*i)->GetGroup() && element < (*i)->GetElement()) ){
- // instead of ReplaceOrCreateByNumber
- // that is a method of gdcmDocument :-(
- gdcmDocEntry *Entry;
- TagKey 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 gdcmDocEntry(DictEntry);
- /// \todo
- /// ----
- /// better we don't assume too much !
- /// gdcmSQItem is now used to describe any DICOMDIR related object
- ///
- } else {
- Entry = ptagHT->find(key)->second;
- }
- ((gdcmValEntry*)Entry)->SetValue(val);
- Entry->SetLength(val.length());
- docEntries.insert(i,Entry);
- return true;
- }
- if (group == (*i)->GetGroup() && element == (*i)->GetElement() ) {
- ((gdcmValEntry*)(*i))->SetValue(val);
- (*i)->SetLength(val.length());
- return true;
- }
- }
-}
-//-----------------------------------------------------------------------------
-// Protected
-
-//-----------------------------------------------------------------------------
-// Private
-
-// end-user intended : the guy *wants* to create his own SeQuence ?!?
-
-/// \brief to be written if really usefull
-gdcmDocEntry *gdcmSQItem::NewDocEntryByNumber(guint16 group,
- guint16 element) {
-// TODO
- gdcmDocEntry *a;
- std::cout << " gdcmSQItem::NewDocEntryByNumber : TODO" <<std::endl;
- return a;
-}
-
-/// \brief to be written if really usefull
-gdcmDocEntry *gdcmSQItem::NewDocEntryByName (std::string Name) {
-// TODO
- gdcmDocEntry *a;
- std::cout << " gdcmSQItem::NewDocEntryByName : TODO" <<std::endl;
- return a;
+bool SQItem::RemoveEntry( DocEntry *entryToRemove)
+{
+ for(ListDocEntry::iterator it = DocEntries.begin();
+ it != DocEntries.end();
+ ++it)
+ {
+ if( *it == entryToRemove)
+ {
+ DocEntries.erase(it);
+ gdcmVerboseMacro( "One element erased: " << entryToRemove->GetKey() );
+ delete entryToRemove;
+ return true;
+ }
+ }
+ gdcmVerboseMacro( "Entry not found: " << entryToRemove->GetKey() );
+ return false ;
}
/**
- * \ingroup gdcmSQItem
- * \brief Gets a Dicom Element inside a SQ Item Entry, by name
- * @return
+ * \brief Clear the std::list from given entry BUT keep the entry.
+ * @param entryToRemove Entry to remove.
+ * @return true if the entry was found and removed; false otherwise
*/
- gdcmDocEntry *gdcmSQItem::GetDocEntryByName(std::string name) {
- gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();
- gdcmDictEntry *dictEntry = (*PubDict).GetDictEntryByName(name);
- if( dictEntry == NULL)
- return NULL;
- return GetDocEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement());
+bool SQItem::RemoveEntryNoDestroy(DocEntry *entryToRemove)
+{
+ for(ListDocEntry::iterator it = DocEntries.begin();
+ it != DocEntries.end();
+ ++it)
+ {
+ if( *it == entryToRemove)
+ {
+ DocEntries.erase(it);
+ gdcmVerboseMacro( "One element erased, no destroyed: "
+ << entryToRemove->GetKey() );
+ return true;
+ }
+ }
+
+ gdcmVerboseMacro( "Entry not found:" << entryToRemove->GetKey() );
+ return false ;
}
-
+
/**
- * \ingroup gdcmSQItem
- * \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
*/
-gdcmDocEntry *gdcmSQItem::GetDocEntryByNumber(guint16 group, guint16 element) {
- for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i) {
- if ( (*i)->GetGroup()==group && (*i)->GetElement()==element)
- return (*i);
- }
- return NULL;
+DocEntry *SQItem::GetFirstEntry()
+{
+ ItDocEntries = DocEntries.begin();
+ if (ItDocEntries != DocEntries.end())
+ return *ItDocEntries;
+ return 0;
}
-
+
/**
- * \ingroup gdcmSQItem
- * \brief Get the value of a Dicom Element inside a SQ Item Entry, by number
- * @return
- */
-
-std::string gdcmSQItem::GetEntryByNumber(guint16 group, guint16 element) {
- for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i) {
- if ( (*i)->GetGroup()==group && (*i)->GetElement()==element) {
- return ((gdcmValEntry *)(*i))->GetValue();
- }
- }
- return GDCM_UNFOUND;
+ * \brief Get the next Dicom entry while visiting the chained list
+ * \return The next DocEntry if found, otherwhise NULL
+ */
+DocEntry *SQItem::GetNextEntry()
+{
+ ++ItDocEntries;
+ if (ItDocEntries != DocEntries.end())
+ return *ItDocEntries;
+ return NULL;
}
/**
- * \ingroup gdcmSQItem
- * \brief Get the value of a Dicom Element inside a SQ Item Entry, by name
- * @param name : name of the searched element.
- * @return
- */
-
-std::string gdcmSQItem::GetEntryByName(TagName name) {
- gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict();
- gdcmDictEntry *dictEntry = (*PubDict).GetDictEntryByName(name);
-
- if( dictEntry == NULL)
- return GDCM_UNFOUND;
- return GetEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement());
+ * \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;
}
//-----------------------------------------------------------------------------
+// Protected
+
+//-----------------------------------------------------------------------------
+// Private
+
+
+//-----------------------------------------------------------------------------
+
+} // end namespace gdcm