X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.cxx;h=fbc4764e0dd81562365854a9326319b6eb4373ec;hb=713d0f3d28a6176fab6d57e031633061dc7354a7;hp=a054d86e7f990360c22b91aa1d123403f9bdb4fc;hpb=583bf29bb8a93d0cba3ba7dfea643e322c4293b5;p=gdcm.git diff --git a/src/gdcmDocEntrySet.cxx b/src/gdcmDocEntrySet.cxx index a054d86e..fbc4764e 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/09/06 15:28:49 $ - Version: $Revision: 1.59 $ + Date: $Date: 2007/09/17 12:16:02 $ + Version: $Revision: 1.76 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -23,11 +23,15 @@ #include "gdcmGlobal.h" #include "gdcmDocEntry.h" #include "gdcmSeqEntry.h" -#include "gdcmValEntry.h" -#include "gdcmBinEntry.h" #include "gdcmUtil.h" +#include "gdcmDataEntry.h" +#include "gdcmVR.h" -namespace gdcm +#if defined(__BORLANDC__) + #include // for memset +#endif + +namespace GDCM_NAME_SPACE { //----------------------------------------------------------------------------- // Constructor / Destructor @@ -44,11 +48,19 @@ DocEntrySet::DocEntrySet() * @return Corresponding element value when it exists, * and the string GDCM_UNFOUND otherwise. */ -std::string DocEntrySet::GetEntryValue(uint16_t group, uint16_t elem) +std::string DocEntrySet::GetEntryString(uint16_t group, uint16_t elem) { - ContentEntry *entry = dynamic_cast(GetDocEntry(group,elem)); + DataEntry *entry = dynamic_cast(GetDocEntry(group,elem)); if ( entry ) - return entry->GetValue(); + { + if( entry->IsNotLoaded() ) + return GDCM_NOTLOADED; + if( entry->IsUnfound() ) + return GDCM_UNFOUND; + if( entry->IsUnread() ) + return GDCM_UNREAD; + return entry->GetString(); + } return GDCM_UNFOUND; } @@ -60,47 +72,18 @@ std::string DocEntrySet::GetEntryValue(uint16_t group, uint16_t elem) */ void *DocEntrySet::GetEntryBinArea(uint16_t group, uint16_t elem) { - BinEntry *entry = GetBinEntry(group, elem); + DataEntry *entry = GetDataEntry(group, elem); if ( entry ) return entry->GetBinArea(); return 0; } /** - * \brief Return the value of the BinEntry 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; - - if (ValEntry *v = dynamic_cast(d)) - return v->GetValue(); - - if (BinEntry *b = dynamic_cast(d)) - { - uint8_t *a = b->GetBinArea(); - if (!b) - return GDCM_NOTLOADED; - // TODO : unify those two methods. - if (Util::IsCleanArea(a, b->GetLength()) ) - return Util::CreateCleanString(a, b->GetLength()); - } - return GDCM_NOTASCII; -} - -/** - * \brief Searches within Header Entries (Dicom Elements) parsed with - * the public and private dictionaries + * \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; -2 if not found + * @return Corresponding element length; -1 if not found */ int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem) { @@ -111,68 +94,24 @@ int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem) } /** - * \brief Searches within Header Entries (Dicom Elements) parsed with - * the public [and private dictionaries] - * for the element value representation of a given tag.. - * Obtaining the VR (Value Representation) might be needed by caller - * to convert the string typed content to caller's native type - * (think of C++ vs Python). The VR is actually of a higher level - * of semantics than just the native C++ type. - * @param group Group number of the searched tag. - * @param elem Element number of the searched tag. - * @return Corresponding element value representation when it exists, - * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. - */ -std::string DocEntrySet::GetEntryVR(uint16_t group, uint16_t elem) -{ - DocEntry *entry = GetDocEntry(group, elem); - if ( entry ) - return entry->GetVR(); - return GDCM_UNFOUND; -} - -/** - * \brief Same as \ref Document::GetDocEntry except it only - * returns a result when the corresponding entry is of type - * ValEntry. + * \brief Same as DocEntrySet::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 ValEntry. + * @return When present, the corresponding DataEntry. */ -ValEntry *DocEntrySet::GetValEntry(uint16_t group, uint16_t elem) +DataEntry *DocEntrySet::GetDataEntry(uint16_t group, uint16_t elem) { DocEntry *currentEntry = GetDocEntry(group, elem); if ( !currentEntry ) return NULL; - return dynamic_cast(currentEntry); + return dynamic_cast(currentEntry); } /** - * \brief Same as \ref Document::GetDocEntry except it only - * returns a result when the corresponding entry is of type - * BinEntry. - * @param group Group number of the searched Dicom Element - * @param elem Element number of the searched Dicom Element - * @return When present, the corresponding BinEntry. - */ -BinEntry *DocEntrySet::GetBinEntry(uint16_t group, uint16_t elem) -{ - DocEntry *currentEntry = GetDocEntry(group, elem); - if ( !currentEntry ) - { - gdcmWarningMacro( "No corresponding BinEntry " << std::hex << group << - "," << elem); - 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. + * \brief Same as DocEntrySet::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. @@ -181,89 +120,84 @@ SeqEntry *DocEntrySet::GetSeqEntry(uint16_t group, uint16_t elem) { DocEntry *currentEntry = GetDocEntry(group, elem); if ( !currentEntry ) - { - gdcmWarningMacro( "No corresponding SeqEntry " << std::hex << group << - "," << elem); return NULL; - } 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 + * through its (group, element) and modifies its 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::SetValEntry(std::string const &content, - uint16_t group, uint16_t elem) +bool DocEntrySet::SetEntryString(std::string const &content, + uint16_t group, uint16_t elem) { - ValEntry *entry = GetValEntry(group, elem); + DataEntry *entry = GetDataEntry(group, elem); if (!entry ) { - gdcmWarningMacro( "No corresponding ValEntry " << std::hex << group << + gdcmWarningMacro( "No corresponding DataEntry " << std::hex << group << "," << elem << " element (try promotion first)."); return false; } - return SetValEntry(content,entry); + return SetEntryString(content,entry); } /** * \brief Accesses an existing DocEntry (i.e. a Dicom Element) - * through it's (group, element) and modifies it's content with + * through its (group, element) and modifies its 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::SetBinEntry(uint8_t *content, int lgth, - uint16_t group, uint16_t elem) +bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, + uint16_t group, uint16_t elem) { - BinEntry *entry = GetBinEntry(group, elem); + DataEntry *entry = GetDataEntry(group, elem); if (!entry ) { - gdcmWarningMacro( "No corresponding ValEntry " << std::hex << group << + gdcmWarningMacro( "No corresponding DataEntry " << std::hex << group << "," << elem << " element (try promotion first)."); return false; } - return SetBinEntry(content,lgth,entry); + return SetEntryBinArea(content,lgth,entry); } /** * \brief Accesses an existing DocEntry (i.e. a Dicom Element) - * and modifies it's content with the given value. + * and modifies its content with the given value. * @param content new value (string) to substitute with * @param entry Entry to be modified */ -bool DocEntrySet::SetValEntry(std::string const &content, ValEntry *entry) +bool DocEntrySet::SetEntryString(std::string const &content, DataEntry *entry) { if (entry) { - entry->SetValue(content); + entry->SetString(content); return true; } return false; } /** - * \brief Accesses an existing BinEntry (i.e. a Dicom Element) - * and modifies it's content with the given value. + * \brief Accesses an existing DataEntry (i.e. a Dicom Element) + * and modifies its 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::SetBinEntry(uint8_t *content, int lgth, BinEntry *entry) +bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry) { if (entry) { - entry->SetBinArea(content); entry->SetLength(lgth); - entry->SetValue(GDCM_BINLOADED); + entry->SetBinArea(content); return true; } return false; @@ -271,7 +205,7 @@ bool DocEntrySet::SetBinEntry(uint8_t *content, int lgth, BinEntry *entry) /** * \brief Modifies the value of a given Doc Entry (Dicom Element) - * when it exists. Create it with the given value when unexistant. + * when it exists. Creates 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 @@ -279,51 +213,66 @@ bool DocEntrySet::SetBinEntry(uint8_t *content, int lgth, BinEntry *entry) * \return pointer to the modified/created Header Entry (NULL when creation * failed). */ -ValEntry *DocEntrySet::InsertValEntry(std::string const &value, - uint16_t group, uint16_t elem, - TagName const &vr ) +DataEntry *DocEntrySet::InsertEntryString(std::string const &value, + uint16_t group, uint16_t elem, + VRKey const &vr ) { - ValEntry *valEntry = 0; + DataEntry *dataEntry = 0; DocEntry *currentEntry = GetDocEntry( group, elem ); - + VRKey localVR = vr; if (currentEntry) { - valEntry = dynamic_cast(currentEntry); + dataEntry = dynamic_cast(currentEntry); // Verify the VR - if ( valEntry ) - if ( valEntry->GetVR()!=vr ) - valEntry = NULL; + if ( dataEntry ) + if ( dataEntry->GetVR()!=vr ) + dataEntry = NULL; - // if currentEntry doesn't correspond to the requested valEntry - if ( !valEntry) + // if currentEntry doesn't correspond to the requested dataEntry + if ( !dataEntry) { if ( !RemoveEntry(currentEntry) ) { gdcmWarningMacro( "Removal of previous DocEntry failed."); - return NULL; } } } + + else // the 'currentEntry' was not found + { + if ( vr == GDCM_VRUNKNOWN ) // user didn't specify a VR. + // Probabely he trusts the Dicom Dict ! + { + DictEntry *e = + Global::GetDicts()->GetDefaultPubDict()->GetEntry(group, elem); + if ( e ) + { + localVR = e->GetVR(); + e->Register(); // ?? JPRx + } + } + } - // Create a new valEntry if necessary - if ( !valEntry ) + // Create a new dataEntry if necessary + if ( !dataEntry ) { - valEntry = NewValEntry( group, elem, vr ); + dataEntry = NewDataEntry( group, elem, localVR ); - if ( !AddEntry(valEntry) ) + if ( !AddEntry(dataEntry) ) { - gdcmWarningMacro("AddEntry failed although this is a creation."); - - delete valEntry; + gdcmWarningMacro("AddEntry " << dataEntry->GetKey() + << " failed although this is a creation."); + dataEntry->Delete(); return NULL; } + dataEntry->Delete(); // ?!? JPRx } - // Set the binEntry value - SetValEntry(value, valEntry); // The std::string value - return valEntry; + // Set the dataEntry value + SetEntryString(value, dataEntry); // The std::string value + return dataEntry; } /** @@ -338,50 +287,49 @@ ValEntry *DocEntrySet::InsertValEntry(std::string const &value, * \return pointer to the modified/created Header Entry (NULL when creation * failed). */ -BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth, - uint16_t group, uint16_t elem, - TagName const &vr ) +DataEntry *DocEntrySet::InsertEntryBinArea(uint8_t *binArea, int lgth, + uint16_t group, uint16_t elem, + VRKey const &vr ) { - BinEntry *binEntry = 0; + DataEntry *dataEntry = 0; DocEntry *currentEntry = GetDocEntry( group, elem ); // Verify the currentEntry if (currentEntry) { - binEntry = dynamic_cast(currentEntry); + dataEntry = dynamic_cast(currentEntry); // Verify the VR - if ( binEntry ) - if ( binEntry->GetVR()!=vr ) - binEntry = NULL; + if ( dataEntry ) + if ( dataEntry->GetVR()!=vr ) + dataEntry = NULL; - // if currentEntry doesn't correspond to the requested valEntry - if ( !binEntry) + // 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 binEntry if necessary - if ( !binEntry) + // Create a new dataEntry if necessary + if ( !dataEntry) { - binEntry = NewBinEntry(group, elem, vr); + dataEntry = NewDataEntry(group, elem, vr); - if ( !AddEntry(binEntry) ) + if ( !AddEntry(dataEntry) ) { gdcmWarningMacro( "AddEntry failed although this is a creation."); - - delete binEntry; + dataEntry->Delete(); return NULL; } + dataEntry->Delete(); } - // Set the binEntry value + // Set the dataEntry value uint8_t *tmpArea; if ( lgth>0 && binArea ) { @@ -392,23 +340,22 @@ BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth, { tmpArea = 0; } - if ( !SetBinEntry(tmpArea,lgth,binEntry) ) + if ( !SetEntryBinArea(tmpArea,lgth,dataEntry) ) { if ( tmpArea ) { delete[] tmpArea; } } - - return binEntry; + return dataEntry; } /** - * \brief Modifies the value of a given Doc Entry (Dicom Element) - * when it exists. Creates it when unexistant. + * \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 modified/created SeqEntry (NULL when creation + * \return pointer to the created SeqEntry (NULL when creation * failed). */ SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem) @@ -430,8 +377,8 @@ SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem) { if (!RemoveEntry(currentEntry)) { - gdcmWarningMacro( "Removal of previous DocEntry failed."); - + gdcmWarningMacro( "Removal of previous DocEntry failed for (" + <Delete(); return NULL; } + seqEntry->Delete(); } - - // TODO : Find a trick to insert a SequenceDelimitationItem - // in the SeqEntry, at the end. + // Remark : + // SequenceDelimitationItem will be added at the end of the SeqEntry, + // at write time return seqEntry; } /** - * \brief Checks if a given Dicom Element exists within the H table + * \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 @@ -466,90 +414,50 @@ 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 - */ -ValEntry *DocEntrySet::NewValEntry(uint16_t group,uint16_t elem, - TagName const &vr) -{ - DictEntry *dictEntry = GetDictEntry(group, elem, vr); - gdcmAssertMacro(dictEntry); - - ValEntry *newEntry = new ValEntry(dictEntry); - if (!newEntry) - { - gdcmWarningMacro( "Failed to allocate ValEntry"); - return 0; - } - return newEntry; -} - /** - * \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 new Entry + * \brief Build a new DataEntry from all the low level arguments. + * @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 */ -BinEntry *DocEntrySet::NewBinEntry(uint16_t group, uint16_t elem, - TagName const &vr) +DataEntry *DocEntrySet::NewDataEntry(uint16_t group, uint16_t elem, + VRKey const &vr) { - DictEntry *dictEntry = GetDictEntry(group, elem, vr); - gdcmAssertMacro(dictEntry); - BinEntry *newEntry = new BinEntry(dictEntry); + DataEntry *newEntry = DataEntry::New(group, elem, vr); if (!newEntry) { - gdcmWarningMacro( "Failed to allocate BinEntry"); + gdcmWarningMacro( "Failed to allocate DataEntry for (" + <Unregister(); // GetDictEntry register it if (!newEntry) { - gdcmWarningMacro( "Failed to allocate SeqEntry"); + gdcmWarningMacro( "Failed to allocate SeqEntry for (" + <NewVirtualDictEntry(group,elem,vr,vm,name); -} - //----------------------------------------------------------------------------- // Protected /** @@ -560,10 +468,13 @@ DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group, uint16_t elem, * @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::GetDictEntry(uint16_t group,uint16_t elem) { DictEntry *found = 0; + /// \todo store the DefaultPubDict somwhere, in order not to access the HTable + /// every time ! --> Done! Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); if (!pubDict) { @@ -571,54 +482,13 @@ DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem) } else { - found = pubDict->GetEntry(group, elem); + 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, 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. - */ -DictEntry *DocEntrySet::GetDictEntry(uint16_t group, uint16_t elem, - TagName const &vr) -{ - DictEntry *dictEntry = GetDictEntry(group,elem); - DictEntry *goodEntry = dictEntry; - std::string goodVR = vr; - - if (elem == 0x0000) goodVR="UL"; - - if ( goodEntry ) - { - if ( goodVR != goodEntry->GetVR() - && goodVR != GDCM_UNKNOWN ) - { - goodEntry = NULL; - } - } - - // 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