X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.cxx;h=9f4d7c421f19d071010da68f8b989db31eecd100;hb=3e82e8b67eddf5d4b95b6aa2a2e2615aced4c452;hp=0d69d0253fd8a7932748e05ffb005a3e3cc56ad4;hpb=a2040ffd26fc9a3c835b6c45b92a808f1d001b36;p=gdcm.git diff --git a/src/gdcmDocEntrySet.cxx b/src/gdcmDocEntrySet.cxx index 0d69d025..9f4d7c42 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/02/02 10:02:17 $ + Version: $Revision: 1.51 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -21,7 +21,6 @@ #include "gdcmCommon.h" #include "gdcmDictSet.h" #include "gdcmGlobal.h" -#include "gdcmException.h" #include "gdcmDocEntry.h" #include "gdcmSeqEntry.h" #include "gdcmValEntry.h" @@ -29,281 +28,567 @@ namespace gdcm { +//----------------------------------------------------------------------------- +// Constructor / Destructor //----------------------------------------------------------------------------- // 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 ("gdcm::Unfound") otherwise. + */ +std::string DocEntrySet::GetEntryValue(uint16_t group, uint16_t elem) +{ + ContentEntry *entry = dynamic_cast(GetDocEntry(group,elem)); + if( entry ) + return entry->GetValue(); + 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) +{ + BinEntry *entry = GetBinEntry(group, elem); + if( entry ) + return entry->GetBinArea(); + return 0; +} + +/** + * \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 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. */ -ValEntry *DocEntrySet::NewValEntryByNumber(uint16_t group, - uint16_t elem) +std::string DocEntrySet::GetEntryVR(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 *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. + * @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. + */ +BinEntry *DocEntrySet::GetBinEntry(uint16_t group, uint16_t elem) +{ + DocEntry *currentEntry = GetDocEntry(group, elem); + if ( !currentEntry ) { - dictEntry = NewVirtualDictEntry(group, elem); + gdcmVerboseMacro( "No corresponding BinEntry " << std::hex << group << + "," << elem); + return NULL; } - ValEntry *newEntry = new ValEntry(dictEntry); - if (!newEntry) + 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 ) { - dbg.Verbose(1, "Document::NewValEntryByNumber", - "failed to allocate ValEntry"); - return 0; + gdcmVerboseMacro( "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::SetValEntry(std::string const &content, + uint16_t group, uint16_t elem) +{ + ValEntry *entry = GetValEntry(group, elem); + if (!entry ) + { + gdcmVerboseMacro( "No corresponding ValEntry " << std::hex << group << + "," << elem << " element (try promotion first)."); + return false; + } + return SetValEntry(content,entry); +} /** - * \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 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 */ -BinEntry *DocEntrySet::NewBinEntryByNumber(uint16_t group, - uint16_t elem) +bool DocEntrySet::SetBinEntry(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) + BinEntry *entry = GetBinEntry(group, elem); + if (!entry ) { - dictEntry = NewVirtualDictEntry(group, elem); + gdcmVerboseMacro( "No corresponding ValEntry " << std::hex << group << + "," << elem << " element (try promotion first)."); + return false; } - BinEntry *newEntry = new BinEntry(dictEntry); - if (!newEntry) + return SetBinEntry(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::SetValEntry(std::string const &content, ValEntry *entry) +{ + if(entry) { - dbg.Verbose(1, "Document::NewBinEntryByNumber", - "failed to allocate BinEntry"); - return 0; + entry->SetValue(content); + return true; } - return newEntry; + return false; } /** - * \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 BinEntry (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 */ -SeqEntry* DocEntrySet::NewSeqEntryByNumber(uint16_t Group, - uint16_t Elem) +bool DocEntrySet::SetBinEntry(uint8_t *content, int lgth, BinEntry *entry) { - // Find out if the tag we encountered is in the dictionaries: - DictEntry* DictEntry = GetDictEntryByNumber( Group, Elem ); - if ( ! DictEntry ) + if(entry) { - DictEntry = NewVirtualDictEntry(Group, Elem); + entry->SetBinArea(content); + entry->SetLength(lgth); + entry->SetValue(GDCM_BINLOADED); + return true; } + return false; +} - SeqEntry *NewEntry = new SeqEntry( DictEntry ); - if ( !NewEntry ) +/** + * \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). + */ +ValEntry *DocEntrySet::InsertValEntry(std::string const &value, + uint16_t group, uint16_t elem, + TagName const &vr ) +{ + ValEntry *valEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem); + + if (currentEntry) { - dbg.Verbose(1, "Document::NewSeqEntryByNumber", - "failed to allocate SeqEntry"); - return 0; + valEntry = dynamic_cast(currentEntry); + + // Verify the VR + if( valEntry ) + if( valEntry->GetVR()!=vr ) + valEntry = NULL; + + // if currentEntry doesn't correspond to the requested valEntry + if( !valEntry) + { + if( !RemoveEntry(currentEntry) ) + { + gdcmVerboseMacro( "Removal of previous DocEntry failed."); + + return NULL; + } + } } - return NewEntry; -} -//----------------------------------------------------------------------------- -// Protected + // Create a new valEntry if necessary + if( !valEntry ) + { + valEntry = NewValEntry(group, elem, vr); -/** - * \brief Gets a Dicom Element inside a SQ Item Entry, by name - * @param name of the element to be found. - * @return + if ( !AddEntry(valEntry) ) + { + gdcmVerboseMacro("AddEntry failed although this is a creation."); + + delete valEntry; + return NULL; + } + } + + // Set the binEntry value + SetValEntry(value, valEntry); // The std::string value + return valEntry; +} + +/* + * \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 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). */ -DocEntry* DocEntrySet::GetDocEntryByName( TagName const & name ) +BinEntry *DocEntrySet::InsertBinEntry(uint8_t *binArea, int lgth, + uint16_t group, uint16_t elem, + TagName const &vr ) { - Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); - DictEntry *dictEntry = pubDict->GetDictEntryByName(name); - if( !dictEntry ) + BinEntry *binEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem); + + // Verify the currentEntry + if (currentEntry) { - return 0; + binEntry = dynamic_cast(currentEntry); + + // Verify the VR + if( binEntry ) + if( binEntry->GetVR()!=vr ) + binEntry = NULL; + + // if currentEntry doesn't correspond to the requested valEntry + if( !binEntry) + { + if( !RemoveEntry(currentEntry) ) + { + gdcmVerboseMacro( "Removal of previous DocEntry failed."); + + return NULL; + } + } } - return GetDocEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement()); -} + // Create a new binEntry if necessary + if( !binEntry) + { + binEntry = NewBinEntry(group, elem, vr); + if ( !AddEntry(binEntry) ) + { + gdcmVerboseMacro( "AddEntry failed allthough this is a creation."); -/** - * \brief Get the value of a Dicom Element inside a SQ Item Entry, by name - * @param name : name of the searched element. - * @return - */ + delete binEntry; + return NULL; + } + } + + // Set the binEntry value + uint8_t *tmpArea; + if( lgth>0 && binArea ) + { + tmpArea = new uint8_t[lgth]; + memcpy(tmpArea,binArea,lgth); + } + else + { + tmpArea = 0; + } + if( !SetBinEntry(tmpArea,lgth,binEntry) ) + { + if( tmpArea ) + { + delete[] tmpArea; + } + } + + return binEntry; +} -std::string DocEntrySet::GetEntryByName(TagName const & name) +/* + * \brief Modifies the value of a given Header 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). + */ +SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem) { - Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); - DictEntry *dictEntry = pubDict->GetDictEntryByName(name); + SeqEntry *seqEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem); - if( !dictEntry ) + // Verify the currentEntry + if( currentEntry ) { - return GDCM_UNFOUND; + seqEntry = dynamic_cast(currentEntry); + + // Verify the VR + if( seqEntry ) + if( seqEntry->GetVR()!="SQ" ) + seqEntry = NULL; + + // if currentEntry doesn't correspond to the requested valEntry + if( !seqEntry ) + { + if (!RemoveEntry(currentEntry)) + { + gdcmVerboseMacro( "Removal of previous DocEntry failed."); + + return NULL; + } + } } + // Create a new seqEntry if necessary + if( !seqEntry ) + { + seqEntry = NewSeqEntry(group, elem); - return GetEntryByNumber(dictEntry->GetGroup(), dictEntry->GetElement()); -} + if( !AddEntry(seqEntry) ) + { + gdcmVerboseMacro( "AddEntry failed allthough this is a creation."); + delete seqEntry; + return NULL; + } + } + 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 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 group group number of the underlying DictEntry + * @param elem element number of the underlying DictEntry + * @param vr VR (Value Representation) of the underlying DictEntry + * @param vm VM (Value Multiplicity) of the underlying DictEntry * @param name english name */ -DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group, - uint16_t element, +DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group,uint16_t elem, TagName const & vr, - TagName const & fourth, + TagName const & vm, TagName const & name ) { - return Global::GetDicts()->NewVirtualDictEntry(group,element,vr,fourth,name); + return Global::GetDicts()->NewVirtualDictEntry(group,elem,vr,vm,name); } -/** \brief - * Creates a new DocEntry (without any 'value' ...) - * @param group group number of the underlying DictEntry - * @param elem elem number of the underlying DictEntry +/** + * \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 VR of the new Entry */ -DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group, - uint16_t elem) +ValEntry *DocEntrySet::NewValEntry(uint16_t group,uint16_t elem, + TagName const & vr) { - // Find out if the tag we encountered is in the dictionaries: - Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); - DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, elem); - if (!dictEntry) - { - dictEntry = NewVirtualDictEntry(group, elem); - } + DictEntry *dictEntry = GetDictEntry(group, elem, vr); + gdcmAssertMacro(dictEntry); - DocEntry *newEntry = new DocEntry(dictEntry); + ValEntry *newEntry = new ValEntry(dictEntry); if (!newEntry) { - dbg.Verbose(1, "SQItem::NewDocEntryByNumber", - "failed to allocate DocEntry"); + gdcmVerboseMacro( "Failed to allocate ValEntry"); return 0; } return newEntry; } -/** \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 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 VR of the new Entry */ -DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group, uint16_t elem, - TagName const & vr) +BinEntry *DocEntrySet::NewBinEntry(uint16_t group, uint16_t elem, + TagName const &vr) { - // Find out if the tag we encountered is in the dictionaries: - Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); - DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, elem); - if (!dictEntry) - { - dictEntry = NewVirtualDictEntry(group, elem, vr); - } + DictEntry *dictEntry = GetDictEntry(group, elem, vr); + gdcmAssertMacro(dictEntry); - DocEntry *newEntry = new DocEntry(dictEntry); + BinEntry *newEntry = new BinEntry(dictEntry); if (!newEntry) { - dbg.Verbose(1, "SQItem::NewDocEntryByNumber", - "failed to allocate DocEntry"); + gdcmVerboseMacro( "Failed to allocate BinEntry"); 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 */ -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"); + gdcmAssertMacro(dictEntry); - DocEntry* newEntry = new DocEntry(newTag); - if (!newEntry) + SeqEntry *newEntry = new SeqEntry( dictEntry ); + if (!newEntry) { - dbg.Verbose(1, "SQItem::ObtainDocEntryByName", - "failed to allocate DocEntry"); + gdcmVerboseMacro( "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. + * @param group group number of the searched DictEntry + * @param elem element number of the searched DictEntry * @return Corresponding DictEntry when it exists, NULL otherwise. */ -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"); + gdcmVerboseMacro( "We SHOULD have a default dictionary"); } else { - found = pubDict->GetDictEntryByName(name); + found = pubDict->GetEntry(group, elem); } 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 Value Representation to use, if necessary * @return Corresponding DictEntry when it exists, NULL otherwise. */ -DictEntry *DocEntrySet::GetDictEntryByNumber(uint16_t group, - uint16_t element) +DictEntry *DocEntrySet::GetDictEntry(uint16_t group, uint16_t elem, + TagName const &vr) { - DictEntry *found = 0; - Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); - if (!pubDict) + DictEntry *dictEntry = GetDictEntry(group,elem); + DictEntry *goodEntry = dictEntry; + std::string 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_UNKNOWN ) + { + goodEntry = NULL; + } } - else + + // Create a new virtual DictEntry if necessary + if (!goodEntry) { - found = pubDict->GetDictEntryByNumber(group, element); + if (dictEntry) + { + goodEntry = NewVirtualDictEntry(group, elem, goodVR, "FIXME", + dictEntry->GetName() ); + } + else + { + goodEntry = NewVirtualDictEntry(group, elem, goodVR); + } } - return found; + return goodEntry; } - //----------------------------------------------------------------------------- // Private -} // end namespace gdcm +//----------------------------------------------------------------------------- +// Print //----------------------------------------------------------------------------- +} // end namespace gdcm