DCMTree::Dict Class Reference

#include <DCMTree_Dict.h>

Public Member Functions
virtual	~Dict ()
	dtor, public for boost's sake
virtual void	postInitialize () const
	Do some init after the implementing DLL was loaded.
virtual std::string	transferSyntaxUID (TransferSyntax transfersyntax) const =0
	convert the enum to its uid needs to be implemented by child classes
virtual Vr	vr (const TagId &tagid) const
	get the DICOM VR of the given tag uses info from child classes
virtual TagValueMultiplicity	multiplicity (const TagId &tagid) const
	get the multiplicity (min/max) of values of the given tag uses info from child classes
virtual std::string	name (const TagId &tagid) const =0
	get the name of the given tag uses info from child classes
virtual TagId	tagId (const std::string &name) const
	get the tag id for the given name uses info from child classes
virtual TagInfo	info (const TagId &tagid) const =0
	method to be implemented by child-classes to provide information about a given tag may throw if an unknown tag was given
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 may throw if an unknown tag name was given
virtual bool	hasInfoForTagId (const TagId &tagId) const =0
	method to check if a TagInfo exists for the given tag id
virtual bool	hasInfoForTagName (const std::string &tagName) const =0
	method to check if a TagInfo exists for the given tag name
virtual std::vector< std::string >	allNormalTagNames () const
	Returns a list of all known normal (non-repeating) tag names, e.g.
bool	isTagIdKnown (const TagId &tagIdParam) const
	convenience methods which 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 55 of file DCMTree_Dict.h.

Constructor & Destructor Documentation

~Dict()

virtual DCMTree::Dict::~Dict ( )

virtual

dtor, 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 (non-repeating) tag names, e.g.

for completion in tools.

Definition at line 139 of file DCMTree_Dict.h.

hasInfoForTagId()

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

pure virtual

method to check if a TagInfo exists for the given tag id

hasInfoForTagName()

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

pure virtual

method to check if 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 which call hasInfoForTagId() or hasInfoForTagName()

Definition at line 133 of file DCMTree_Dict.h.

References mlrange_cast().

isTagNameKnown()

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

inline

Definition at line 134 of file DCMTree_Dict.h.

multiplicity()

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

virtual

get the multiplicity (min/max) of values of the given tag uses info from child classes

name()

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

pure virtual

get the name of the given tag uses info from child classes

postInitialize()

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

virtual

Do some init after the implementing DLL was loaded.

Used by DCMTree_OFFIS for 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

get the tag id for the given name uses info from child classes

transferSyntaxUID()

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

pure virtual

convert the enum to its uid needs to be implemented by child classes

vr()

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

virtual

get the DICOM VR of the given tag uses info from child classes

---

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

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