X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.cxx;h=cc91b75fd8ce796120041c6886c125405292e2d8;hb=4f189b7cd8d7aff962887245b7b30ede39b7856c;hp=0d69d0253fd8a7932748e05ffb005a3e3cc56ad4;hpb=a2040ffd26fc9a3c835b6c45b92a808f1d001b36;p=gdcm.git diff --git a/src/gdcmDocEntrySet.cxx b/src/gdcmDocEntrySet.cxx index 0d69d025..cc91b75f 100644 --- a/src/gdcmDocEntrySet.cxx +++ b/src/gdcmDocEntrySet.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocEntrySet.cxx,v $ Language: C++ - Date: $Date: 2005/01/05 15:38:28 $ - Version: $Revision: 1.28 $ + Date: $Date: 2005/10/24 16:00:47 $ + Version: $Revision: 1.65 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -21,289 +21,551 @@ #include "gdcmCommon.h" #include "gdcmDictSet.h" #include "gdcmGlobal.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 +/** + * \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. + */ +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 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 underlying DictEntry - * @param elem element number of the underlying DictEntry + * \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 + */ +void *DocEntrySet::GetEntryBinArea(uint16_t group, uint16_t elem) +{ + DataEntry *entry = GetDataEntry(group, elem); + if ( entry ) + return entry->GetBinArea(); + return 0; +} + +/** + * \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. */ -ValEntry *DocEntrySet::NewValEntryByNumber(uint16_t group, - uint16_t elem) +std::string DocEntrySet::GetEntryForcedAsciiValue(uint16_t group, uint16_t elem) { - // Find out if the tag we encountered is in the dictionaries: - DictEntry *dictEntry = GetDictEntryByNumber(group, elem); - if (!dictEntry) + DocEntry *d = GetDocEntry(group,elem); + if ( !d ) + return GDCM_UNFOUND; + + DataEntry *de = dynamic_cast(d); + if ( de ) { - dictEntry = NewVirtualDictEntry(group, elem); + if( de->IsNotLoaded() ) + return GDCM_NOTLOADED; + if( de->IsUnfound() ) + return GDCM_UNFOUND; + if( de->IsUnread() ) + return GDCM_UNREAD; } - ValEntry *newEntry = new ValEntry(dictEntry); - if (!newEntry) + if( Global::GetVR()->IsVROfStringRepresentable( de->GetVR() ) ) + return de->GetString(); + else { - dbg.Verbose(1, "Document::NewValEntryByNumber", - "failed to allocate ValEntry"); - return 0; + uint8_t *a = de->GetBinArea(); + if( Util::IsCleanArea(a, de->GetLength()) ) + return Util::CreateCleanString(a, de->GetLength()); } - return newEntry; + 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 Bin 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 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. */ -BinEntry *DocEntrySet::NewBinEntryByNumber(uint16_t group, - uint16_t elem) +DataEntry *DocEntrySet::GetDataEntry(uint16_t group, uint16_t elem) { - // Find out if the tag we encountered is in the dictionaries: - DictEntry *dictEntry = GetDictEntryByNumber(group, elem); - if (!dictEntry) + DocEntry *currentEntry = GetDocEntry(group, elem); + if ( !currentEntry ) + return NULL; + + return dynamic_cast(currentEntry); +} + +/** + * \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 ) { - dictEntry = NewVirtualDictEntry(group, elem); + gdcmWarningMacro( "No corresponding SeqEntry " << std::hex << group << + "," << elem); + return NULL; } - BinEntry *newEntry = new BinEntry(dictEntry); - if (!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 ) { - dbg.Verbose(1, "Document::NewBinEntryByNumber", - "failed to allocate BinEntry"); - return 0; + gdcmWarningMacro( "No corresponding DataEntry " << std::hex << group << + "," << elem << " element (try promotion first)."); + return false; } - return newEntry; + return SetEntryString(content,entry); } /** - * \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 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 */ -SeqEntry* DocEntrySet::NewSeqEntryByNumber(uint16_t Group, - uint16_t 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: - DictEntry* 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; } - SeqEntry *NewEntry = new SeqEntry( 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, "Document::NewSeqEntryByNumber", - "failed to allocate SeqEntry"); - return 0; + entry->SetString(content); + return true; } - return NewEntry; + return false; } -//----------------------------------------------------------------------------- -// Protected - /** - * \brief Gets a Dicom Element inside a SQ Item Entry, by name - * @param name of the element to be found. - * @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 */ -DocEntry* DocEntrySet::GetDocEntryByName( TagName const & name ) +bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry) { - Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); - DictEntry *dictEntry = pubDict->GetDictEntryByName(name); - if( !dictEntry ) + if (entry) { - return 0; + entry->SetLength(lgth); + entry->SetBinArea(content); + return true; } - - return GetDocEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement()); + 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). */ - -std::string DocEntrySet::GetEntryByName(TagName const & name) +DataEntry *DocEntrySet::InsertEntryString(std::string const &value, + uint16_t group, uint16_t elem, + VRKey const &vr ) { - Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); - DictEntry *dictEntry = pubDict->GetDictEntryByName(name); + DataEntry *dataEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem ); + + 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; + } + } + } - if( !dictEntry ) + // Create a new dataEntry if necessary + if ( !dataEntry ) { - return GDCM_UNFOUND; + dataEntry = NewDataEntry( group, elem, vr ); + + if ( !AddEntry(dataEntry) ) + { + gdcmWarningMacro("AddEntry failed although this is a creation."); + + dataEntry->Delete(); + return NULL; + } } - return GetEntryByNumber(dictEntry->GetGroup(), dictEntry->GetElement()); + // Set the dataEntry value + SetEntryString(value, dataEntry); // The std::string value + 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 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). */ -DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group, - uint16_t element, - TagName const & vr, - TagName const & fourth, - TagName const & name ) +DataEntry *DocEntrySet::InsertEntryBinArea(uint8_t *binArea, int lgth, + uint16_t group, uint16_t elem, + VRKey const &vr ) { - return Global::GetDicts()->NewVirtualDictEntry(group,element,vr,fourth,name); -} + DataEntry *dataEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem ); -/** \brief - * Creates a new DocEntry (without any 'value' ...) - * @param group group number of the underlying DictEntry - * @param elem elem number of the underlying DictEntry - */ -DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group, - uint16_t elem) -{ - // Find out if the tag we encountered is in the dictionaries: - Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); - DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, elem); - if (!dictEntry) + // Verify the currentEntry + if (currentEntry) { - dictEntry = NewVirtualDictEntry(group, elem); + 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; + } + } } - DocEntry *newEntry = new DocEntry(dictEntry); - if (!newEntry) + // Create a new dataEntry if necessary + if ( !dataEntry) { - dbg.Verbose(1, "SQItem::NewDocEntryByNumber", - "failed to allocate DocEntry"); - return 0; + dataEntry = NewDataEntry(group, elem, vr); + + if ( !AddEntry(dataEntry) ) + { + gdcmWarningMacro( "AddEntry failed although this is a creation."); + + dataEntry->Delete(); + return NULL; + } } - return newEntry; -} + // 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 DocEntry (without any 'value' ...) - * @param group group number of the underlying DictEntry - * @param elem elem number of the underlying DictEntry - * @param vr V(alue) R(epresentation) of the Entry -if private Entry- +/** + * \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). */ -DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group, uint16_t elem, - TagName const & vr) +SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem) { - // Find out if the tag we encountered is in the dictionaries: - Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); - DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, elem); - if (!dictEntry) + 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."); + + return NULL; + } + } + } + // Create a new seqEntry if necessary + if ( !seqEntry ) { - dictEntry = NewVirtualDictEntry(group, elem, vr); + seqEntry = NewSeqEntry(group, elem); + + if ( !AddEntry(seqEntry) ) + { + gdcmWarningMacro( "AddEntry failed although this is a creation."); + + seqEntry->Delete(); + return NULL; + } } - DocEntry *newEntry = new DocEntry(dictEntry); + // 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 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 + * \remarks The user of this method must destroy the DataEntry when unused + */ +DataEntry *DocEntrySet::NewDataEntry(uint16_t group,uint16_t elem, + VRKey const &vr) +{ + DictEntry *dictEntry = GetDictEntry(group, elem, vr); + + DataEntry *newEntry = DataEntry::New(dictEntry); + dictEntry->Unregister(); // GetDictEntry register it if (!newEntry) { - dbg.Verbose(1, "SQItem::NewDocEntryByNumber", - "failed to allocate DocEntry"); + gdcmWarningMacro( "Failed to allocate DataEntry"); return 0; } return newEntry; } -/* \brief - * Probabely move, as is, to DocEntrySet, as a non virtual method - * and remove Document::NewDocEntryByName + +/** + * \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 + * \remarks The user of this method must destroy the SeqEntry when unused */ -DocEntry *DocEntrySet::NewDocEntryByName(TagName const & name) +SeqEntry* DocEntrySet::NewSeqEntry(uint16_t group, uint16_t elem) { - Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); - DictEntry *newTag = pubDict->GetDictEntryByName(name); - if (!newTag) - { - newTag = NewVirtualDictEntry(0xffff, 0xffff, "LO", GDCM_UNKNOWN, name); - } + DictEntry *dictEntry = GetDictEntry(group, elem, "SQ"); - DocEntry* newEntry = new DocEntry(newTag); - if (!newEntry) + SeqEntry *newEntry = SeqEntry::New( dictEntry ); + dictEntry->Unregister(); // GetDictEntry register it + if (!newEntry) { - dbg.Verbose(1, "SQItem::ObtainDocEntryByName", - "failed to allocate DocEntry"); + gdcmWarningMacro( "Failed to allocate SeqEntry"); return 0; } - return newEntry; } - +//----------------------------------------------------------------------------- +// 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. + * \remarks The returned DictEntry is registered when existing */ -DictEntry *DocEntrySet::GetDictEntryByName(TagName const & name) +DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem) { DictEntry *found = 0; Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); if (!pubDict) { - dbg.Verbose(0, "Document::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 */ -DictEntry *DocEntrySet::GetDictEntryByNumber(uint16_t group, - uint16_t element) +DictEntry *DocEntrySet::GetDictEntry(uint16_t group, uint16_t elem, + VRKey const &vr) { - DictEntry *found = 0; - Dict *pubDict = Global::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, "Document::GetDictEntry", - "we SHOULD have a default dictionary"); + if ( goodVR != goodEntry->GetVR() + && goodVR != GDCM_VRUNKNOWN ) + { + goodEntry = NULL; + } + dictEntry->Unregister(); + } + + // Create a new virtual DictEntry if necessary + if (!goodEntry) + { + if (dictEntry) + { + goodEntry = DictEntry::New(group, elem, goodVR, "FIXME", + dictEntry->GetName() ); + } + else + { + goodEntry = DictEntry::New(group, elem, goodVR); + } } else { - found = pubDict->GetDictEntryByNumber(group, element); + goodEntry->Register(); } - return found; + return goodEntry; } - //----------------------------------------------------------------------------- // Private -} // end namespace gdcm +//----------------------------------------------------------------------------- +// Print //----------------------------------------------------------------------------- +} // end namespace gdcm