X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.cxx;h=fbc4764e0dd81562365854a9326319b6eb4373ec;hb=6278320cc85da00d2d56ffbf07806e84966892c3;hp=3230148941e0935c73a6b0516bc3589f4c9146d2;hpb=28e546efc3dc694c93a006529aecad5c4821b432;p=gdcm.git diff --git a/src/gdcmDocEntrySet.cxx b/src/gdcmDocEntrySet.cxx index 32301489..fbc4764e 100644 --- a/src/gdcmDocEntrySet.cxx +++ b/src/gdcmDocEntrySet.cxx @@ -1,183 +1,499 @@ -// gdcmDocEntrySet.cxx -//----------------------------------------------------------------------------- -// -#include +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDocEntrySet.cxx,v $ + Language: C++ + 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 + 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 "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" +#if defined(__BORLANDC__) + #include // for memset +#endif + +namespace GDCM_NAME_SPACE +{ //----------------------------------------------------------------------------- // 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() { +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 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; -1 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 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 DataEntry. + */ +DataEntry *DocEntrySet::GetDataEntry(uint16_t group, uint16_t elem) +{ + DocEntry *currentEntry = GetDocEntry(group, elem); + if ( !currentEntry ) + return NULL; -//----------------------------------------------------------------------------- -// Public -//bool gdcmDocEntrySet::AddEntry(gdcmDocEntry *Entry){return true;} + return dynamic_cast(currentEntry); +} -//----------------------------------------------------------------------------- -// Protected +/** + * \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. + */ +SeqEntry *DocEntrySet::GetSeqEntry(uint16_t group, uint16_t elem) +{ + DocEntry *currentEntry = GetDocEntry(group, elem); + if ( !currentEntry ) + return NULL; + + return dynamic_cast(currentEntry); +} + +/** + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * 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::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 Accesses an existing DocEntry (i.e. a Dicom Element) + * 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::SetEntryBinArea(uint8_t *content, int lgth, + 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 SetEntryBinArea(content,lgth,entry); +} -//----------------------------------------------------------------------------- -// Private +/** + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * and modifies its 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) + { + entry->SetString(content); + return true; + } + return false; +} /** - * \brief Parses an EntrySet (Document header or SQ Item ) - * \ and load element values (a voir !) - * @return false anything wrong happens + * \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 */ - - /* just to keep the code - -bool gdcmDocEntrySet::LoadDocEntrySet(bool exception_on_error) - throw(gdcmFormatError) { - (void)exception_on_error; - - gdcmDocEntry *newDocEntry = (gdcmDocEntry *)0; - gdcmValEntry *newValEntry = (gdcmValEntry *)0; - gdcmBinEntry *newBinEntry = (gdcmBinEntry *)0; - gdcmSeqEntry *newSeqEntry = (gdcmSeqEntry *)0; - - string vr; - while (newDocEntry = ReadNextDocEntry()) { - // TODO (?) : liberation du DocEntry ainsi cree, - // apres copie dans un ValEntry, SeqEntry, BinEntry - vr = newDocEntry->GetVR(); - - if (vr == "SQ" ) { - // --- SeqEntry - - newSeqEntry = new gdcmSeqEntry((gdcmDictEntry*)NULL); - if (!newSeqEntry) { - dbg.Verbose(1, "gdcmDocEntrySet::LoadDocEntrySet", - "failed to allocate gdcmSeqEntry"); - return false; - } - newSeqEntry->Copy(newDocEntry); - // TODO - // SEQUENCE; appel 'récursif' de ??? pour charger la 'valeur' - // (ensemble d' ITEMs, en fait, - // chaque ITEM etant chargé avec LoadDocEntrySet) - - //SkipDocEntry(newSeqEntry); // voir ce qu'on fait pour une SeQuence - AddEntry(newSeqEntry); // on appele la fonction generique, - // ou une fonction spécialisée ? - - } else if (vr == "AE" || vr == "AS" || vr == "DA" || vr == "PN" || - vr == "UI" || vr == "TM" || vr == "SH" || vr == "LO" || - vr == "CS" || vr == "IS" || vr == "LO" || vr == "LT" || - vr == "SH" || vr == "ST" || - vr == "SL" || vr == "SS" || vr == "UL" || vr == "US" - ) { - // --- ValEntry - - newValEntry = new gdcmValEntry((gdcmDictEntry*)NULL); - if (!newValEntry) { - dbg.Verbose(1, "gdcmDocEntrySet::LoadDocEntrySet", - "failed to allocate gdcmValEntry"); - return false; - } - newValEntry->Copy(newDocEntry); - //SkipDocEntry(newValEntry); //le skip devrait etre fait dans le Read - AddEntry(newValEntry); // on appele la fonction generique, - // ou une fonction spécialisée ? - - // Maybe the following VR do correspond to a BinEntry - - //AT Attribute Tag; // OK // 2 16-bit unsigned short integers - //FL Floating Point Single; // 32-bit IEEE 754:1985 float - //FD Floating Point Double; // 64-bit IEEE 754:1985 double - //UN Unknown; // Any length of bytes - //UT Unlimited Text; // At most 2^32 -1 chars - //OB Other Byte String; // String of bytes (VR independant) - //OW Other Word String; // String of 16-bit words (VR dependant) - } else { - // --- BinEntry - - newBinEntry = new gdcmBinEntry((gdcmDictEntry*)NULL); - if (!newBinEntry) { - dbg.Verbose(1, "gdcmDocEntrySet::LoadDocEntrySet", - "failed to allocate gdcmBinEntry"); - return false; - } - newBinEntry->Copy(newDocEntry); - // SkipDocEntry(newBinEntry); //le skip devrait etre fait dans le Read - AddEntry(newBinEntry); // on appele la fonction generique, - // ou une fonction spécialisée ? - } - } - - - - // TODO : il n'y a plus de Chained List qui contient toutes les Entries - // Le chargement des valeurs devra se faire à la volée - // Be carefull : merging this two loops may cause troubles ... - -/* - rewind(fp); - for (ListTag::iterator i = GetListEntry().begin(); - i != GetListEntry().end(); - ++i) - { - LoadDocEntry(*i); - } - rewind(fp); - - */ - - /* TO DO : deporter den fin de parsing du DOCUMENT (pas du EntrySet) +bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry) +{ + if (entry) + { + entry->SetLength(lgth); + entry->SetBinArea(content); + return true; + } + return false; +} + +/** + * \brief Modifies the value of a given Doc Entry (Dicom Element) + * 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 + * @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 ); + VRKey localVR = vr; + 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; + } + } + } - // -------------------------------------------------------------- - // Special Patch to allow gdcm to read ACR-LibIDO formated images - // - // if recognition code tells us we deal with a LibIDO image - // we switch lineNumber and columnNumber - // - std::string RecCode; - RecCode = GetEntryByNumber(0x0008, 0x0010); // recognition code - if (RecCode == "ACRNEMA_LIBIDO_1.1" || - RecCode == "CANRME_AILIBOD1_1." ) // for brain-damaged softwares - // with "little-endian strings" - { - filetype = ACR_LIBIDO; - std::string rows = GetEntryByNumber(0x0028, 0x0010); - std::string columns = GetEntryByNumber(0x0028, 0x0011); - SetEntryByNumber(columns, 0x0028, 0x0010); - SetEntryByNumber(rows , 0x0028, 0x0011); - } - // ----------------- End of Special Patch ---------------- - */ - - /* - return true; + 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 dataEntry if necessary + if ( !dataEntry ) + { + dataEntry = NewDataEntry( group, elem, localVR ); + + if ( !AddEntry(dataEntry) ) + { + gdcmWarningMacro("AddEntry " << dataEntry->GetKey() + << " failed although this is a creation."); + dataEntry->Delete(); + return NULL; + } + dataEntry->Delete(); // ?!? JPRx + } + + // 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."); + dataEntry->Delete(); + return NULL; + } + dataEntry->Delete(); + } + + // 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 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 created SeqEntry (NULL when creation + * failed). + */ +SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem) +{ + 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 for (" + <Delete(); + return NULL; + } + seqEntry->Delete(); + } + // 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 DocEntrySet + * @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 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 + */ +DataEntry *DocEntrySet::NewDataEntry(uint16_t group, uint16_t elem, + VRKey const &vr) +{ + + DataEntry *newEntry = DataEntry::New(group, elem, vr); + if (!newEntry) + { + gdcmWarningMacro( "Failed to allocate DataEntry for (" + <Unregister(); // GetDictEntry register it + if (!newEntry) + { + gdcmWarningMacro( "Failed to allocate SeqEntry for (" + < Done! + Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); + if (!pubDict) + { + gdcmWarningMacro( "We SHOULD have a default dictionary"); + } + else + { + found = pubDict->GetEntry(group, elem); + if( found ) + found->Register(); + } + return found; +} + +//----------------------------------------------------------------------------- +// Private + +//----------------------------------------------------------------------------- +// Print //----------------------------------------------------------------------------- +} // end namespace gdcm