Program: gdcm
Module: $RCSfile: gdcmDocEntrySet.cxx,v $
Language: C++
- Date: $Date: 2005/02/02 16:18:48 $
- Version: $Revision: 1.52 $
+ Date: $Date: 2005/10/21 10:48:16 $
+ Version: $Revision: 1.64 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#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
{
//-----------------------------------------------------------------------------
// Constructor / Destructor
-
+DocEntrySet::DocEntrySet()
+{
+ PreviousDocEntry = 0;
+}
//-----------------------------------------------------------------------------
// Public
/**
* @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<ContentEntry *>(GetDocEntry(group,elem));
- if( entry )
- return entry->GetValue();
+ DataEntry *entry = dynamic_cast<DataEntry *>(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;
}
*/
void *DocEntrySet::GetEntryBinArea(uint16_t group, uint16_t elem)
{
- BinEntry *entry = GetBinEntry(group, elem);
- if( entry )
+ 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
- * for the value length of a given tag..
+ * \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 length; -2 if not found
+ * @return Corresponding element value when it's "std::string representable"
+ * and the string GDCM_NOTASCII otherwise.
*/
-int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem)
+std::string DocEntrySet::GetEntryForcedAsciiValue(uint16_t group, uint16_t elem)
{
- DocEntry *entry = GetDocEntry(group, elem);
- if( entry )
- return entry->GetLength();
- return -1;
+ 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]
- * 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.
+ * 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 value representation when it exists,
- * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
+ * @return Corresponding element length; -2 if not found
*/
-std::string DocEntrySet::GetEntryVR(uint16_t group, uint16_t elem)
+int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem)
{
DocEntry *entry = GetDocEntry(group, elem);
- if( entry )
- return entry->GetVR();
- return GDCM_UNFOUND;
+ if ( entry )
+ return entry->GetLength();
+ return -1;
}
/**
* \brief Same as \ref Document::GetDocEntry except it only
* returns a result when the corresponding entry is of type
- * ValEntry.
+ * 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<ValEntry*>(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 )
- {
- gdcmVerboseMacro( "No corresponding BinEntry " << std::hex << group <<
- "," << elem);
- return NULL;
- }
-
- return dynamic_cast<BinEntry*>(currentEntry);
+ return dynamic_cast<DataEntry*>(currentEntry);
}
/**
DocEntry *currentEntry = GetDocEntry(group, elem);
if ( !currentEntry )
{
- gdcmVerboseMacro( "No corresponding SeqEntry " << std::hex << group <<
+ gdcmWarningMacro( "No corresponding SeqEntry " << std::hex << group <<
"," << elem);
return NULL;
}
* @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 )
{
- gdcmVerboseMacro( "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);
}
/**
* @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 )
{
- gdcmVerboseMacro( "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);
}
/**
* @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)
+ 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)
+ if (entry)
{
- entry->SetBinArea(content);
entry->SetLength(lgth);
- entry->SetValue(GDCM_BINLOADED);
+ entry->SetBinArea(content);
return true;
}
return false;
* \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;
- DocEntry *currentEntry = GetDocEntry( group, elem);
+ DataEntry *dataEntry = 0;
+ DocEntry *currentEntry = GetDocEntry( group, elem );
if (currentEntry)
{
- valEntry = dynamic_cast<ValEntry *>(currentEntry);
+ dataEntry = dynamic_cast<DataEntry *>(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) )
+ if ( !RemoveEntry(currentEntry) )
{
- gdcmVerboseMacro( "Removal of previous DocEntry failed.");
-
+ 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) )
{
- gdcmVerboseMacro("AddEntry failed although this is a creation.");
+ gdcmWarningMacro("AddEntry failed although this is a creation.");
- delete valEntry;
+ delete dataEntry;
return NULL;
}
}
- // 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;
}
-/*
+/**
* \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).
*/
-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;
- DocEntry *currentEntry = GetDocEntry( group, elem);
+ DataEntry *dataEntry = 0;
+ DocEntry *currentEntry = GetDocEntry( group, elem );
// Verify the currentEntry
if (currentEntry)
{
- binEntry = dynamic_cast<BinEntry *>(currentEntry);
+ dataEntry = dynamic_cast<DataEntry *>(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) )
+ if ( !RemoveEntry(currentEntry) )
{
- gdcmVerboseMacro( "Removal of previous DocEntry failed.");
-
+ 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) )
{
- gdcmVerboseMacro( "AddEntry failed allthough this is a creation.");
+ gdcmWarningMacro( "AddEntry failed although this is a creation.");
- delete binEntry;
+ delete dataEntry;
return NULL;
}
}
- // Set the binEntry value
+ // Set the dataEntry value
uint8_t *tmpArea;
- if( lgth>0 && binArea )
+ if ( lgth>0 && binArea )
{
tmpArea = new uint8_t[lgth];
memcpy(tmpArea,binArea,lgth);
{
tmpArea = 0;
}
- if( !SetBinEntry(tmpArea,lgth,binEntry) )
+ if ( !SetEntryBinArea(tmpArea,lgth,dataEntry) )
{
- if( tmpArea )
+ if ( tmpArea )
{
delete[] tmpArea;
}
}
- return binEntry;
+ return dataEntry;
}
-/*
- * \brief Modifies the value of a given Header Entry (Dicom Element)
+/**
+ * \brief Modifies the value of a given Doc Entry (Dicom Element)
* when it exists. Creates it when unexistant.
* @param group Group number of the Entry
* @param elem Element number of the Entry
SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem)
{
SeqEntry *seqEntry = 0;
- DocEntry *currentEntry = GetDocEntry( group, elem);
+ DocEntry *currentEntry = GetDocEntry( group, elem );
// Verify the currentEntry
- if( currentEntry )
+ if ( currentEntry )
{
seqEntry = dynamic_cast<SeqEntry *>(currentEntry);
// Verify the VR
- if( seqEntry )
- if( seqEntry->GetVR()!="SQ" )
- seqEntry = NULL;
+ if ( seqEntry )
+ seqEntry = NULL;
- // if currentEntry doesn't correspond to the requested valEntry
- if( !seqEntry )
+ // if currentEntry doesn't correspond to the requested seqEntry
+ if ( !seqEntry )
{
if (!RemoveEntry(currentEntry))
{
- gdcmVerboseMacro( "Removal of previous DocEntry failed.");
+ gdcmWarningMacro( "Removal of previous DocEntry failed.");
return NULL;
}
}
}
// Create a new seqEntry if necessary
- if( !seqEntry )
+ if ( !seqEntry )
{
seqEntry = NewSeqEntry(group, elem);
- if( !AddEntry(seqEntry) )
+ if ( !AddEntry(seqEntry) )
{
- gdcmVerboseMacro( "AddEntry failed allthough this is a creation.");
+ gdcmWarningMacro( "AddEntry failed although this is a creation.");
delete seqEntry;
return NULL;
}
}
+
+ // TODO : Find a trick to insert a SequenceDelimitationItem
+ // in the SeqEntry, at the end.
return seqEntry;
}
* \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
- */
-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)
- {
- gdcmVerboseMacro( "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 VR of the new Entry
+ * @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 = new DataEntry(dictEntry);
+ dictEntry->Unregister(); // GetDictEntry register it
if (!newEntry)
{
- gdcmVerboseMacro( "Failed to allocate BinEntry");
+ gdcmWarningMacro( "Failed to allocate DataEntry");
return 0;
}
return newEntry;
* \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
+ * @param group Group number of the new Entry
+ * @param elem Element number of the new Entry
*/
SeqEntry* DocEntrySet::NewSeqEntry(uint16_t group, uint16_t elem)
{
DictEntry *dictEntry = GetDictEntry(group, elem, "SQ");
- gdcmAssertMacro(dictEntry);
SeqEntry *newEntry = new SeqEntry( dictEntry );
+ dictEntry->Unregister(); // GetDictEntry register it
if (!newEntry)
{
- gdcmVerboseMacro( "Failed to allocate SeqEntry");
+ gdcmWarningMacro( "Failed to allocate SeqEntry");
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 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 elem,
- TagName const & vr,
- TagName const & vm,
- TagName const & name )
-{
- return Global::GetDicts()->NewVirtualDictEntry(group,elem,vr,vm,name);
-}
-
//-----------------------------------------------------------------------------
// Protected
/**
* \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
+ * shadow one(s), if any.
+ * @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)
{
Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
if (!pubDict)
{
- gdcmVerboseMacro( "We SHOULD have a default dictionary");
+ gdcmWarningMacro( "We SHOULD have a default dictionary");
}
else
{
- found = pubDict->GetEntry(group, elem);
+ found = pubDict->GetEntry(group, elem);
+ if( found )
+ found->Register();
}
return found;
}
* 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
+ * @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;
+ VRKey goodVR = vr;
- if (elem == 0x0000) goodVR="UL";
+ if (elem == 0x0000)
+ goodVR="UL";
if ( goodEntry )
{
if ( goodVR != goodEntry->GetVR()
- && goodVR != GDCM_UNKNOWN )
+ && goodVR != GDCM_VRUNKNOWN )
{
goodEntry = NULL;
}
+ dictEntry->Unregister();
}
// Create a new virtual DictEntry if necessary
{
if (dictEntry)
{
- goodEntry = NewVirtualDictEntry(group, elem, goodVR, "FIXME",
- dictEntry->GetName() );
+ goodEntry = DictEntry::New(group, elem, goodVR, "FIXME",
+ dictEntry->GetName() );
}
else
{
- goodEntry = NewVirtualDictEntry(group, elem, goodVR);
+ goodEntry = DictEntry::New(group, elem, goodVR);
}
}
+ else
+ {
+ goodEntry->Register();
+ }
return goodEntry;
}
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff