DCMR Context Group with enhanced functionality: CID 4031 - Common Anatomic Region. More...

Inheritance diagram for CID4031e_CommonAnatomicRegion:

Public Member Functions
	CID4031e_CommonAnatomicRegion (const DSRCodedEntryValue &selectedValue=DSRCodedEntryValue())
	(default) constructor

	CID4031e_CommonAnatomicRegion (const EnumType selectedValue, const OFBool enhancedEncodingMode=OFFalse)
	constructor

	CID4031e_CommonAnatomicRegion (const OFString &selectedValue, const OFBool enhancedEncodingMode=OFFalse)
	constructor

virtual OFCondition	selectValue (const OFString &selectedValue, const OFBool enhancedEncodingMode=OFFalse)
	select a coded entry given by its associated defined term as the current value

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

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

Public Member Functions inherited from CID4031_CommonAnatomicRegion
	CID4031_CommonAnatomicRegion (const DSRCodedEntryValue &selectedValue=DSRCodedEntryValue())
	(default) constructor

	CID4031_CommonAnatomicRegion (const EnumType selectedValue, const OFBool enhancedEncodingMode=OFFalse)
	constructor

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

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

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

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

const OFString &	getIdentifier () const
	get context identifier

const OFString &	getMappingResource () const
	get mapping resource

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

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

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

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

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

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

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

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.

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).

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

Static Public Member Functions
static DSRCodedEntryValue	mapBodyPartExamined (const OFString &definedTerm, const OFBool enhancedEncodingMode=OFFalse)
	map a defined term for Body Part Examined (0018,0015) to the associated coded entry.

static OFCondition	mapBodyPartExamined (const OFString &definedTerm, DSRCodedEntryValue &codedEntryValue, const OFBool enhancedEncodingMode=OFFalse)
	map a defined term for Body Part Examined (0018,0015) to the associated coded entry.

Static Public Member Functions inherited from CID4031_CommonAnatomicRegion
static void	initialize ()
	initialize this context group explicitly.

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

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

Additional Inherited Members
Public Types inherited from CID4031_CommonAnatomicRegion
enum	EnumType { Abdomen , AbdomenAndPelvis , AcromioclavicularJoint , AnkleJoint , Anus , ApexOfLung , BileDuct , BiliaryTract , Bladder , BoneOfLowerLimb , BoneOfUpperLimb , Breast , Bronchus , Calcaneus , CervicalSpine , CervicoThoracicSpine , Chest , ChestAndAbdomen , ChestAbdomenAndPelvis , Clavicle , Coccyx , Colon , CommonBileDuct , Duodenum , ElbowJoint , EntireBody , Esophagus , EsophagusStomachAndDuodenum , Extremity , Eye , EyeRegion , FacialBones , Femur , Fibula , Finger , Foot , Forearm , Gallbladder , Hand , Head , HeadAndNeck , Heart , Hip , HipJoint , Humerus , Ileum , Ilium , InternalAuditoryCanal , JawRegion , Jejunum , Knee , LargeIntestine , Larynx , LiverAndBiliaryStructure , LowerLeg , LowerLimb , LumbarSpine , LumboSacralSpine , Mandible , MastoidBone , Maxilla , Mediastinum , MuscleOfLowerLimb , MuscleOfUpperLimb , NasalBone , Neck , NeckAndChest , NeckChestAndAbdomen , NeckChestAbdomenAndPelvis , OpticCanal , OrbitalStructure , Pancreas , PancreaticDuct , PancreaticDuctAndBileDuctSystems , ParanasalSinus , ParotidGland , Patella , Pelvis , PelvisAndLowerExtremities , Phantom , Prostate , Rectum , Rib , SacroCoccygealSpine , SacroiliacJoint , Sacrum , Scapula , SellaTurcica , SesamoidBonesOfFoot , Shoulder , Skull , SmallIntestine , Spine , SternoclavicularJoint , Sternum , Stomach , SubmandibularGland , TarsalJoint , TemporomandibularJoint , Thigh , ThoracicSpine , ThoracoLumbarSpine , Thumb , Toe , Trachea , UpperArm , UpperLimb , UpperUrinaryTract , Ureter , Urethra , UterusAndFallopianTubes , VertebralColumnAndCranium , WristJoint , Zygoma }
	types of common anatomic region More...

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

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

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

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

