Implementation of DCMR Context Group: CID 7181 - Abstract Multi-dimensional Image Model Component Units. More...

Inheritance diagram for CID7181_AbstractMultiDimensionalImageModelComponentUnits:

Public Types
enum	EnumType { MmHg, KPa, PRU, WoodU, Dynscm5, PRUPerM2, WoodUPerM2, Dynscm5PerM2, Centimeter, Millimeter, Micrometer, SquareCentimeter, SquareMillimeter, SquareMicrometer, CubicDecimeter, CubicCentimeter, CubicMillimeter, CubicMicrometer, StandardizedUptakeValueBodyWeight, StandardizedUptakeValueLeanBodyMassJames, StandardizedUptakeValueLeanBodyMassJames128Multiplier, StandardizedUptakeValueLeanBodyMassJanma, StandardizedUptakeValueBodySurfaceArea, StandardizedUptakeValueIdealBodyWeight, Counts, CountsPerSecond, ProportionalToCounts, ProportionalToCountsPerSecond, SquareCentimeterPerMilliliter, Percent, BecquerelsPerMilliliter, MilligramsPerMinutePerMilliliter, MicromolePerMinutePerMilliliter, MilliliterPerMinutePerGram, MilliliterPerGram, PerCentimeter, MicromolePerMilliliter, Mm2PerS, Um2PerMs, Um2PerS, _106mm2PerS, Gy, Sv, NoUnits, Ratio, HounsfieldUnit, ArbitraryUnit, Ppm, CentimeterPerSecond, MillimeterPerSecond, Decibel, DegreesCelsius, MilliliterPerMinute, MilliliterPerSecond, Millisecond, Second, Hertz, MilliTesla, NumberParticlesPer100GramOfTissue, SecondPerSquareMillimeter, MilliliterPer100GramPerMinute, MilliliterPer100Milliliter, MillimolesPerKgWetWeight, PerMin, PerS }
	types of abstract multi-dimensional image model component units More...

Public Member Functions
	CID7181_AbstractMultiDimensionalImageModelComponentUnits (const DSRCodedEntryValue &selectedValue=DSRCodedEntryValue())
	(default) constructor More...

	CID7181_AbstractMultiDimensionalImageModelComponentUnits (const EnumType selectedValue, const OFBool enhancedEncodingMode=OFFalse)
	constructor More...

virtual OFCondition	selectValue (const EnumType selectedValue, const OFBool enhancedEncodingMode=OFFalse)
	select a coded entry given by its type as the current value More...

Public Member Functions inherited from DSRContextGroup
	operator const DSRCodedEntryValue & () const
	conversion operator that returns the currently selected coded entry value (might be empty if none is selected)

virtual void	clear ()
	clear list of extended coded entries and forget about the currently selected coded entry

OFBool	isExtensible () const
	check whether context group is extensible More...

void	setExtensible (const OFBool mode=OFTrue)
	change mode specifying whether the context group is extensible or non-extensible More...

const OFString &	getIdentifier () const
	get context identifier More...

const OFString &	getMappingResource () const
	get mapping resource More...

const OFString &	getVersion () const
	get context group version (optional) More...

const OFString &	getUID () const
	get context group UID (optional) More...

virtual OFBool	hasSelectedValue () const
	check whether a coded entry is selected as the current value More...

const DSRCodedEntryValue &	getSelectedValue () const
	get currently selected coded entry value (optional) More...

virtual OFCondition	selectValue (const DSRCodedEntryValue &codedEntryValue, const OFBool check=OFTrue, const OFBool definedContextGroup=OFFalse)
	select a given coded entry as the current value More...

virtual OFBool	hasCodedEntry (const DSRCodedEntryValue &codedEntryValue) const
	check whether a given coded entry is contained in this context group. More...

virtual OFCondition	findCodedEntry (const DSRCodedEntryValue &codedEntryValue) const
	search for a given coded entry in this context group. More...

virtual OFBool	hasExtendedCodedEntries () const
	check whether this context group has any extended coded entries. More...

virtual OFCondition	addCodedEntry (const DSRCodedEntryValue &codedEntryValue)
	add a coded entry to this context group as an extension, i.e. as a non-standard code. More...

virtual OFCondition	lookupCodedEntry (DSRCodedEntryValue &codedEntryValue, const OFBool enhancedEncodingMode=OFFalse) const
	search for a given coded entry in this context group and, if found, replace its value with the one found in the context group. More...

virtual void	print (STD_NAMESPACE ostream &stream) const
	print contents of this context group, i.e. a general header, the currently selected coded entry value (if any) and all coded entries that are contained in this context group (both standard and extended ones). More...

