X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.cxx;h=0b4ff26d8456da0553535c17bd24f7cd6a48ce11;hb=536e773e8f72c8e949831abf6496c348d5badf2d;hp=8c9cd310d8b35954b78ff28da4e4bccd5d52b768;hpb=c1e76b5446c340a4b2df46cabedeab2d71bd45f8;p=gdcm.git diff --git a/src/gdcmDocEntrySet.cxx b/src/gdcmDocEntrySet.cxx index 8c9cd310..0b4ff26d 100644 --- a/src/gdcmDocEntrySet.cxx +++ b/src/gdcmDocEntrySet.cxx @@ -3,243 +3,573 @@ Program: gdcm Module: $RCSfile: gdcmDocEntrySet.cxx,v $ Language: C++ - Date: $Date: 2004/06/22 14:02:31 $ - Version: $Revision: 1.11 $ + Date: $Date: 2005/10/18 12:58:28 $ + Version: $Revision: 1.61 $ 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 #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" +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) { - SQDepthLevel = depthLevel + 1; +std::string DocEntrySet::GetEntryString(uint16_t group, uint16_t elem) +{ + 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 Return the value of the DataEntry if it's "std::string representable" + * @param group Group number of the searched tag. + * @param elem Element number of the searched tag. + * @return Corresponding element value when it's "std::string representable" + * and the string GDCM_NOTASCII otherwise. + */ +std::string DocEntrySet::GetEntryForcedAsciiValue(uint16_t group, uint16_t elem) +{ + DocEntry *d = GetDocEntry(group,elem); + if ( !d ) + return GDCM_UNFOUND; -//----------------------------------------------------------------------------- -// Public + DataEntry *de = dynamic_cast(d); + if ( de ) + { + if( de->IsNotLoaded() ) + return GDCM_NOTLOADED; + if( de->IsUnfound() ) + return GDCM_UNFOUND; + if( de->IsUnread() ) + return GDCM_UNREAD; + } + if( Global::GetVR()->IsVROfStringRepresentable( de->GetVR() ) ) + return de->GetString(); + else + { + uint8_t *a = de->GetBinArea(); + if( Util::IsCleanArea(a, de->GetLength()) ) + return Util::CreateCleanString(a, de->GetLength()); + } + return GDCM_NOTASCII; +} +/** + * \brief Searches within Header Entries (Dicom Elements) parsed with + * the public and private dictionaries + * 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; -2 if not found + */ +int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem) +{ + DocEntry *entry = GetDocEntry(group, elem); + if ( entry ) + return entry->GetLength(); + return -1; +} /** - * \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 Same as \ref Document::GetDocEntry except it only + * returns a result 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. */ -gdcmValEntry *gdcmDocEntrySet::NewValEntryByNumber(guint16 Group, guint16 Elem) +DataEntry *DocEntrySet::GetDataEntry(uint16_t group, uint16_t elem) { - // Find out if the tag we encountered is in the dictionaries: - gdcmDictEntry *DictEntry = GetDictEntryByNumber(Group, Elem); - if (!DictEntry) - DictEntry = NewVirtualDictEntry(Group, Elem); + DocEntry *currentEntry = GetDocEntry(group, elem); + if ( !currentEntry ) + return NULL; + + return dynamic_cast(currentEntry); +} - gdcmValEntry *NewEntry = new gdcmValEntry(DictEntry); - if (!NewEntry) +/** + * \brief Same as \ref Document::GetDocEntry except it only + * returns a result 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 ) { - dbg.Verbose(1, "gdcmDocument::NewValEntryByNumber", - "failed to allocate gdcmValEntry"); + gdcmWarningMacro( "No corresponding SeqEntry " << std::hex << group << + "," << elem); return NULL; } - return NewEntry; + + return dynamic_cast(currentEntry); } +/** + * \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 + */ +bool DocEntrySet::SetEntryString(std::string const &content, + uint16_t group, uint16_t elem) +{ + DataEntry *entry = GetDataEntry(group, elem); + if (!entry ) + { + gdcmWarningMacro( "No corresponding DataEntry " << std::hex << group << + "," << elem << " element (try promotion first)."); + return false; + } + return SetEntryString(content,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) + * 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 */ -gdcmBinEntry *gdcmDocEntrySet::NewBinEntryByNumber(guint16 Group, guint16 Elem) +bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, + uint16_t group, uint16_t elem) { - // Find out if the tag we encountered is in the dictionaries: - gdcmDictEntry *DictEntry = GetDictEntryByNumber(Group, Elem); - if (!DictEntry) - DictEntry = NewVirtualDictEntry(Group, Elem); + DataEntry *entry = GetDataEntry(group, elem); + if (!entry ) + { + gdcmWarningMacro( "No corresponding DataEntry " << std::hex << group << + "," << elem << " element (try promotion first)."); + return false; + } - gdcmBinEntry *NewEntry = new gdcmBinEntry(DictEntry); - if (!NewEntry) + return SetEntryBinArea(content,lgth,entry); +} + +/** + * \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 + */ +bool DocEntrySet::SetEntryString(std::string const &content, DataEntry *entry) +{ + if (entry) { - dbg.Verbose(1, "gdcmDocument::NewBinEntryByNumber", - "failed to allocate gdcmBinEntry"); - return NULL; + entry->SetString(content); + return true; } - return NewEntry; + return false; } -//----------------------------------------------------------------------------- -// Protected /** - * \brief Gets a Dicom Element inside a SQ Item Entry, by name - * @return + * \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 */ - gdcmDocEntry *gdcmDocEntrySet::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 DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry) +{ + if (entry) + { + entry->SetLength(lgth); + entry->SetBinArea(content); + return true; + } + return false; } - /** - * \brief Get the value of a Dicom Element inside a SQ Item Entry, by name - * @param name : name of the searched element. - * @return + * \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) + { + dataEntry = dynamic_cast(currentEntry); -std::string gdcmDocEntrySet::GetEntryByName(TagName name) { - gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict(); - gdcmDictEntry *dictEntry = (*PubDict).GetDictEntryByName(name); + // Verify the VR + if ( dataEntry ) + if ( dataEntry->GetVR()!=vr ) + dataEntry = NULL; - if( dictEntry == NULL) - return GDCM_UNFOUND; - return GetEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement()); + // if currentEntry doesn't correspond to the requested dataEntry + if ( !dataEntry) + { + if ( !RemoveEntry(currentEntry) ) + { + gdcmWarningMacro( "Removal of previous DocEntry failed."); + return NULL; + } + } + } + + // Create a new dataEntry if necessary + if ( !dataEntry ) + { + dataEntry = NewDataEntry( group, elem, vr ); + + if ( !AddEntry(dataEntry) ) + { + gdcmWarningMacro("AddEntry failed although this is a creation."); + + delete dataEntry; + return NULL; + } + } + + // Set the dataEntry value + SetEntryString(value, dataEntry); // The std::string value + return dataEntry; } +/** + * \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 ) +{ + DataEntry *dataEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem ); + + // Verify the currentEntry + if (currentEntry) + { + 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; + } + } + } + + // Create a new dataEntry if necessary + if ( !dataEntry) + { + dataEntry = NewDataEntry(group, elem, vr); + + if ( !AddEntry(dataEntry) ) + { + gdcmWarningMacro( "AddEntry failed although this is a creation."); + + delete dataEntry; + return NULL; + } + } + + // 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 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 Modifies the value of a given Doc Entry (Dicom Element) + * when it exists. Creates it when unexistant. + * @param group Group number of the Entry + * @param elem Element number of the Entry + * \return pointer to the modified/created SeqEntry (NULL when creation + * failed). */ -gdcmDictEntry *gdcmDocEntrySet::NewVirtualDictEntry(guint16 group, guint16 element, - std::string vr, - std::string fourth, - std::string name) +SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem) { - return gdcmGlobal::GetDicts()->NewVirtualDictEntry(group,element,vr,fourth,name); -} + SeqEntry *seqEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem ); + + // Verify the currentEntry + if ( currentEntry ) + { + seqEntry = dynamic_cast(currentEntry); -/// \brief + // Verify the VR + if ( seqEntry ) + seqEntry = NULL; -// -// Probabely move, as is, to gdcmDocEntrySet, as a non virtual method -// an remove gdcmDocument::NewDocEntryByNumber -gdcmDocEntry *gdcmDocEntrySet::NewDocEntryByNumber(guint16 group, - guint16 elem) { - - // 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); + // if currentEntry doesn't correspond to the requested seqEntry + if ( !seqEntry ) + { + if (!RemoveEntry(currentEntry)) + { + gdcmWarningMacro( "Removal of previous DocEntry failed."); - gdcmDocEntry *NewEntry = new gdcmDocEntry(DictEntry); - if (!NewEntry) + return NULL; + } + } + } + // Create a new seqEntry if necessary + if ( !seqEntry ) { - dbg.Verbose(1, "gdcmSQItem::NewDocEntryByNumber", - "failed to allocate gdcmDocEntry"); - return (gdcmDocEntry*)0; + seqEntry = NewSeqEntry(group, elem); + + if ( !AddEntry(seqEntry) ) + { + gdcmWarningMacro( "AddEntry failed although this is a creation."); + + delete seqEntry; + return NULL; + } } - return NewEntry; + + // TODO : Find a trick to insert a SequenceDelimitationItem + // in the SeqEntry, at the end. + return seqEntry; +} + +/** + * \brief Checks if a given Dicom Element exists within the H table + * @param group Group number of the searched Dicom Element + * @param elem Element number of the searched Dicom Element + * @return true is found + */ +bool DocEntrySet::CheckIfEntryExist(uint16_t group, uint16_t elem ) +{ + return GetDocEntry(group,elem)!=NULL; } -/// \brief -gdcmDocEntry *gdcmDocEntrySet::NewDocEntryByName (std::string Name) { +/** + * \brief Build a new Val Entry 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 + */ +DataEntry *DocEntrySet::NewDataEntry(uint16_t group,uint16_t elem, + VRKey const &vr) +{ + DictEntry *dictEntry = GetDictEntry(group, elem, vr); + gdcmAssertMacro(dictEntry); - gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict(); - gdcmDictEntry *NewTag = (*PubDict).GetDictEntryByName(Name); - if (!NewTag) - NewTag = NewVirtualDictEntry(0xffff, 0xffff, "LO", "unkn", Name); + DataEntry *newEntry = new DataEntry(dictEntry); + if (!newEntry) + { + gdcmWarningMacro( "Failed to allocate DataEntry"); + return 0; + } + return newEntry; +} - gdcmDocEntry* NewEntry = new gdcmDocEntry(NewTag); - if (!NewEntry) +/** + * \brief Build a new Seq Entry 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 + */ +SeqEntry* DocEntrySet::NewSeqEntry(uint16_t group, uint16_t elem) +{ + DictEntry *dictEntry = GetDictEntry(group, elem, "SQ"); + gdcmAssertMacro(dictEntry); + + SeqEntry *newEntry = new SeqEntry( dictEntry ); + if (!newEntry) { - dbg.Verbose(1, "gdcmSQItem::ObtainDocEntryByName", - "failed to allocate gdcmDocEntry"); - return (gdcmDocEntry *)0; + gdcmWarningMacro( "Failed to allocate SeqEntry"); + return 0; } - return NewEntry; + return newEntry; } +/** + * \brief Request a new virtual dict entry to the dict set + * @param group Group number of the underlying DictEntry + * @param elem Element number of the underlying DictEntry + * @param vr V(alue) R(epresentation) of the underlying DictEntry + * @param vm V(alue) M(ultiplicity) of the underlying DictEntry + * @param name english name + */ +DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group, uint16_t elem, + VRKey const &vr, + TagName const &vm, + TagName const &name ) +{ + return Global::GetDicts()->NewVirtualDictEntry(group,elem,vr,vm,name); +} +//----------------------------------------------------------------------------- +// Protected /** - * \brief Searches both the public and the shadow dictionary (when they - * exist) for the presence of the DictEntry with given name. - * The public dictionary has precedence on the shadow one. - * @param Name name 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. The public dictionary has precedence on the + * shadow one(s), if any. + * @param group Group number of the searched DictEntry + * @param elem Element number of the searched DictEntry * @return Corresponding DictEntry when it exists, NULL otherwise. */ -gdcmDictEntry *gdcmDocEntrySet::GetDictEntryByName(std::string Name) +DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem) { - gdcmDictEntry *found = (gdcmDictEntry *)0; - gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict() - if (!PubDict) + 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->GetEntry(group, elem); } - else - found = PubDict->GetDictEntryByName(Name); 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. */ -gdcmDictEntry *gdcmDocEntrySet::GetDictEntryByNumber(guint16 group,guint16 element) +DictEntry *DocEntrySet::GetDictEntry(uint16_t group, uint16_t elem, + VRKey const &vr) { - gdcmDictEntry *found = (gdcmDictEntry *)0; - gdcmDict *PubDict=gdcmGlobal::GetDicts()->GetDefaultPubDict(); - if (!PubDict) + DictEntry *dictEntry = GetDictEntry(group,elem); + DictEntry *goodEntry = dictEntry; + VRKey goodVR = vr; + + 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 ) + { + goodEntry = NULL; + } } - else - found = PubDict->GetDictEntryByNumber(group, element); - return found; -} + // Create a new virtual DictEntry if necessary + if (!goodEntry) + { + if (dictEntry) + { + goodEntry = NewVirtualDictEntry(group, elem, goodVR, "FIXME", + dictEntry->GetName() ); + } + else + { + goodEntry = NewVirtualDictEntry(group, elem, goodVR); + } + } + return goodEntry; +} //----------------------------------------------------------------------------- // Private +//----------------------------------------------------------------------------- +// Print //----------------------------------------------------------------------------- +} // end namespace gdcm