gdcmDictSet Class Reference

#include <gdcmDictSet.h>

List of all members.

Public Member Functions
	gdcmDictSet (void)
	The Dictionnary Set obtained with this constructor simply contains the Default Public dictionnary.
	~gdcmDictSet (void)
	Destructor.
void	Print (std::ostream &os)
	Print, in an informal fashion, the list of all the dictionaries contained is this gdcmDictSet, along with their respective content.
std::list< std::string > *	GetPubDictEntryNames (void)
	Consider all the entries of the public dicom dictionnary. Build all list of all the tag names of all those entries.
std::map< std::string, std::list< std::string > > *	GetPubDictEntryNamesByCategory (void)
	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.
gdcmDict *	LoadDictFromFile (std::string FileName, DictKey Name)
	Loads a dictionary from a specified file, and add it to already the existing ones contained in this gdcmDictSet.
gdcmDict *	GetDict (DictKey DictName)
	Retrieve the specified dictionary (when existing) from this gdcmDictSet.
gdcmDict *	GetDefaultPubDict (void)
	Retrieve the default reference DICOM V3 public dictionary. Returns: The retrieved default dictionary.
gdcmDictEntry *	NewVirtualDictEntry (guint16 group, guint16 element, std::string vr="Unknown", std::string fourth="Unknown", std::string name="Unknown")
	Create a gdcmDictEntry which will be reference in no dictionnary.
Static Public Member Functions
std::string	BuildDictPath (void)
	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/".
Protected Member Functions
bool	AppendDict (gdcmDict *NewDict, DictKey Name)
Private Attributes
DictSetHT	Dicts
	Hash table of all dictionaries contained in this gdcmDictSet.
std::string	DictPath
	Directory path to dictionaries.
std::map< std::string, gdcmDictEntry * >	virtualEntry

---

Constructor & Destructor Documentation

gdcmDictSet::gdcmDictSet (  void   )

The Dictionnary Set obtained with this constructor simply contains the Default Public dictionnary. Definition at line 21 of file gdcmDictSet.cxx. References BuildDictPath(), DictPath, Dicts, PUB_DICT_FILENAME, and PUB_DICT_NAME. { DictPath = BuildDictPath(); std::string PubDictFile = DictPath + PUB_DICT_FILENAME; Dicts[PUB_DICT_NAME] = new gdcmDict(PubDictFile); }

gdcmDictSet::~gdcmDictSet (  void   )

