Program: gdcm
Module: $RCSfile: gdcmSQItem.cxx,v $
Language: C++
- Date: $Date: 2004/07/17 22:47:01 $
- Version: $Revision: 1.21 $
+ Date: $Date: 2005/01/24 16:44:54 $
+ Version: $Revision: 1.58 $
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 "gdcmValEntry.h"
#include "gdcmBinEntry.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(int depthLevel )
- : gdcmDocEntrySet(depthLevel) {
- SQDepthLevel = depthLevel +1;
+SQItem::SQItem(int depthLevel )
+ : DocEntrySet( )
+{
+ SQDepthLevel = depthLevel;
}
/**
* \brief Canonical destructor.
*/
-gdcmSQItem::~gdcmSQItem()
+SQItem::~SQItem()
{
- for(ListDocEntry::iterator cc = docEntries.begin();
- cc != docEntries.end();
- ++cc)
+ for(ListDocEntry::iterator cc = DocEntries.begin();
+ cc != DocEntries.end();
+ ++cc)
{
- delete (*cc);
+ delete *cc;
}
- docEntries.clear();
+ DocEntries.clear();
}
//-----------------------------------------------------------------------------
// Print
/*
* \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)
+ if (SQDepthLevel > 0)
{
- for (int i=0;i<SQDepthLevel;i++)
+ 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();
+ os << s.str() << " --- SQItem number " << SQItemNumber << std::endl;
+ for (ListDocEntry::iterator i = DocEntries.begin();
+ i != DocEntries.end();
++i)
{
- gdcmDocEntry* Entry = *i;
+ DocEntry *Entry = *i;
bool PrintEndLine = true;
os << s.str();
- Entry->SetPrintLevel(2);
- Entry->Print(os);
- if ( gdcmSeqEntry* SeqEntry = dynamic_cast<gdcmSeqEntry*>(Entry) )
+ Entry->SetPrintLevel(PrintLevel);
+ Entry->Print(os);
+ if ( dynamic_cast<SeqEntry*>(Entry) )
{
- (void)SeqEntry; //not used
PrintEndLine = false;
}
if (PrintEndLine)
+ {
os << std::endl;
+ }
}
}
/*
- * \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)
{
- 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, 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)
{
- // 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() )
- break;
+ 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 ( ((*i)->GetGroup() == 0xfffe) && ((*i)->GetElement() == 0x0000) )
- break;
+ if ( (*it)->GetGroup() == 0xfffe && (*it)->GetElement() == 0x0000 )
+ {
+ break; // FIXME : continue; ?!?
+ }
- // It's up to the gdcmDocEntry Writter to write the SQItem begin element
- // (fffe|e000) as a 'no length' one
- (*i)->Write(fp, filetype);
- }
+ (*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 adds any Entry (Dicom Element) to the Sequence Item
+ * @param entry Entry to add
*/
-bool gdcmSQItem::AddEntry(gdcmDocEntry *entry)
+bool SQItem::AddEntry(DocEntry *entry)
{
- docEntries.push_back(entry);
+ DocEntries.push_back(entry);
//TODO : check if it worked
return true;
}
* \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.
+ * @param group Group number of the searched tag.
+ * @param elem Element number of the searched tag.
* @return true if element was found or created successfully
*/
-bool gdcmSQItem::SetEntryByNumber(std::string val,uint16_t group,
- uint16_t element)
+bool SQItem::SetEntryValue(std::string const &val, uint16_t group,
+ uint16_t elem)
{
- for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i)
+ 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()) )
+ if ( ( group < (*i)->GetGroup() )
+ ||( group == (*i)->GetGroup() && elem < (*i)->GetElement()) )
{
- // instead of ReplaceOrCreateByNumber
- // that is a method of gdcmDocument :-(
- gdcmValEntry* Entry = (gdcmValEntry*)0;
- gdcmTagKey key = gdcmDictEntry::TranslateToKey(group, element);
+ // instead of Insert, that is a method of Document :-(
+ ValEntry* entry = 0;
+ TagKey key = DictEntry::TranslateToKey(group, elem);
- if ( ! ptagHT->count(key))
+ // we assume a Public Dictionary *is* loaded
+ Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
+ // if the invoked (group,elem) doesn't exist inside the Dictionary
+ // we create a VirtualDictEntry
+ DictEntry *dictEntry = pubDict->GetEntry(group, elem);
+ if (dictEntry == NULL)
+ {
+ dictEntry =
+ Global::GetDicts()->NewVirtualDictEntry(group, elem,
+ "UN", GDCM_UNKNOWN,
+ GDCM_UNKNOWN);
+ }
+ // we assume the constructor didn't fail
+ entry = new ValEntry(dictEntry);
+ if (entry)
{
- // 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");
+ entry->SetValue(val);
}
- if (Entry)
- Entry->SetValue(val);
- Entry->SetLength(val.length());
- docEntries.insert(i,Entry);
+ DocEntries.insert(i,entry);
+
return true;
}
- if (group == (*i)->GetGroup() && element == (*i)->GetElement() )
+ if (group == (*i)->GetGroup() && elem == (*i)->GetElement() )
{
- if ( gdcmValEntry* Entry = dynamic_cast<gdcmValEntry*>(*i) )
- Entry->SetValue(val);
- (*i)->SetLength(val.length());
+ if ( ValEntry *entry = dynamic_cast<ValEntry*>(*i) )
+ {
+ entry->SetValue(val);
+ }
return true;
}
}
return false;
}
-//-----------------------------------------------------------------------------
-// Protected
+/**
+ * \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);
+ gdcmVerboseMacro( "One element erased: " << entryToRemove->GetKey() );
+ delete entryToRemove;
+ return true;
+ }
+ }
+ gdcmVerboseMacro( "Entry not found: " << entryToRemove->GetKey() );
+ return false ;
+}
/**
- * \brief Gets a Dicom Element inside a SQ Item Entry, by number
- * @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::GetDocEntryByNumber(uint16_t group, uint16_t element)
+bool SQItem::RemoveEntryNoDestroy(DocEntry* entryToRemove)
{
- for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i)
+ for(ListDocEntry::iterator it = DocEntries.begin();
+ it != DocEntries.end();
+ ++it)
{
- if ( (*i)->GetGroup()==group && (*i)->GetElement()==element)
+ if( *it == entryToRemove)
{
- return (*i);
+ DocEntries.erase(it);
+ gdcmVerboseMacro( "One element erased, no destroyed: "
+ << entryToRemove->GetKey() );
+ return true;
}
- }
- return NULL;
+ }
+
+ gdcmVerboseMacro( "Entry not found:" << entryToRemove->GetKey() );
+ return false ;
+}
+
+/**
+ * \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 chained list
+ * \return The next DocEntry if found, otherwhise NULL
+ */
+DocEntry *SQItem::GetNextEntry()
+{
+ // gdcmAssertMacro (ItDocEntries != DocEntries.end());
+ {
+ ++ItDocEntries;
+ if (ItDocEntries != DocEntries.end())
+ return *ItDocEntries;
+ return NULL;
+ }
+}
+
+//-----------------------------------------------------------------------------
+// Protected
+/**
+ * \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 0;
+}
+
+/**
+ * \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
+ */
+ValEntry* SQItem::GetValEntry(uint16_t group, uint16_t elem)
+{
+ DocEntry *d = GetDocEntry(group, elem);
+ if ( ValEntry *e = dynamic_cast<ValEntry*>(d) )
+ return e;
+ return 0;
+}
+
+/**
+ * \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
+ */
+BinEntry* SQItem::GetBinEntry(uint16_t group, uint16_t elem)
+{
+ DocEntry *d = GetDocEntry(group, elem);
+ if ( BinEntry *e = dynamic_cast<BinEntry*>(d) )
+ return e;
+ return 0;
}
/**
- * \brief Get the value of a Dicom Element inside a SQ Item Entry, by number
- * @return
+ * \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
+ */
+SeqEntry* SQItem::GetSeqEntry(uint16_t group, uint16_t elem)
+{
+ DocEntry *d = GetDocEntry(group, elem);
+ if ( SeqEntry *e = dynamic_cast<SeqEntry*>(d) )
+ return e;
+ return 0;
+}
+
+
+/**
+ * \brief Get the value of a Dicom Element inside a SQ Item Entry
+ * \note : meaningfull only if the required entry is NEITHER a SeqEntry
+ * NOR a BinEntry
+ * @param group Group number of the Entry
+ * @param elem Element number of the Entry
+ * @return 'string value' of the entry whose (group,elem) was passed.
+ * GDCM_UNFOUND if not found
*/
-std::string gdcmSQItem::GetEntryByNumber(uint16_t group, uint16_t element)
-{
- for(ListDocEntry::iterator i=docEntries.begin();i!=docEntries.end();++i)
+std::string SQItem::GetEntryValue(uint16_t group, uint16_t elem)
+{
+
+/*
+ DocEntry *e = GetFirstEntry();
+ while (e)
{
- if ( (*i)->GetGroup()==group && (*i)->GetElement()==element)
+ if ( e->GetGroup() == group && e->GetElement() == elem)
{
- return ((gdcmValEntry *)(*i))->GetValue();
+
+ if (ValEntry *ve = dynamic_cast<ValEntry*>(e))
+ return ve->GetValue();
}
+ e = GetNextEntry();
}
+*/
+ for(ListDocEntry::iterator i = DocEntries.begin();
+ i != DocEntries.end(); ++i)
+ {
+ if ( (*i)->GetGroup() == group && (*i)->GetElement() == elem)
+ {
+ if (ValEntry *ve = dynamic_cast<ValEntry*>(*i))
+ return ve->GetValue();
+ }
+ }
return GDCM_UNFOUND;
}
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
+
+} // end namespace gdcm