virtual OFCondition	checkSelectedValue (const OFBool definedContextGroup=OFFalse) const
	check whether the currently selected coded entry is valid. More...

Static Public Member Functions
static void	initialize ()
	initialize this context group explicitly. More...

static void	cleanup ()
	cleanup this context group, i.e. delete the internal list of standard coded entries. More...

static DSRCodedEntryValue	getCodedEntry (const EnumType value, const OFBool enhancedEncodingMode=OFFalse)
	map a given type to the associated coded entry More...

Protected Types
typedef OFMap< EnumType, DSRBasicCodedEntry >	CodeList
	type used for storing and managing the coded entries

Protected Member Functions
virtual void	printCodes (STD_NAMESPACE ostream &stream) const
	print details on coded entries that are contained in this context group. More...

virtual OFCondition	findCodedEntry (const DSRCodedEntryValue &searchForCodedEntry, DSRCodedEntryValue *foundCodedEntry, const OFBool enhancedEncodingMode=OFFalse) const
	search for a given coded entry in this context group More...

Protected Member Functions inherited from DSRContextGroup
	DSRContextGroup (const OFString &contextIdentifier, const OFString &mappingResource, const OFString &contextGroupVersion="", const OFString &contextGroupUID="", const DSRCodedEntryValue &selectedValue=DSRCodedEntryValue())
	constructor More...

virtual	~DSRContextGroup ()
	destructor

virtual void	printHeader (STD_NAMESPACE ostream &stream) const
	print header with some general information on this context group More...

virtual OFCondition	checkCodedEntry (const DSRCodedEntryValue &codedEntryValue, const OFBool definedContextGroup) const
	check whether a given coded entry is valid. More...

Static Protected Member Functions
static CodeList &	getCodes ()
	get list of standard coded entries that are managed by this context group. More...

static OFCondition	setEnhancedEncodingMode (DSRCodedEntryValue &codedEntryValue)
	set the "Enhanced Encoding Mode" for a given coded entry More...

Static Private Attributes
static CodeList *	Codes
	pointer to internal code list (use a static variable for singleton pattern)

Detailed Description

Implementation of DCMR Context Group: CID 7181 - Abstract Multi-dimensional Image Model Component Units.

(type: extensible, version: 20180605)

Member Enumeration Documentation

◆ EnumType

enum CID7181_AbstractMultiDimensionalImageModelComponentUnits::EnumType

types of abstract multi-dimensional image model component units

