List type managing and maintaining a number of PrivateDICOMTagValueFields::PrivateTagField containers describing information extracted from private tag values. More...

#include <mlPrivateDICOMTagValueFields.h>

Public Member Functions
	PrivateDICOMTagValueFields ()
	Default constructor creating an empty list. More...

virtual	~PrivateDICOMTagValueFields ()
	Default constructor creating an empty list. More...

void	setDecoderName (const std::string &decoderName)
	Stores decoderName as the name of the decoder who filled the fields. More...

const std::string &	getDecoderName () const
	Returns the name of the decoder who filled the fields. More...

std::list< PrivateDICOMTagInfos > &	getFieldList ()
	Returns the list of fields. More...

const std::list< PrivateDICOMTagInfos > &	getFieldList () const
	Returns the constant list of fields. More...

void	clear ()
	Clear and delete all elements. More...

std::string	getStringDump (const std::string &prefix=" ", bool showVM=false, size_t appMaxSize=std::string::npos) const
	Return all field values dumped in one string, where prefix is added before each field output line in the returned string. More...

virtual void	addInformation (bool isValidTagInfo, const std::string &otherInfo="", const std::string &tagName="", const std::string &tagValue="", unsigned short tagGroupId=0, unsigned short tagElementId=0, bool isValidId=false, const std::string &tagVr="", const std::string &tagVm="")
	Convenience method to add a new field information to the container. More...

Protected Attributes
std::string	_decoderName
	Name of the decoder who filled *this with information. More...

std::list< PrivateDICOMTagInfos >	_fieldList
	List of extracted fields managed by this class. More...

Detailed Description

List type managing and maintaining a number of PrivateDICOMTagValueFields::PrivateTagField containers describing information extracted from private tag values.

Definition at line 32 of file mlPrivateDICOMTagValueFields.h.

Constructor & Destructor Documentation

◆ PrivateDICOMTagValueFields()

ml::PrivateDICOMTagValueFields::PrivateDICOMTagValueFields ( )

Default constructor creating an empty list.

◆ ~PrivateDICOMTagValueFields()

virtual ml::PrivateDICOMTagValueFields::~PrivateDICOMTagValueFields ( )

inlinevirtual

Default constructor creating an empty list.

Definition at line 40 of file mlPrivateDICOMTagValueFields.h.

Member Function Documentation

◆ addInformation()

virtual void ml::PrivateDICOMTagValueFields::addInformation	(	bool	isValidTagInfo,
		const std::string &	otherInfo = `""`,
		const std::string &	tagName = `""`,
		const std::string &	tagValue = `""`,
		unsigned short	tagGroupId = `0`,
		unsigned short	tagElementId = `0`,
		bool	isValidId = `false`,
		const std::string &	tagVr = `""`,
		const std::string &	tagVm = `""`
	)

virtual

Convenience method to add a new field information to the container.

Parameters

isValidTagInfo	Indicates whether a real tag is described(true) or not (false).
otherInfo	Any other information string.
tagName	String name of the tag if available, otherwise empty.
tagValue	Value of the tag if available, otherwise empty.
tagGroupId	Group id of the tag if available, otherwise 0.
tagElementId	Element id of the tag if available, otherwise 0.
isValidId	If true the two id values shall be considered valid values, otherwise not.
tagVr	Value representation of the tag if available, otherwise empty.
tagVm	Value multiplicity of the tag if available, otherwise empty.

◆ clear()

void ml::PrivateDICOMTagValueFields::clear ( )

Clear and delete all elements.

◆ getDecoderName()

const std::string& ml::PrivateDICOMTagValueFields::getDecoderName ( ) const

Returns the name of the decoder who filled the fields.

◆ getFieldList() [1/2]

std::list<PrivateDICOMTagInfos>& ml::PrivateDICOMTagValueFields::getFieldList ( )

Returns the list of fields.

◆ getFieldList() [2/2]

const std::list<PrivateDICOMTagInfos>& ml::PrivateDICOMTagValueFields::getFieldList ( ) const

Returns the constant list of fields.

◆ getStringDump()

std::string ml::PrivateDICOMTagValueFields::getStringDump	(	const std::string &	prefix = `" "`,
		bool	showVM = `false`,
		size_t	appMaxSize = `std::string::npos`
	)		const

Return all field values dumped in one string, where prefix is added before each field output line in the returned string.

Parameters

prefix	A string used for indenting the printed fields, typically two spaces.
showVM	If true then non-empty VM string values are shown, otherwise not.
appMaxSize	Defines the approximate maximum size of the returned string, default MAX_SIZE_T. If it is exceeded the string is clamped and terminated with a message that it was shortened.

Returns: The composed dumped string.

◆ setDecoderName()

void ml::PrivateDICOMTagValueFields::setDecoderName ( const std::string & decoderName )

Stores decoderName as the name of the decoder who filled the fields.

Member Data Documentation

◆ _decoderName

std::string ml::PrivateDICOMTagValueFields::_decoderName

protected

Name of the decoder who filled *this with information.

Definition at line 92 of file mlPrivateDICOMTagValueFields.h.

◆ _fieldList

std::list<PrivateDICOMTagInfos> ml::PrivateDICOMTagValueFields::_fieldList