DCMTree::Dict Class Reference

#include <DCMTree_Dict.h>

Public Member Functions
virtual	~Dict ()
	Destructor.
virtual void	postInitialize () const
	Performs some initialization after the implementing DLL has been loaded.
virtual std::string	transferSyntaxUID (TransferSyntax transfersyntax) const =0
	Converts the enum to its UID.
virtual Vr	vr (const TagId &tagid) const
	Returns the DICOM VR of the given tag.
virtual TagValueMultiplicity	multiplicity (const TagId &tagid) const
	Returns the multiplicity (min/max) of values of the given tag.
virtual std::string	name (const TagId &tagid) const =0
	Returns the name of the given tag.
virtual TagId	tagId (const std::string &name) const
	Returns the tag ID for the given name.
virtual TagInfo	info (const TagId &tagid) const =0
	Method to be implemented by child classes to provide information about a given tag.
virtual TagInfo	info (const std::string &name) const =0
	Method to be implemented by child classes to provide information about a tag with the given name.
virtual bool	hasInfoForTagId (const TagId &tagId) const =0
	Method to check whether a TagInfo exists for the given tag ID.
virtual bool	hasInfoForTagName (const std::string &tagName) const =0
	Method to check whether a TagInfo exists for the given tag name.
virtual std::vector< std::string >	allNormalTagNames () const
	Returns a list of all known normal (i.e., non-repeating) tag names, e.g., for completion in tools.
bool	isTagIdKnown (const TagId &tagIdParam) const
	Convenience methods that call hasInfoForTagId() or hasInfoForTagName().
bool	isTagNameKnown (const std::string &tagName) const

Static Public Member Functions
static Const_DictPtr	singleton (DCMTree_Utils::LoadLibraryDelegate *delegate=nullptr)
	Returns the singleton.

Static Protected Member Functions
static void	setSingleton (Const_DictPtr singleton)
	The concrete singleton is set by the implementing DLL.

Detailed Description

Definition at line 43 of file DCMTree_Dict.h.

Constructor & Destructor Documentation

~Dict()

virtual DCMTree::Dict::~Dict ( )

virtual

Destructor.

Is made public for boost's sake

Member Function Documentation

allNormalTagNames()

virtual std::vector< std::string > DCMTree::Dict::allNormalTagNames ( ) const

inlinevirtual

Returns a list of all known normal (i.e., non-repeating) tag names, e.g., for completion in tools.

Definition at line 127 of file DCMTree_Dict.h.

hasInfoForTagId()

virtual bool DCMTree::Dict::hasInfoForTagId ( const TagId & tagId ) const

pure virtual

Method to check whether a TagInfo exists for the given tag ID.

hasInfoForTagName()

virtual bool DCMTree::Dict::hasInfoForTagName ( const std::string & tagName ) const

pure virtual

Method to check whether a TagInfo exists for the given tag name.

info() [1/2]

virtual TagInfo DCMTree::Dict::info ( const std::string & name ) const

pure virtual

Method to be implemented by child classes to provide information about a tag with the given name.

May throw if an unknown tag name was given.

info() [2/2]

virtual TagInfo DCMTree::Dict::info ( const TagId & tagid ) const

pure virtual

Method to be implemented by child classes to provide information about a given tag.

May throw if an unknown tag was given.

isTagIdKnown()

bool DCMTree::Dict::isTagIdKnown ( const TagId & tagIdParam ) const

inline

Convenience methods that call hasInfoForTagId() or hasInfoForTagName().

Definition at line 121 of file DCMTree_Dict.h.

References mlrange_cast().

isTagNameKnown()

bool DCMTree::Dict::isTagNameKnown ( const std::string & tagName ) const

inline

Definition at line 122 of file DCMTree_Dict.h.

multiplicity()

virtual TagValueMultiplicity DCMTree::Dict::multiplicity ( const TagId & tagid ) const

virtual

Returns the multiplicity (min/max) of values of the given tag.

Uses information from child classes.

name()

virtual std::string DCMTree::Dict::name ( const TagId & tagid ) const

pure virtual

Returns the name of the given tag.

Uses information from child classes.

postInitialize()

virtual void DCMTree::Dict::postInitialize ( ) const

virtual

Performs some initialization after the implementing DLL has been loaded.

Used by DCMTree_OFFIS for the registering of codecs.

setSingleton()

static void DCMTree::Dict::setSingleton ( Const_DictPtr singleton )

staticprotected

The concrete singleton is set by the implementing DLL.

singleton()

static Const_DictPtr DCMTree::Dict::singleton ( DCMTree_Utils::LoadLibraryDelegate * delegate = nullptr )

static

Returns the singleton.

tagId()

virtual TagId DCMTree::Dict::tagId ( const std::string & name ) const

virtual

Returns the tag ID for the given name.

Uses information from child classes.

transferSyntaxUID()

virtual std::string DCMTree::Dict::transferSyntaxUID ( TransferSyntax transfersyntax ) const

pure virtual

Converts the enum to its UID.

Needs to be implemented by child classes.

vr()

virtual Vr DCMTree::Dict::vr ( const TagId & tagid ) const

virtual

Returns the DICOM VR of the given tag.

Uses information from child classes.

---

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

• MeVis/Foundation/Sources/DicomTree/MLDicomTree/DCMTree_Dict.h