X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.cxx;h=5f31e20205cf00f95bce10d6e11d52bda420bb17;hb=14da8fbfce99d66af65ee2a6294f90e70a054652;hp=666b72a100c506ae9fc422eb4a208d88980e14be;hpb=b0f62020f3423bf7663fdf856000dc245e417d9a;p=gdcm.git diff --git a/src/gdcmDocEntrySet.cxx b/src/gdcmDocEntrySet.cxx index 666b72a1..5f31e202 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/08/24 12:09:13 $ - Version: $Revision: 1.58 $ + Date: $Date: 2005/11/21 09:41:46 $ + Version: $Revision: 1.68 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -23,8 +23,9 @@ #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 { @@ -41,13 +42,21 @@ DocEntrySet::DocEntrySet() * @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 ("gdcm::Unfound") otherwise. + * 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; } @@ -59,19 +68,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 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) { @@ -82,68 +90,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 \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 ValEntry. - */ -ValEntry *DocEntrySet::GetValEntry(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 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. + * @return When present, the corresponding DataEntry. */ -BinEntry *DocEntrySet::GetBinEntry(uint16_t group, uint16_t elem) +DataEntry *DocEntrySet::GetDataEntry(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); + 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 \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. @@ -152,12 +116,8 @@ 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); } @@ -169,17 +129,17 @@ SeqEntry *DocEntrySet::GetSeqEntry(uint16_t group, uint16_t elem) * @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); } /** @@ -191,18 +151,18 @@ bool DocEntrySet::SetValEntry(std::string const &content, * @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); } /** @@ -211,30 +171,29 @@ bool DocEntrySet::SetBinEntry(uint8_t *content, int lgth, * @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) + * \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::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; @@ -250,51 +209,50 @@ 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 ); 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; } } } - // 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, vr ); - if ( !AddEntry(valEntry) ) + if ( !AddEntry(dataEntry) ) { gdcmWarningMacro("AddEntry failed although this is a creation."); - - delete valEntry; + dataEntry->Delete(); return NULL; } + dataEntry->Delete(); } - // 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; } /** @@ -309,50 +267,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 ) { @@ -363,23 +320,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) @@ -401,8 +357,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 @@ -438,89 +395,53 @@ bool DocEntrySet::CheckIfEntryExist(uint16_t group, uint16_t elem ) } /** - * \brief Build a new Val Entry from all the low level arguments. + * \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 */ -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 - * @param elem Element number of the new Entry - * @param vr V(alue) R(epresentation) of the new Entry - */ -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(dictEntry); + dictEntry->Unregister(); // GetDictEntry register it 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 /** @@ -531,6 +452,7 @@ 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) { @@ -542,7 +464,9 @@ 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; } @@ -555,38 +479,55 @@ DictEntry *DocEntrySet::GetDictEntry(uint16_t group,uint16_t elem) * @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::GetDictEntry(uint16_t group, uint16_t elem, - TagName const &vr) + VRKey const &vr) { DictEntry *dictEntry = GetDictEntry(group,elem); DictEntry *goodEntry = dictEntry; - std::string goodVR = vr; - - if (elem == 0x0000) goodVR="UL"; + VRKey goodVR = vr; + TagName vm; + if (elem == 0x0000) + goodVR="UL"; if ( goodEntry ) { if ( goodVR != goodEntry->GetVR() - && goodVR != GDCM_UNKNOWN ) - { + && 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 + { + vm = "FIXME"; } - // Create a new virtual DictEntry if necessary if (!goodEntry) { if (dictEntry) { - goodEntry = NewVirtualDictEntry(group, elem, goodVR, "FIXME", - dictEntry->GetName() ); + + goodEntry = DictEntry::New(group, elem, goodVR, vm,//"FIXME", + dictEntry->GetName() ); } else { - goodEntry = NewVirtualDictEntry(group, elem, goodVR); + goodEntry = DictEntry::New(group, elem, goodVR); } } + else + { + goodEntry->Register(); + } return goodEntry; }