X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.cxx;h=7ba938fbe1bafd65fe0a4bbc78c767dbe1bdc4d6;hb=83d626ec3d3111a6d14586246b6e2dda56f0ab86;hp=e33a0cbc06dbcf060661c8b820800e154df9640b;hpb=ecac4d36edf15736ae8f516ef3f9d8a6396ed54c;p=gdcm.git diff --git a/src/gdcmDocEntrySet.cxx b/src/gdcmDocEntrySet.cxx index e33a0cbc..7ba938fb 100644 --- a/src/gdcmDocEntrySet.cxx +++ b/src/gdcmDocEntrySet.cxx @@ -3,268 +3,543 @@ Program: gdcm Module: $RCSfile: gdcmDocEntrySet.cxx,v $ Language: C++ - Date: $Date: 2004/08/01 03:20:23 $ - Version: $Revision: 1.15 $ + Date: $Date: 2006/01/27 10:01:33 $ + Version: $Revision: 1.69 $ 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 PURPOSE. See the above copyright notices for more information. =========================================================================*/ +#include "gdcmDocEntrySet.h" #include "gdcmDebug.h" #include "gdcmCommon.h" +#include "gdcmDictSet.h" #include "gdcmGlobal.h" -#include "gdcmDocEntrySet.h" -#include "gdcmException.h" #include "gdcmDocEntry.h" #include "gdcmSeqEntry.h" -#include "gdcmValEntry.h" -#include "gdcmBinEntry.h" +#include "gdcmUtil.h" +#include "gdcmDataEntry.h" +#include "gdcmVR.h" +#if defined(__BORLANDC__) + #include // for memset +#endif + +namespace gdcm +{ //----------------------------------------------------------------------------- // Constructor / Destructor +DocEntrySet::DocEntrySet() +{ + PreviousDocEntry = 0; +} +//----------------------------------------------------------------------------- +// Public /** - * \ingroup gdcmDocEntrySet - * \brief Constructor from a given gdcmDocEntrySet + * \brief Get the "std::string representable" value of the Dicom entry + * @param group Group number of the searched tag. + * @param elem Element number of the searched tag. + * @return Corresponding element value when it exists, + * and the string GDCM_UNFOUND otherwise. */ -gdcmDocEntrySet::gdcmDocEntrySet(int depthLevel) +std::string DocEntrySet::GetEntryString(uint16_t group, uint16_t elem) { - SQDepthLevel = depthLevel + 1; //magic +1 ! + DataEntry *entry = dynamic_cast(GetDocEntry(group,elem)); + if ( entry ) + { + if( entry->IsNotLoaded() ) + return GDCM_NOTLOADED; + if( entry->IsUnfound() ) + return GDCM_UNFOUND; + if( entry->IsUnread() ) + return GDCM_UNREAD; + return entry->GetString(); + } + return GDCM_UNFOUND; } + /** - * \brief Canonical destructor. + * \brief Gets (from Header) a 'non string' element value + * @param group group number of the Entry + * @param elem element number of the Entry + * @return Pointer to the 'non string' area */ -gdcmDocEntrySet::~gdcmDocEntrySet() +void *DocEntrySet::GetEntryBinArea(uint16_t group, uint16_t elem) { + DataEntry *entry = GetDataEntry(group, elem); + if ( entry ) + return entry->GetBinArea(); + return 0; } -//----------------------------------------------------------------------------- -// Print -/* - * \ingroup gdcmDocEntrySet - * \brief canonical Printer - */ +/** + * \brief Searches within the DocEntrySet + * for the value length of a given tag.. + * @param group Group number of the searched tag. + * @param elem Element number of the searched tag. + * @return Corresponding element length; -1 if not found + */ +int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem) +{ + DocEntry *entry = GetDocEntry(group, elem); + if ( entry ) + return entry->GetLength(); + return -1; +} -//----------------------------------------------------------------------------- -// Public +/** + * \brief Same as \ref Document::GetDocEntry except it returns a result + * only when the corresponding entry is of type DataEntry. + * @param group Group number of the searched Dicom Element + * @param elem Element number of the searched Dicom Element + * @return When present, the corresponding DataEntry. + */ +DataEntry *DocEntrySet::GetDataEntry(uint16_t group, uint16_t elem) +{ + DocEntry *currentEntry = GetDocEntry(group, elem); + if ( !currentEntry ) + return NULL; + return dynamic_cast(currentEntry); +} +/** + * \brief Same as \ref Document::GetDocEntry except it returns a result + * only when the corresponding entry is of type SeqEntry. + * @param group Group number of the searched Dicom Element + * @param elem Element number of the searched Dicom Element + * @return When present, the corresponding SeqEntry. + */ +SeqEntry *DocEntrySet::GetSeqEntry(uint16_t group, uint16_t elem) +{ + DocEntry *currentEntry = GetDocEntry(group, elem); + if ( !currentEntry ) + return NULL; + + return dynamic_cast(currentEntry); +} /** - * \brief Build a new Element Value from all the low level arguments. - * Check for existence of dictionary entry, and build - * a default one when absent. - * @param Group group number of the underlying DictEntry - * @param Elem element number of the underlying DictEntry + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * through it's (group, element) and modifies it's content with + * the given value. + * @param content new value (string) to substitute with + * @param group group number of the Dicom Element to modify + * @param elem element number of the Dicom Element to modify */ -gdcmValEntry *gdcmDocEntrySet::NewValEntryByNumber(uint16_t group, - uint16_t elem) +bool DocEntrySet::SetEntryString(std::string const &content, + uint16_t group, uint16_t elem) { - // Find out if the tag we encountered is in the dictionaries: - gdcmDictEntry *dictEntry = GetDictEntryByNumber(group, elem); - if (!dictEntry) + DataEntry *entry = GetDataEntry(group, elem); + if (!entry ) { - dictEntry = NewVirtualDictEntry(group, elem); + gdcmWarningMacro( "No corresponding DataEntry " << std::hex << group << + "," << elem << " element (try promotion first)."); + return false; } + return SetEntryString(content,entry); +} - gdcmValEntry *newEntry = new gdcmValEntry(dictEntry); - if (!newEntry) +/** + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * through it's (group, element) and modifies it's content with + * the given value. + * @param content new value (void* -> uint8_t*) to substitute with + * @param lgth new value length + * @param group group number of the Dicom Element to modify + * @param elem element number of the Dicom Element to modify + */ +bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, + uint16_t group, uint16_t elem) +{ + DataEntry *entry = GetDataEntry(group, elem); + if (!entry ) { - dbg.Verbose(1, "gdcmDocument::NewValEntryByNumber", - "failed to allocate gdcmValEntry"); - return 0; + gdcmWarningMacro( "No corresponding DataEntry " << std::hex << group << + "," << elem << " element (try promotion first)."); + return false; } - return newEntry; -} + return SetEntryBinArea(content,lgth,entry); +} /** - * \brief Build a new Element Value from all the low level arguments. - * Check for existence of dictionary entry, and build - * a default one when absent. - * @param Group group number of the underlying DictEntry - * @param Elem element number of the underlying DictEntry + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * and modifies it's content with the given value. + * @param content new value (string) to substitute with + * @param entry Entry to be modified */ -gdcmBinEntry *gdcmDocEntrySet::NewBinEntryByNumber(uint16_t group, - uint16_t elem) +bool DocEntrySet::SetEntryString(std::string const &content, DataEntry *entry) { - // Find out if the tag we encountered is in the dictionaries: - gdcmDictEntry *dictEntry = GetDictEntryByNumber(group, elem); - if (!dictEntry) + if (entry) { - dictEntry = NewVirtualDictEntry(group, elem); + entry->SetString(content); + return true; } + return false; +} - gdcmBinEntry *newEntry = new gdcmBinEntry(dictEntry); - if (!newEntry) +/** + * \brief Accesses an existing DataEntry (i.e. a Dicom Element) + * and modifies it's content with the given value. + * @param content new value (void* -> uint8_t*) to substitute with + * @param entry Entry to be modified + * @param lgth new value length + */ +bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry) +{ + if (entry) { - dbg.Verbose(1, "gdcmDocument::NewBinEntryByNumber", - "failed to allocate gdcmBinEntry"); - return 0; + entry->SetLength(lgth); + entry->SetBinArea(content); + return true; } - return newEntry; + return false; } -//----------------------------------------------------------------------------- -// Protected /** - * \brief Gets a Dicom Element inside a SQ Item Entry, by name - * @return - */ - gdcmDocEntry *gdcmDocEntrySet::GetDocEntryByName(std::string const & name) - { - gdcmDict *pubDict = gdcmGlobal::GetDicts()->GetDefaultPubDict(); - gdcmDictEntry *dictEntry = pubDict->GetDictEntryByName(name); - if( !dictEntry ) + * \brief Modifies the value of a given Doc Entry (Dicom Element) + * when it exists. Create it with the given value when unexistant. + * @param value (string) Value to be set + * @param group Group number of the Entry + * @param elem Element number of the Entry + * @param vr V(alue) R(epresentation) of the Entry -if private Entry- + * \return pointer to the modified/created Header Entry (NULL when creation + * failed). + */ +DataEntry *DocEntrySet::InsertEntryString(std::string const &value, + uint16_t group, uint16_t elem, + VRKey const &vr ) +{ + DataEntry *dataEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem ); + + if (currentEntry) { - return 0; + dataEntry = dynamic_cast(currentEntry); + + // Verify the VR + if ( dataEntry ) + if ( dataEntry->GetVR()!=vr ) + dataEntry = NULL; + + // if currentEntry doesn't correspond to the requested dataEntry + if ( !dataEntry) + { + if ( !RemoveEntry(currentEntry) ) + { + gdcmWarningMacro( "Removal of previous DocEntry failed."); + return NULL; + } + } } - return GetDocEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement()); -} + // Create a new dataEntry if necessary + if ( !dataEntry ) + { + dataEntry = NewDataEntry( group, elem, vr ); + + if ( !AddEntry(dataEntry) ) + { + gdcmWarningMacro("AddEntry failed although this is a creation."); + dataEntry->Delete(); + return NULL; + } + dataEntry->Delete(); + } + // Set the dataEntry value + SetEntryString(value, dataEntry); // The std::string value + return dataEntry; +} /** - * \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 gdcmDocEntrySet::GetEntryByName(TagName const & name) + * \brief Modifies the value of a given Header Entry (Dicom Element) + * when it exists. Create it with the given value when unexistant. + * A copy of the binArea is made to be kept in the Document. + * @param binArea (binary) value to be set + * @param lgth length of the Bin Area we want to set + * @param group Group number of the Entry + * @param elem Element number of the Entry + * @param vr V(alue) R(epresentation) of the Entry -if private Entry- + * \return pointer to the modified/created Header Entry (NULL when creation + * failed). + */ +DataEntry *DocEntrySet::InsertEntryBinArea(uint8_t *binArea, int lgth, + uint16_t group, uint16_t elem, + VRKey const &vr ) { - gdcmDict *pubDict = gdcmGlobal::GetDicts()->GetDefaultPubDict(); - gdcmDictEntry *dictEntry = pubDict->GetDictEntryByName(name); + DataEntry *dataEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem ); - if( !dictEntry ) + // Verify the currentEntry + if (currentEntry) { - return GDCM_UNFOUND; + dataEntry = dynamic_cast(currentEntry); + + // Verify the VR + if ( dataEntry ) + if ( dataEntry->GetVR()!=vr ) + dataEntry = NULL; + + // if currentEntry doesn't correspond to the requested dataEntry + if ( !dataEntry) + { + if ( !RemoveEntry(currentEntry) ) + { + gdcmWarningMacro( "Removal of previous DocEntry failed."); + return NULL; + } + } } - return GetEntryByNumber(dictEntry->GetGroup(), dictEntry->GetElement()); -} + // Create a new dataEntry if necessary + if ( !dataEntry) + { + dataEntry = NewDataEntry(group, elem, vr); + + if ( !AddEntry(dataEntry) ) + { + gdcmWarningMacro( "AddEntry failed although this is a creation."); + dataEntry->Delete(); + return NULL; + } + dataEntry->Delete(); + } + + // Set the dataEntry value + uint8_t *tmpArea; + if ( lgth>0 && binArea ) + { + tmpArea = new uint8_t[lgth]; + memcpy(tmpArea,binArea,lgth); + } + else + { + tmpArea = 0; + } + if ( !SetEntryBinArea(tmpArea,lgth,dataEntry) ) + { + if ( tmpArea ) + { + delete[] tmpArea; + } + } + return dataEntry; +} +/** + * \brief Creates a new gdcm::SeqEntry and adds it to the current DocEntrySet. + * (remove any existing entry with same group,elem) + * @param group Group number of the Entry + * @param elem Element number of the Entry + * \return pointer to the created SeqEntry (NULL when creation + * failed). + */ +SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem) +{ + SeqEntry *seqEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem ); + // Verify the currentEntry + if ( currentEntry ) + { + seqEntry = dynamic_cast(currentEntry); + + // Verify the VR + if ( seqEntry ) + seqEntry = NULL; + + // if currentEntry doesn't correspond to the requested seqEntry + if ( !seqEntry ) + { + if (!RemoveEntry(currentEntry)) + { + gdcmWarningMacro( "Removal of previous DocEntry failed for (" + <Delete(); + return NULL; + } + seqEntry->Delete(); + } + // Remark : + // SequenceDelimitationItem will be added at the end of the SeqEntry, + // at write time + return seqEntry; +} + /** - * \brief Request a new virtual dict entry to the dict set - * @param group group number of the underlying DictEntry - * @param element element number of the underlying DictEntry - * @param vr VR of the underlying DictEntry - * @param fourth owner group - * @param name english name + * \brief Checks if a given Dicom Element exists within the DocEntrySet + * @param group Group number of the searched Dicom Element + * @param elem Element number of the searched Dicom Element + * @return true is found */ -gdcmDictEntry* gdcmDocEntrySet::NewVirtualDictEntry(uint16_t group, - uint16_t element, - std::string const & vr, - std::string const & fourth, - std::string const & name) +bool DocEntrySet::CheckIfEntryExist(uint16_t group, uint16_t elem ) { - return gdcmGlobal::GetDicts()->NewVirtualDictEntry(group,element,vr,fourth,name); + return GetDocEntry(group,elem)!=NULL; } -/** \brief - * Probabely move, as is, to gdcmDocEntrySet, as a non virtual method - * an remove gdcmDocument::NewDocEntryByNumber +/** + * \brief Build a new DataEntry from all the low level arguments. + * Check for existence of dictionary entry, and build + * a default one when absent. + * @param group Group number of the new Entry + * @param elem Element number of the new Entry + * @param vr V(alue) R(epresentation) of the new Entry + * \remarks The user of this method must destroy the DataEntry when unused */ -gdcmDocEntry* gdcmDocEntrySet::NewDocEntryByNumber(uint16_t group, - uint16_t elem) +DataEntry *DocEntrySet::NewDataEntry(uint16_t group,uint16_t elem, + VRKey const &vr) { - // Find out if the tag we encountered is in the dictionaries: - gdcmDict *pubDict = gdcmGlobal::GetDicts()->GetDefaultPubDict(); - gdcmDictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, elem); - if (!dictEntry) - { - dictEntry = NewVirtualDictEntry(group, elem); - } + DictEntry *dictEntry = GetDictEntry(group, elem, vr); - gdcmDocEntry *newEntry = new gdcmDocEntry(dictEntry); + DataEntry *newEntry = DataEntry::New(dictEntry); + dictEntry->Unregister(); // GetDictEntry register it if (!newEntry) { - dbg.Verbose(1, "gdcmSQItem::NewDocEntryByNumber", - "failed to allocate gdcmDocEntry"); + gdcmWarningMacro( "Failed to allocate DataEntry for (" + <GetDefaultPubDict(); - gdcmDictEntry *newTag = pubDict->GetDictEntryByName(name); - if (!newTag) - { - newTag = NewVirtualDictEntry(0xffff, 0xffff, "LO", "unkn", name); - } + DictEntry *dictEntry = GetDictEntry(group, elem, "SQ"); - gdcmDocEntry* newEntry = new gdcmDocEntry(newTag); - if (!newEntry) + SeqEntry *newEntry = SeqEntry::New( dictEntry ); + dictEntry->Unregister(); // GetDictEntry register it + if (!newEntry) { - dbg.Verbose(1, "gdcmSQItem::ObtainDocEntryByName", - "failed to allocate gdcmDocEntry"); + gdcmWarningMacro( "Failed to allocate SeqEntry for (" + <GetDefaultPubDict(); + DictEntry *found = 0; + Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); if (!pubDict) { - dbg.Verbose(0, "gdcmDocument::GetDictEntry", - "we SHOULD have a default dictionary"); + gdcmWarningMacro( "We SHOULD have a default dictionary"); } else { - found = pubDict->GetDictEntryByName(name); + found = pubDict->GetEntry(group, elem); + if( found ) + found->Register(); } return found; } /** - * \brief Searches both the public and the shadow dictionary (when they - * exist) for the presence of the DictEntry with given - * group and element. The public dictionary has precedence on the - * shadow one. - * @param group group number of the searched DictEntry - * @param element element number of the searched DictEntry + * \brief Searches [both] the public [and the shadow dictionary (when they + * exist)] for the presence of the DictEntry with given + * group and element, and create a new virtual DictEntry if necessary + * @param group group number of the searched DictEntry + * @param elem element number of the searched DictEntry + * @param vr V(alue) R(epresentation) to use, if necessary * @return Corresponding DictEntry when it exists, NULL otherwise. + * \remarks The returned DictEntry is registered */ -gdcmDictEntry *gdcmDocEntrySet::GetDictEntryByNumber(uint16_t group, - uint16_t element) +DictEntry *DocEntrySet::GetDictEntry(uint16_t group, uint16_t elem, + VRKey const &vr) { - gdcmDictEntry *found = 0; - gdcmDict *pubDict = gdcmGlobal::GetDicts()->GetDefaultPubDict(); - if (!pubDict) + DictEntry *dictEntry = GetDictEntry(group,elem); + DictEntry *goodEntry = dictEntry; + VRKey goodVR = vr; + TagName vm; + if (elem == 0x0000) + goodVR="UL"; + + if ( goodEntry ) { - dbg.Verbose(0, "gdcmDocument::GetDictEntry", - "we SHOULD have a default dictionary"); + if ( goodVR != goodEntry->GetVR() + && goodVR != GDCM_VRUNKNOWN ) + { + gdcmWarningMacro("For (" << std::hex << group << "|" + << elem << "), found VR : [" << vr << "]" + << " expected: [" << goodEntry->GetVR() << "]" ) ; + // avoid confusing further validator with "FIXME" VM + // when possible + vm = dictEntry->GetVM(); + goodEntry = NULL; + } + dictEntry->Unregister(); } else { - found = pubDict->GetDictEntryByNumber(group, element); + vm = "FIXME"; } - return found; + // Create a new virtual DictEntry if necessary + if (!goodEntry) + { + if (dictEntry) + { + + goodEntry = DictEntry::New(group, elem, goodVR, vm,//"FIXME", + dictEntry->GetName() ); + } + else + { + goodEntry = DictEntry::New(group, elem, goodVR); + } + } + else + { + goodEntry->Register(); + } + return goodEntry; } - //----------------------------------------------------------------------------- // Private +//----------------------------------------------------------------------------- +// Print //----------------------------------------------------------------------------- +} // end namespace gdcm