Program: gdcm
Module: $RCSfile: gdcmDocEntrySet.cxx,v $
Language: C++
- Date: $Date: 2005/10/18 08:35:49 $
- Version: $Revision: 1.60 $
+ Date: $Date: 2006/03/22 13:19:25 $
+ Version: $Revision: 1.71 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#include "gdcmDataEntry.h"
#include "gdcmVR.h"
+#if defined(__BORLANDC__)
+ #include <mem.h> // for memset
+#endif
+
namespace gdcm
{
//-----------------------------------------------------------------------------
}
/**
- * \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.
- */
-std::string DocEntrySet::GetEntryForcedAsciiValue(uint16_t group, uint16_t elem)
-{
- DocEntry *d = GetDocEntry(group,elem);
- if ( !d )
- return GDCM_UNFOUND;
-
- DataEntry *de = dynamic_cast<DataEntry *>(d);
- if ( de )
- {
- if( de->IsNotLoaded() )
- return GDCM_NOTLOADED;
- if( de->IsUnfound() )
- return GDCM_UNFOUND;
- if( de->IsUnread() )
- return GDCM_UNREAD;
- }
-
- if( Global::GetVR()->IsVROfStringRepresentable( de->GetVR() ) )
- return de->GetString();
- else
- {
- uint8_t *a = de->GetBinArea();
- if( Util::IsCleanArea(a, de->GetLength()) )
- return Util::CreateCleanString(a, de->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)
{
}
/**
- * \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
- * DataEntry.
+ * \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 DataEntry.
}
/**
- * \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.
{
DocEntry *currentEntry = GetDocEntry(group, elem);
if ( !currentEntry )
- {
- gdcmWarningMacro( "No corresponding SeqEntry " << std::hex << group <<
- "," << elem);
return NULL;
- }
return dynamic_cast<SeqEntry*>(currentEntry);
}
* failed).
*/
DataEntry *DocEntrySet::InsertEntryString(std::string const &value,
- uint16_t group, uint16_t elem,
- TagName const &vr )
+ uint16_t group, uint16_t elem,
+ VRKey const &vr )
{
DataEntry *dataEntry = 0;
DocEntry *currentEntry = GetDocEntry( group, elem );
if ( !AddEntry(dataEntry) )
{
gdcmWarningMacro("AddEntry failed although this is a creation.");
-
- delete dataEntry;
+ dataEntry->Delete();
return NULL;
}
+ dataEntry->Delete();
}
// Set the dataEntry value
* failed).
*/
DataEntry *DocEntrySet::InsertEntryBinArea(uint8_t *binArea, int lgth,
- uint16_t group, uint16_t elem,
- TagName const &vr )
+ uint16_t group, uint16_t elem,
+ VRKey const &vr )
{
DataEntry *dataEntry = 0;
DocEntry *currentEntry = GetDocEntry( group, elem );
if ( !AddEntry(dataEntry) )
{
gdcmWarningMacro( "AddEntry failed although this is a creation.");
-
- delete dataEntry;
+ dataEntry->Delete();
return NULL;
}
+ dataEntry->Delete();
}
// Set the dataEntry value
delete[] tmpArea;
}
}
-
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)
{
if (!RemoveEntry(currentEntry))
{
- gdcmWarningMacro( "Removal of previous DocEntry failed.");
-
+ gdcmWarningMacro( "Removal of previous DocEntry failed for ("
+ <<std::hex << group << "|" << elem <<")" );
return NULL;
}
}
if ( !AddEntry(seqEntry) )
{
- gdcmWarningMacro( "AddEntry failed although this is a creation.");
-
- delete seqEntry;
+ gdcmWarningMacro( "AddEntry failed although this is a creation for ("
+ <<std::hex << group << "|" << elem <<")" );
+ seqEntry->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
}
/**
- * \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
*/
DataEntry *DocEntrySet::NewDataEntry(uint16_t group,uint16_t elem,
- TagName const &vr)
+ VRKey const &vr)
{
DictEntry *dictEntry = GetDictEntry(group, elem, vr);
- gdcmAssertMacro(dictEntry);
- DataEntry *newEntry = new DataEntry(dictEntry);
+ DataEntry *newEntry = DataEntry::New(dictEntry);
+ dictEntry->Unregister(); // GetDictEntry register it
if (!newEntry)
{
- gdcmWarningMacro( "Failed to allocate DataEntry");
+ gdcmWarningMacro( "Failed to allocate DataEntry for ("
+ <<std::hex << group << "|" << elem <<")" );
return 0;
}
return newEntry;
}
/**
- * \brief Build a new Seq Entry from all the low level arguments.
+ * \brief Build a new SeqEntry 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
*/
SeqEntry* DocEntrySet::NewSeqEntry(uint16_t group, uint16_t elem)
{
DictEntry *dictEntry = GetDictEntry(group, elem, "SQ");
- gdcmAssertMacro(dictEntry);
- SeqEntry *newEntry = new SeqEntry( dictEntry );
+ SeqEntry *newEntry = SeqEntry::New( dictEntry );
+ dictEntry->Unregister(); // GetDictEntry register it
if (!newEntry)
{
- gdcmWarningMacro( "Failed to allocate SeqEntry");
+ gdcmWarningMacro( "Failed to allocate SeqEntry for ("
+ <<std::hex << group << "|" << elem <<")" );
return 0;
- }
+ }
return newEntry;
}
-/**
- * \brief Request a new virtual dict entry to the dict set
- * @param group Group number of the underlying DictEntry
- * @param elem Element number of the underlying DictEntry
- * @param vr V(alue) R(epresentation) of the underlying DictEntry
- * @param vm V(alue) M(ultiplicity) of the underlying DictEntry
- * @param name english name
- */
-DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group, uint16_t elem,
- TagName const &vr,
- TagName const &vm,
- TagName const &name )
-{
- return Global::GetDicts()->NewVirtualDictEntry(group,elem,vr,vm,name);
-}
-
//-----------------------------------------------------------------------------
// Protected
/**
* @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 !
Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
if (!pubDict)
{
}
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
+ * group and element, and creates 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::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,
+ dictEntry->GetName() );
}
else
{
- goodEntry = NewVirtualDictEntry(group, elem, goodVR);
+ goodEntry = DictEntry::New(group, elem, goodVR);
}
}
+ else
+ {
+ goodEntry->Register();
+ }
return goodEntry;
}