X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictSet.cxx;h=c26768c0861ad86e8f7cd9edd2a3499f8fb9a490;hb=4c8c80589b3770976ea27fc03b290b97db5da3e6;hp=56482cb300f1d2e505c96d93873bbc5dc6c9f05a;hpb=d84a0a9e04fe65dc2ff732d75731fa403d0e02b8;p=gdcm.git diff --git a/src/gdcmDictSet.cxx b/src/gdcmDictSet.cxx index 56482cb3..c26768c0 100644 --- a/src/gdcmDictSet.cxx +++ b/src/gdcmDictSet.cxx @@ -1,114 +1,235 @@ -// gdcmDictEntry +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDictSet.cxx,v $ + Language: C++ + Date: $Date: 2004/07/02 13:55:27 $ + Version: $Revision: 1.32 $ + + 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.htm 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 "gdcmDictSet.h" +#include "gdcmDebug.h" #include #include // For getenv -#include "gdcm.h" -#include "gdcmUtil.h" -#define PUB_DICT_NAME "DicomV3Dict" -#ifndef PUB_DICT_PATH -# define PUB_DICT_PATH "../Dicts/" -#endif -#define PUB_DICT_FILENAME "dicomV3.dic" +//----------------------------------------------------------------------------- +// Constructor / Destructor +/** + * \ingroup gdcmDictSet + * \brief The Dictionnary Set obtained with this constructor simply + * contains the Default Public dictionnary. + */ +gdcmDictSet::gdcmDictSet(void) +{ + DictPath = BuildDictPath(); + std::string PubDictFile(DictPath); + PubDictFile += PUB_DICT_FILENAME; /// MEMORY LEAK std::string::operator+= + Dicts[PUB_DICT_NAME] = new gdcmDict(PubDictFile); +} -string gdcmDictSet::DictPath = gdcmDictSet::BuildDictPath(); -gdcmDict* gdcmDictSet::DefaultPubDict = gdcmDictSet::LoadDefaultPubDict(); +/** + * \ingroup gdcmDictSet + * \brief Destructor + */ +gdcmDictSet::~gdcmDictSet() +{ + // Remove dictionnaries + for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) + { + gdcmDict *EntryToDelete = tag->second; + if ( EntryToDelete ) + delete EntryToDelete; + tag->second=NULL; + } + Dicts.clear(); + // Remove virtual dictionnary entries + std::map::iterator it; + for(it=virtualEntry.begin(); it!=virtualEntry.end(); ++it) + { + gdcmDictEntry *Entry = it->second; + if ( Entry ) + delete Entry; + it->second=NULL; + } +} + +//----------------------------------------------------------------------------- +// Print +/** + * \ingroup gdcmDictSet + * \brief Print, in an informal fashion, the list of all the dictionaries + * contained is this gdcmDictSet, along with their respective content. + * @param os Output stream used for printing. + */ +void gdcmDictSet::Print(std::ostream& os) +{ + for (DictSetHT::iterator dict = Dicts.begin(); dict != Dicts.end(); ++dict) + { + os << "Printing dictionary " << dict->first << std::endl; + dict->second->Print(os); + } +} + +//----------------------------------------------------------------------------- +// Public /** * \ingroup gdcmDictSet * \brief Consider all the entries of the public dicom dictionnary. * Build all list of all the tag names of all those entries. - * \sa gdcmDictSet::GetPubDictTagNamesByCategory + * \sa gdcmDictSet::GetPubDictTagNamesByCategory * @return A list of all entries of the public dicom dictionnary. */ -list * gdcmDictSet::GetPubDictTagNames(void) { - list * Result = new list; - TagKeyHT entries = gdcmDictSet::DefaultPubDict->GetEntries(); - - for (TagKeyHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){ - Result->push_back( tag->second->GetName() ); - } - return Result; +std::list *gdcmDictSet::GetPubDictEntryNames(void) +{ + return(GetDefaultPubDict()->GetDictEntryNames()); } /** * \ingroup gdcmDictSet - * \brief Consider all the entries of the public dicom dictionnary. - * Build an hashtable whose keys are the names of the groups - * (fourth field in each line of dictionary) and whose corresponding - * values are lists of all the dictionnary entries among that - * group. Note that apparently the Dicom standard doesn't explicitely - * define a name (as a string) for each group. - * A typical usage of this method would be to enable a dynamic - * configuration of a Dicom file browser: the admin/user can - * select in the interface which Dicom tags should be displayed. + * \brief + * - Consider all the entries of the public dicom dictionnary. + * - Build an hashtable whose keys are the names of the groups + * (fourth field in each line of dictionary) and whose corresponding + * values are lists of all the dictionnary entries among that + * group. Note that apparently the Dicom standard doesn't explicitely + * define a name (as a string) for each group. + * - A typical usage of this method would be to enable a dynamic + * configuration of a Dicom file browser: the admin/user can + * select in the interface which Dicom tags should be displayed. + * \warning + * - Dicom *doesn't* define any name for any 'categorie' + * (the dictionnary fourth field was formerly NIH defined + * -and no longer he is- + * and will be removed when Dicom provides us a text file + * with the 'official' Dictionnary, that would be more friendly + * than asking us to perform a line by line check of the dictionnary + * at the beginning of each year to -try to- guess the changes) + * - Therefore : please NEVER use that fourth field :-( + * * * @return An hashtable: whose keys are the names of the groups and whose * corresponding values are lists of all the dictionnary entries * among that group. */ -map > * gdcmDictSet::GetPubDictTagNamesByCategory(void) { - map > * Result = new map >; - TagKeyHT entries = gdcmDictSet::DefaultPubDict->GetEntries(); +std::map > *gdcmDictSet::GetPubDictEntryNamesByCategory(void) +{ + return(GetDefaultPubDict()->GetDictEntryNamesByCategory()); +} - for (TagKeyHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){ - (*Result)[tag->second->GetFourth()].push_back(tag->second->GetName()); - } - return Result; +/** + * \ingroup gdcmDictSet + * \brief Loads a dictionary from a specified file, and add it + * to already the existing ones contained in this gdcmDictSet. + * @param FileName Absolute or relative filename containing the + * dictionary to load. + * @param Name Symbolic name that be used as identifier of the newly + * created dictionary. + */ +gdcmDict *gdcmDictSet::LoadDictFromFile(std::string FileName, DictKey Name) +{ + gdcmDict *NewDict = new gdcmDict(FileName); + AppendDict(NewDict,Name); + return(NewDict); } /** * \ingroup gdcmDictSet + * \brief Retrieve the specified dictionary (when existing) from this + * gdcmDictSet. + * @param DictName The symbolic name of the searched dictionary. + * \result The retrieved dictionary. + */ +gdcmDict *gdcmDictSet::GetDict(DictKey DictName) +{ + DictSetHT::iterator dict = Dicts.find(DictName); + if(dict!=Dicts.end()) + return dict->second; + return NULL; +} + +/** + * \brief Retrieve the default reference DICOM V3 public dictionary. + * \result The retrieved default dictionary. + */ +gdcmDict *gdcmDictSet::GetDefaultPubDict() +{ + return GetDict(PUB_DICT_NAME); +} + +/** + * \brief Create a gdcmDictEntry which will be reference + * in no dictionnary + * @return virtual entry + */ +gdcmDictEntry *gdcmDictSet::NewVirtualDictEntry(uint16_t group, + uint16_t element, + std::string vr, + std::string fourth, + std::string name) +{ + gdcmDictEntry* entry; + std::string tag = gdcmDictEntry::TranslateToKey(group,element) + + "#" + vr + "#" + fourth + "#" + name; + std::map::iterator it; + + it=virtualEntry.find(tag); + if(it!=virtualEntry.end()) + { + entry=it->second; + } + else + { + entry=new gdcmDictEntry(group,element,vr,fourth,name); + virtualEntry[tag]=entry; + } + return(entry); +} + +/** * \brief Obtain from the GDCM_DICT_PATH environnement variable the * path to directory containing the dictionnaries. When * the environnement variable is absent the path is defaulted * to "../Dicts/". + * @return path to directory containing the dictionnaries */ -string gdcmDictSet::BuildDictPath(void) { - string ResultPath; - const char* EnvPath = (char*)0; +std::string gdcmDictSet::BuildDictPath(void) +{ + std::string ResultPath; + const char *EnvPath = (char*)0; EnvPath = getenv("GDCM_DICT_PATH"); - if (EnvPath && (strlen(EnvPath) != 0)) { + if (EnvPath && (strlen(EnvPath) != 0)) + { ResultPath = EnvPath; if (ResultPath[ResultPath.length() -1] != '/' ) ResultPath += '/'; dbg.Verbose(1, "gdcmDictSet::BuildDictPath:", "Dictionary path set from environnement"); - } else + } + else ResultPath = PUB_DICT_PATH; return ResultPath; } -gdcmDict* gdcmDictSet::LoadDefaultPubDict(void) { - string PubDictFile = gdcmDictSet::DictPath + PUB_DICT_FILENAME; - return new gdcmDict(PubDictFile.c_str()); +//----------------------------------------------------------------------------- +// Protected +bool gdcmDictSet::AppendDict(gdcmDict *NewDict,DictKey Name) +{ + Dicts[Name] = NewDict; + return(true); } -/** - * \ingroup gdcmDictSet - * \brief The Dictionnary Set obtained with this constructor simply - * contains the Default Public dictionnary. - */ -gdcmDictSet::gdcmDictSet(void) { - dicts[PUB_DICT_NAME] = DefaultPubDict; -} - -void gdcmDictSet::LoadDictFromFile(string FileName, DictKey Name) { - gdcmDict *NewDict = new gdcmDict(FileName.c_str()); - dicts[Name] = NewDict; -} +//----------------------------------------------------------------------------- +// Private -void gdcmDictSet::Print(ostream& os) { - for (DictSetHT::iterator dict = dicts.begin(); dict != dicts.end(); ++dict){ - os << "Printing dictionary " << dict->first << " \n"; - dict->second->Print(os); - } -} +//----------------------------------------------------------------------------- -gdcmDict * gdcmDictSet::GetDict(DictKey DictName) { - DictSetHT::iterator dict = dicts.find(DictName); - return dict->second; -} -gdcmDict * gdcmDictSet::GetDefaultPubDict() { - return GetDict(PUB_DICT_NAME); -}