virtual	~DSRContextGroup ()
	destructor

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

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

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

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

Detailed Description

DCMR Context Group with enhanced functionality: CID 4031 - Common Anatomic Region.

Constructor & Destructor Documentation

◆ CID4031e_CommonAnatomicRegion() [1/3]

CID4031e_CommonAnatomicRegion::CID4031e_CommonAnatomicRegion ( 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.

◆ CID4031e_CommonAnatomicRegion() [2/3]

CID4031e_CommonAnatomicRegion::CID4031e_CommonAnatomicRegion	(	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)

◆ CID4031e_CommonAnatomicRegion() [3/3]

CID4031e_CommonAnatomicRegion::CID4031e_CommonAnatomicRegion	(	const OFString &	selectedValue,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)

constructor

Parameters

selectedValue	defined term for Body Part Examined (0018,0015) 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

◆ mapBodyPartExamined() [1/2]

static DSRCodedEntryValue CID4031e_CommonAnatomicRegion::mapBodyPartExamined	(	const OFString &	definedTerm,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)

static

map a defined term for Body Part Examined (0018,0015) to the associated coded entry.

See DICOM PS 3.16 Annex L (Correspondence of Anatomic Region Codes and Body Part Examined Defined Terms) for details on this mapping.

Parameters

definedTerm	defined term 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 defined term, or an empty value if none was found

◆ mapBodyPartExamined() [2/2]

static OFCondition CID4031e_CommonAnatomicRegion::mapBodyPartExamined	(	const OFString &	definedTerm,
		DSRCodedEntryValue &	codedEntryValue,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)

static

map a defined term for Body Part Examined (0018,0015) to the associated coded entry.

See DICOM PS 3.16 Annex L (Correspondence of Anatomic Region Codes and Body Part Examined Defined Terms) for details on this mapping.

Parameters

definedTerm	defined term that should be mapped to a coded entry
codedEntryValue	reference to variable where the resulting coded entry is stored. This variable is not cleared in case of error.
enhancedEncodingMode	set enhanced encoding mode for coded entry (if enabled)

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

◆ selectValue() [1/3]

virtual OFCondition DSRContextGroup::selectValue	(	const DSRCodedEntryValue &	codedEntryValue,
		const OFBool	check = `OFTrue`,
		const OFBool	definedContextGroup = `OFFalse`
	)

virtual

select a given coded entry as the current value

Parameters

codedEntryValue	coded entry to be selected as the current value
check	if enabled, check 'codedEntryValue' for validity and appropriateness before selecting it as the current value. See checkSelectedValue() for details.
definedContextGroup	flag indicating whether this context group is used as a baseline (default) or defined context group. The first means that the list of coded entries in this context group is just a suggestion. The latter means that one of the coded entries should be used.

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

Reimplemented from CID4031_CommonAnatomicRegion.

◆ selectValue() [2/3]

virtual OFCondition CID4031_CommonAnatomicRegion::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

Reimplemented from CID4031_CommonAnatomicRegion.

◆ selectValue() [3/3]

virtual OFCondition CID4031e_CommonAnatomicRegion::selectValue	(	const OFString &	selectedValue,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)

virtual

select a coded entry given by its associated defined term as the current value

Parameters

selectedValue	defined term for Body Part Examined (0018,0015) 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

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

dcmsr/include/dcmtk/dcmsr/cmr/cid4031e.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CID4031e_CommonAnatomicRegion() [1/3]

◆ CID4031e_CommonAnatomicRegion() [2/3]

◆ CID4031e_CommonAnatomicRegion() [3/3]

Member Function Documentation

◆ mapBodyPartExamined() [1/2]

◆ mapBodyPartExamined() [2/2]

◆ selectValue() [1/3]

◆ selectValue() [2/3]

◆ selectValue() [3/3]