Destructor. Definition at line 32 of file gdcmDictSet.cxx. References Dicts, and virtualEntry. { // 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<std::string,gdcmDictEntry *>::iterator it; for(it=virtualEntry.begin(); it!=virtualEntry.end(); ++it) { gdcmDictEntry *Entry = it->second; if ( Entry ) delete Entry; it->second=NULL; } }

---

Member Function Documentation

bool gdcmDictSet::AppendDict (  gdcmDict *  NewDict, DictKey  Name )  [protected]

Definition at line 212 of file gdcmDictSet.cxx. References DictKey, and Dicts. Referenced by LoadDictFromFile(). { Dicts[Name] = NewDict; return(true); }

std::string gdcmDictSet::BuildDictPath (  void   )  [static]

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/". Returns: path to directory containing the dictionnaries Definition at line 192 of file gdcmDictSet.cxx. References dbg, PUB_DICT_PATH, and gdcmDebug::Verbose(). Referenced by gdcmDicomDirElement::gdcmDicomDirElement(), gdcmDictSet(), gdcmTS::gdcmTS(), and gdcmVR::gdcmVR(). { std::string ResultPath; const char *EnvPath = (char*)0; EnvPath = getenv("GDCM_DICT_PATH"); if (EnvPath && (strlen(EnvPath) != 0)) { ResultPath = EnvPath; if (ResultPath[ResultPath.length() -1] != '/' ) ResultPath += '/'; dbg.Verbose(1, "gdcmDictSet::BuildDictPath:", "Dictionary path set from environnement"); } else ResultPath = PUB_DICT_PATH; return ResultPath; }

gdcmDict * gdcmDictSet::GetDefaultPubDict (  void   )

Retrieve the default reference DICOM V3 public dictionary. Returns: The retrieved default dictionary. Definition at line 152 of file gdcmDictSet.cxx. References GetDict(), and PUB_DICT_NAME. Referenced by gdcmObject::GetEntryByName(), GetPubDictEntryNames(), GetPubDictEntryNamesByCategory(), and gdcmParser::Initialise(). { return GetDict(PUB_DICT_NAME); }

gdcmDict * gdcmDictSet::GetDict (  DictKey  DictName  )

Retrieve the specified dictionary (when existing) from this gdcmDictSet. Parameters: DictName  The symbolic name of the searched dictionary. Returns: The retrieved dictionary. Definition at line 139 of file gdcmDictSet.cxx. References DictKey, and Dicts. Referenced by GetDefaultPubDict(), and gdcmParser::SetShaDict(). { DictSetHT::iterator dict = Dicts.find(DictName); if(dict!=Dicts.end()) return dict->second; return NULL; }

std::list< std::string > * gdcmDictSet::GetPubDictEntryNames (  void   )

Consider all the entries of the public dicom dictionnary. Build all list of all the tag names of all those entries. See also: gdcmDictSet::GetPubDictTagNamesByCategory Returns: A list of all entries of the public dicom dictionnary. Definition at line 81 of file gdcmDictSet.cxx. References GetDefaultPubDict(), and gdcmDict::GetDictEntryNames(). { return(GetDefaultPubDict()->GetDictEntryNames()); }

std::map< std::string, std::list< std::string > > * gdcmDictSet::GetPubDictEntryNamesByCategory (  void   )

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 :-( * Returns: An hashtable: whose keys are the names of the groups and whose corresponding values are lists of all the dictionnary entries among that group. Definition at line 111 of file gdcmDictSet.cxx. References GetDefaultPubDict(), and gdcmDict::GetDictEntryNamesByCategory(). { return(GetDefaultPubDict()->GetDictEntryNamesByCategory()); }

gdcmDict * gdcmDictSet::LoadDictFromFile (  std::string  FileName, DictKey  Name )

Loads a dictionary from a specified file, and add it to already the existing ones contained in this gdcmDictSet. Parameters: FileName  Absolute or relative filename containing the dictionary to load. Name  Symbolic name that be used as identifier of the newly created dictionary. Definition at line 125 of file gdcmDictSet.cxx. References AppendDict(), and DictKey. { gdcmDict *NewDict = new gdcmDict(FileName); AppendDict(NewDict,Name); return(NewDict); }

gdcmDictEntry * gdcmDictSet::NewVirtualDictEntry (  guint16  group, guint16  element, std::string  vr = "Unknown", std::string  fourth = "Unknown", std::string  name = "Unknown" )

Create a gdcmDictEntry which will be reference in no dictionnary. Returns: virtual entry Definition at line 163 of file gdcmDictSet.cxx. References gdcmDictEntry::TranslateToKey(), and virtualEntry. Referenced by gdcmParser::NewVirtualDictEntry(). { gdcmDictEntry *entry; std::string tag=gdcmDictEntry::TranslateToKey(group,element)+"#"+vr+"#"+fourth+"#"+name; std::map<std::string,gdcmDictEntry *>::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); }

void gdcmDictSet::Print (  std::ostream &  os  )

Print, in an informal fashion, the list of all the dictionaries contained is this gdcmDictSet, along with their respective content. Parameters: os  Output stream used for printing. Definition at line 63 of file gdcmDictSet.cxx. References Dicts. { for (DictSetHT::iterator dict = Dicts.begin(); dict != Dicts.end(); ++dict) { os << "Printing dictionary " << dict->first << std::endl; dict->second->Print(os); } }

---

Member Data Documentation

std::string gdcmDictSet::DictPath [private]

Directory path to dictionaries. Definition at line 59 of file gdcmDictSet.h. Referenced by gdcmDictSet().

DictSetHT gdcmDictSet::Dicts [private]

Hash table of all dictionaries contained in this gdcmDictSet. Definition at line 57 of file gdcmDictSet.h. Referenced by AppendDict(), gdcmDictSet(), GetDict(), Print(), and ~gdcmDictSet().

std::map<std::string,gdcmDictEntry *> gdcmDictSet::virtualEntry [private]

Definition at line 61 of file gdcmDictSet.h. Referenced by NewVirtualDictEntry(), and ~gdcmDictSet().

---

The documentation for this class was generated from the following files:

• gdcmDictSet.h
• gdcmDictSet.cxx

---