Enumerator
MmHg	(mm[Hg],UCUM,"mmHg"), included from CID 3500
KPa	(kPa,UCUM,"kPa"), included from CID 3500
PRU	([PRU],UCUM,"P.R.U."), included from CID 3502
WoodU	([wood'U],UCUM,"Wood U"), included from CID 3502
Dynscm5	(dyn.s.cm-5,UCUM,"dyn.s.cm-5"), included from CID 3502
PRUPerM2	([PRU]/m2,UCUM,"P.R.U./m2"), included from CID 3503
WoodUPerM2	([wood'U]/m2,UCUM,"Wood U/m2"), included from CID 3503
Dynscm5PerM2	(dyn.s.cm-5/m2,UCUM,"dyn.s.cm-5/m2"), included from CID 3503
Centimeter	(cm,UCUM,"centimeter"), included from CID 7460
Millimeter	(mm,UCUM,"millimeter"), included from CID 7460
Micrometer	(um,UCUM,"micrometer"), included from CID 7460
SquareCentimeter	(cm2,UCUM,"square centimeter"), included from CID 7461
SquareMillimeter	(mm2,UCUM,"square millimeter"), included from CID 7461
SquareMicrometer	(um2,UCUM,"square micrometer"), included from CID 7461
CubicDecimeter	(dm3,UCUM,"cubic decimeter"), included from CID 7462
CubicCentimeter	(cm3,UCUM,"cubic centimeter"), included from CID 7462
CubicMillimeter	(mm3,UCUM,"cubic millimeter"), included from CID 7462
CubicMicrometer	(um3,UCUM,"cubic micrometer"), included from CID 7462
StandardizedUptakeValueBodyWeight	(g/ml{SUVbw},UCUM,"Standardized Uptake Value body weight"), included from CID 85
StandardizedUptakeValueLeanBodyMassJames	(g/ml{SUVlbm},UCUM,"Standardized Uptake Value lean body mass (James)"), included from CID 85
StandardizedUptakeValueLeanBodyMassJames128Multiplier	(g/ml{SUVlbm(James128)},UCUM,"Standardized Uptake Value lean body mass (James 128 multiplier)"), included from CID 85
StandardizedUptakeValueLeanBodyMassJanma	(g/ml{SUVlbm(Janma)},UCUM,"Standardized Uptake Value lean body mass (Janma)"), included from CID 85
StandardizedUptakeValueBodySurfaceArea	(cm2/ml{SUVbsa},UCUM,"Standardized Uptake Value body surface area"), included from CID 85
StandardizedUptakeValueIdealBodyWeight	(g/ml{SUVibw},UCUM,"Standardized Uptake Value ideal body weight"), included from CID 85
Counts	({counts},UCUM,"Counts"), included from CID 84
CountsPerSecond	({counts}/s,UCUM,"Counts per second"), included from CID 84
ProportionalToCounts	({propcounts},UCUM,"Proportional to counts"), included from CID 84
ProportionalToCountsPerSecond	({propcounts}/s,UCUM,"Proportional to counts per second"), included from CID 84
SquareCentimeterPerMilliliter	(cm2/ml,UCUM,"Centimeter**2/milliliter"), included from CID 84
Percent	(%,UCUM,"Percent"), included from CID 84
BecquerelsPerMilliliter	(Bq/ml,UCUM,"Becquerels/milliliter"), included from CID 84
MilligramsPerMinutePerMilliliter	(mg/min/ml,UCUM,"Milligrams/minute/milliliter"), included from CID 84
MicromolePerMinutePerMilliliter	(umol/min/ml,UCUM,"Micromole/minute/milliliter"), included from CID 84
MilliliterPerMinutePerGram	(ml/min/g,UCUM,"Milliliter/minute/gram"), included from CID 84
MilliliterPerGram	(ml/g,UCUM,"Milliliter/gram"), included from CID 84
PerCentimeter	(/cm,UCUM,"/Centimeter"), included from CID 84
MicromolePerMilliliter	(umol/ml,UCUM,"Micromole/milliliter"), included from CID 84
Mm2PerS	(mm2/s,UCUM,"mm2/s"), included from CID 7277
Um2PerMs	(um2/ms,UCUM,"um2/ms"), included from CID 7277
Um2PerS	(um2/s,UCUM,"um2/s"), included from CID 7277
_106mm2PerS	(10-6.mm2/s,UCUM,"10-6.mm2/s"), included from CID 7277
Gy	(Gy,UCUM,"Gy"), included from CID 10071
Sv	(Sv,UCUM,"Sv"), included from CID 10071
NoUnits	(1,UCUM,"no units")
Ratio	({ratio},UCUM,"ratio")
HounsfieldUnit	([hnsf'U],UCUM,"Hounsfield Unit")
ArbitraryUnit	([arb'U],UCUM,"arbitrary unit")
Ppm	(ppm,UCUM,"ppm")
CentimeterPerSecond	(cm/s,UCUM,"centimeter/second")
MillimeterPerSecond	(mm/s,UCUM,"millimeter/second")
Decibel	(dB,UCUM,"decibel")
DegreesCelsius	(Cel,UCUM,"degrees Celsius")
MilliliterPerMinute	(ml/min,UCUM,"milliliter per minute")
MilliliterPerSecond	(ml/s,UCUM,"milliliter per second")
Millisecond	(ms,UCUM,"millisecond")
Second	(s,UCUM,"second")
Hertz	(Hz,UCUM,"Hertz")
MilliTesla	(mT,UCUM,"milliTesla")
NumberParticlesPer100GramOfTissue	({Particles}/[100]g{Tissue},UCUM,"number particles per 100 gram of tissue")
SecondPerSquareMillimeter	(s/mm2,UCUM,"second per square millimeter")
MilliliterPer100GramPerMinute	(ml/[100]g/min,UCUM,"milliliter per 100 gram per minute")
MilliliterPer100Milliliter	(ml/[100]ml,UCUM,"milliliter per 100 milliliter")
MillimolesPerKgWetWeight	(mmol/kg{WetWeight},UCUM,"millimoles per kg wet weight")
PerMin	(/min,UCUM,"/min")
PerS	(/s,UCUM,"/s")

Constructor & Destructor Documentation

◆ CID7181_AbstractMultiDimensionalImageModelComponentUnits() [1/2]

CID7181_AbstractMultiDimensionalImageModelComponentUnits::CID7181_AbstractMultiDimensionalImageModelComponentUnits ( const DSRCodedEntryValue & selectedValue = DSRCodedEntryValue() )

(default) constructor

Parameters

selectedValue coded entry to be selected as the current value (optional). Should be a valid code according to the DICOM definitions for this context group, i.e. no checks are performed. Call DSRContextGroup::checkSelectedValue() if needed.

◆ CID7181_AbstractMultiDimensionalImageModelComponentUnits() [2/2]

CID7181_AbstractMultiDimensionalImageModelComponentUnits::CID7181_AbstractMultiDimensionalImageModelComponentUnits	(	const EnumType	selectedValue,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)

constructor

Parameters

selectedValue	type mapped to a coded entry that is selected as the current value
enhancedEncodingMode	set enhanced encoding mode for coded entry (if enabled)

Member Function Documentation

◆ cleanup()

static void CID7181_AbstractMultiDimensionalImageModelComponentUnits::cleanup ( )

static

cleanup this context group, i.e. delete the internal list of standard coded entries.

Usually, there is no need to call this method, but it might be useful in order to explicitly free the associated memory, e.g. when checking for memory leaks. The list will be recreated automatically when needed (or when initialize() is called).

◆ findCodedEntry()

virtual OFCondition CID7181_AbstractMultiDimensionalImageModelComponentUnits::findCodedEntry	(	const DSRCodedEntryValue &	searchForCodedEntry,
		DSRCodedEntryValue *	foundCodedEntry,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)		const

protectedvirtual

search for a given coded entry in this context group

Parameters

searchForCodedEntry	coded entry to be searched for
foundCodedEntry	pointer to variable that will store the coded entry (if found and pointer is not NULL)
enhancedEncodingMode	set enhanced encoding mode for coded entry (if enabled)

Returns: result of the search process, also defines the type of the entry

Reimplemented from DSRContextGroup.

◆ getCodedEntry()

static DSRCodedEntryValue CID7181_AbstractMultiDimensionalImageModelComponentUnits::getCodedEntry	(	const EnumType	value,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)

static

map a given type to the associated coded entry

Parameters

value	type that should be mapped to a coded entry
enhancedEncodingMode	set enhanced encoding mode for coded entry (if enabled)

Returns: coded entry that is associated with the given type

◆ getCodes()

static CodeList& CID7181_AbstractMultiDimensionalImageModelComponentUnits::getCodes ( )

staticprotected

get list of standard coded entries that are managed by this context group.

Internally, the singleton pattern is used, so the list is initialized only once. Please note that this function is not thread-safe. Therefore, the initialize() function can be called before any instance of this class is actually used.

Returns: reference to list of coded entries managed by this context group

◆ initialize()

static void CID7181_AbstractMultiDimensionalImageModelComponentUnits::initialize ( )

static

initialize this context group explicitly.

Internally, the list of standard coded entries is created and initialized by calling getCodes().

Note: This function can be called multiple times but in case of multi-threaded applications should be called at least once before any instance of this class is actually used. For single-threaded applications, there is no need to call it since the initialization is done implicitly.

◆ printCodes()

virtual void CID7181_AbstractMultiDimensionalImageModelComponentUnits::printCodes ( STD_NAMESPACE ostream & stream ) const

protectedvirtual

print details on coded entries that are contained in this context group.

See DSRCodedEntryValue::print() for details of the coded entry output.

Parameters

stream stream to which the output should be printed

Reimplemented from DSRContextGroup.

◆ selectValue()

virtual OFCondition CID7181_AbstractMultiDimensionalImageModelComponentUnits::selectValue	(	const EnumType	selectedValue,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)

virtual

select a coded entry given by its type as the current value

Parameters

selectedValue	type mapped to a coded entry that is selected as the current value
enhancedEncodingMode	set enhanced encoding mode for coded entry (if enabled)

Returns: status, EC_Normal if successful, an error code otherwise

◆ setEnhancedEncodingMode()

static OFCondition CID7181_AbstractMultiDimensionalImageModelComponentUnits::setEnhancedEncodingMode ( DSRCodedEntryValue & codedEntryValue )

staticprotected

set the "Enhanced Encoding Mode" for a given coded entry

Parameters

codedEntryValue coded entry for which the enhanced encoding mode is set

Returns: status, EC_Normal if successful, an error code otherwise

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

dcmsr/include/dcmtk/dcmsr/cmr/cid7181.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EnumType

Constructor & Destructor Documentation

◆ CID7181_AbstractMultiDimensionalImageModelComponentUnits() [1/2]

◆ CID7181_AbstractMultiDimensionalImageModelComponentUnits() [2/2]

Member Function Documentation

◆ cleanup()

◆ findCodedEntry()

◆ getCodedEntry()

◆ getCodes()

◆ initialize()

◆ printCodes()

◆ selectValue()

◆ setEnhancedEncodingMode()