Implementation of DCMR Template: TID 1501 - Measurement Group (and included templates 1502 and 300). More...

Inheritance diagram for TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >:

Public Member Functions
	TID1501_MeasurementGroup (const OFBool createGroup=OFFalse)
	(default) constructor More...

virtual void	clear ()
	clear internal member variables. More...

OFBool	isValid () const
	check whether the current internal state is valid. More...

OFBool	hasMeasurementGroup (const OFBool checkChildren=OFFalse) const
	check whether the 'Measurement Group' content item (TID 1501 - Row 1) is present. More...

OFBool	hasTrackingIdentifier () const
	check whether the 'Tracking Identifier' content item (TID 1501 - Row 2) is present. More...

OFBool	hasTrackingUniqueIdentifier () const
	check whether the 'Tracking Unique Identifier' content item (TID 1501 - Row 3) is present. More...

OFBool	hasMeasurements (const OFBool checkChildren=OFTrue) const
	check whether there is an included 'Measurement' template (TID 1501 - Row 10) in this measurement template. More...

TID300_Measurement &	getMeasurement () const
	get current measurement value of this measurement group as defined by TID 300 (Measurement), i.e. the current instance of TID 1501 - Row 10. More...

OFCondition	setActivitySession (const OFString &session, const OFBool check=OFTrue)
	set the value of the 'Activity Session' content item (TID 1501 - Row 1b). More...

OFCondition	setTrackingIdentifier (const OFString &trackingID, const OFBool check=OFTrue)
	set the value of the 'Tracking Identifier' content item (TID 1501 - Row 2). More...

OFCondition	setTrackingUniqueIdentifier (const OFString &trackingUID, const OFBool check=OFTrue)
	set the value of the 'Tracking Unique Identifier' content item (TID 1501 - Row 3). More...

OFCondition	setFinding (const DSRCodedEntryValue &finding, const OFBool check=OFTrue)
	set the value of the 'Finding' content item (TID 1501 - Row 3b). More...

OFCondition	setTimePoint (const OFString &timePoint, const OFBool check=OFTrue)
	set the value of the 'Time Point' content item (TID 1502 - Row 3). More...

OFCondition	setMeasurementMethod (const T_Method &method, const OFBool check=OFTrue)
	set the value of the 'Measurement Method' content item (TID 1501 - Row 5). More...

OFCondition	addFindingSite (const DSRCodedEntryValue &site, const CID244e_Laterality &laterality=CID244e_Laterality(), const DSRCodedEntryValue &siteModifier=DSRCodedEntryValue(), const OFBool check=OFTrue)
	add a 'Finding Site' content item (TID 1501 - Row 6, 7 and 8). More...

OFCondition	setRealWorldValueMap (const DSRCompositeReferenceValue &valueMap, const OFBool check=OFTrue)
	set the value of the 'Real World Value Map used for measurement' content item (TID 1501 - Row 9). More...

OFCondition	setRealWorldValueMap (DcmItem &dataset, const OFBool check=OFTrue)
	set the value of the 'Real World Value Map used for measurement' content item (TID 1501 - Row 9). More...

OFCondition	addMeasurement (const T_Measurement &conceptName, const MeasurementValue &numericValue, const OFBool checkEmpty=OFTrue, const OFBool checkValue=OFTrue)
	add a measurement as defined in 'Measurement' (TID 300 - Row 1). More...

OFCondition	addQualitativeEvaluation (const DSRCodedEntryValue &conceptName, const DSRCodedEntryValue &codeValue, const OFBool check=OFTrue)
	add a qualitative evaluation related to the subject of the measurement group as a coded entry (TID 1501 - Row 11). More...

OFCondition	addQualitativeEvaluation (const DSRCodedEntryValue &conceptName, const OFString &stringValue, const OFBool check=OFTrue)
	add a qualitative evaluation related to the subject of the measurement group in text form (TID 1501 - Row 12). More...

Public Member Functions inherited from DSRSubTemplate
	DSRSubTemplate (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="")
	constructor More...

	DSRSubTemplate (const DSRSubTemplate &subTemplate)
	copy constructor. More...

virtual	~DSRSubTemplate ()
	destructor

virtual DSRSubTemplate *	clone () const
	clone this template. More...

virtual DSRDocumentSubTree *	cloneTree () const
	clone the internally stored subtree of this template. More...

OFBool	isRootTemplate () const
	check whether this template is a root template, i.e. describes a complete SR document tree starting from the root node More...

virtual const DSRDocumentSubTree &	getTree ()
	get read-only access to internally stored subtree. More...

virtual OFCondition	addExtraContentItem (const E_RelationshipType relationshipType, const E_ValueType valueType, const E_AddMode addMode=AM_afterCurrent)
	add extra content item to the current one (if the template is extensible). More...

virtual OFCondition	insertExtraTemplate (const DSRSubTemplate &subTemplate, const E_AddMode addMode=AM_belowCurrent, const E_RelationshipType defaultRelType=RT_unknown)
	insert tree from given extra template to internally stored subtree. More...

virtual OFBool	isCursorValid () const
	check whether the internal cursor, which points to the current content item, is valid More...

virtual OFCondition	print (STD_NAMESPACE ostream &stream, const size_t flags=0, const DSRPositionCounter *posCounter=NULL)
	print current SR document tree to specified output stream More...

virtual OFCondition	writeXML (STD_NAMESPACE ostream &stream, const size_t flags=0)
	write current SR document tree in XML format More...

size_t	countNodes (const OFBool searchIntoSubTemplates=OFFalse, const OFBool countIncludedTemplateNodes=OFTrue) const
	count number of content items (nodes) in the document tree. More...

virtual size_t	gotoNamedNode (const DSRCodedEntryValue &conceptName, const OFBool startFromRoot=OFTrue, const OFBool searchIntoSub=OFTrue)
	set internal cursor to a named node. More...

virtual size_t	gotoNextNamedNode (const DSRCodedEntryValue &conceptName, const OFBool searchIntoSub=OFTrue)
	set internal cursor to the next named node. More...

virtual size_t	gotoAnnotatedNode (const OFString &annotationText, const OFBool startFromRoot=OFTrue)
	set internal cursor to an annotated node. More...

virtual size_t	gotoNextAnnotatedNode (const OFString &annotationText)
	set internal cursor to the next annotated node. More...

virtual DSRContentItem &	getCurrentContentItem ()
	get reference to current content item. More...

virtual OFCondition	updateByReferenceRelationships (const OFBool updateIncludedTemplates=OFFalse)
	update the position strings used to encode by-reference relationships (if any). More...

Public Member Functions inherited from DSRTemplateCommon
virtual OFBool	hasTemplateIdentification () const
	check whether template identification is set More...

virtual OFBool	isTemplateIdentificationValid (const OFBool check=OFTrue) const
	check whether template identification is valid More...

virtual OFBool	isExtensible () const
	check whether template is extensible More...

virtual OFBool	isOrderSignificant () const
	check whether the order of content items in this template is significant More...

virtual OFBool	compareTemplateIdentication (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="") const
	compare template identification with given values More...

const OFString &	getTemplateIdentifier () const
	get template identifier More...

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

const OFString &	getMappingResourceUID () const
	get optional mapping resource UID More...

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

virtual void	setOrderSignificant (const OFBool mode=OFTrue)
	change mode specifying whether the order of content items in this template is significant or non-significant More...

Protected Member Functions
OFCondition	createMeasurementGroup ()
	create the mandatory root content item of this template, i.e. TID 1501 - Row 1. More...

OFCondition	addOrReplaceContentItem (const size_t nodePos, const E_RelationshipType relationshipType, const E_ValueType valueType, const DSRCodedEntryValue &conceptName, const OFString &annotationText, const OFBool check)
	add a new or replace an existing content item with a given node ID. More...

Protected Member Functions inherited from DSRSubTemplate
virtual void	updateTreeForOutput ()
	update the tree for subsequent output, e.g. for being printed or added to an SR document. More...

Protected Member Functions inherited from DSRDocumentSubTree
	DSRDocumentSubTree (DSRDocumentTreeNode *rootNode)
	special constructor that receives a pointer to the root node. More...

	DSRDocumentSubTree (const DSRDocumentTreeNodeCursor &startCursor, size_t stopAfterNodeID)
	special copy constructor that clones a particular subtree only More...

void	swap (DSRDocumentSubTree &tree)
	fast, non-throwing swap function. More...

virtual DSRDocumentTreeNode *	getNode () const
	get pointer to current node. More...

virtual size_t	addNode (DSRDocumentTreeNode *node, const E_AddMode addMode=AM_afterCurrent)
	add new node to the current one. More...

virtual size_t	replaceNode (DSRDocumentTreeNode *node)
	replace current node by the given one. More...

virtual DSRDocumentTreeNode *	extractNode ()
	extract current node from tree. More...

virtual DSRDocumentTreeNode *	getAndRemoveRootNode ()
	get pointer to root node and "forget" the internal reference to this node. More...

virtual size_t	removeNode ()
	remove current node from tree. More...

virtual OFCondition	includeTemplate (const DSRSharedSubTemplate &subTemplate, const E_AddMode addMode=AM_belowCurrent, const E_RelationshipType defaultRelType=RT_unknown)
	include specified sub-template, i.e. add a new DSRIncludedTemplateTreeNode, which references this template, to the current content item. More...

virtual OFCondition	expandIncludedTemplates (DSRDocumentSubTree *tree) const
	expand all "included template" content items in a given (sub)tree. More...

template<typename T_Cursor >
OFCondition	checkByReferenceRelationships (const size_t mode=0, const size_t flags=0)
	check the by-reference relationships (if any) for validity. More...

virtual void	resetReferenceTargetFlag ()
	reset flag for all content items whether they are target of a by-reference relationship. More...

virtual OFCondition	checkSubTreeConstraints (const DSRDocumentSubTree tree, const DSRIODConstraintChecker checker) const
	check whether the given subtree complies with the constraints of the given checker More...

virtual OFBool	validByReferenceRelationship (const OFString &sourcePosition, const OFString &targetPosition)
	check whether a by-reference relationship from a given source to a target node (specified by the position strings) is valid, i.e. is allowed according to the DICOM standard. More...

	DSRDocumentSubTree ()
	default constructor

	DSRDocumentSubTree (const DSRDocumentSubTree &tree)
	copy constructor. More...

virtual	~DSRDocumentSubTree ()
	destructor

DSRDocumentSubTree &	operator= (DSRDocumentSubTree tree)
	assignment operator. More...

virtual OFBool	isCursorValid () const
	check whether the internal cursor, which points to the current content item, is valid More...

virtual OFBool	isValidDocumentTree (const E_RelationshipType defaultRelType=RT_unknown) const
	check whether this subtree is a valid document tree. More...

virtual OFBool	isExpandedDocumentTree () const
	check whether this subtree is an expanded document tree. More...

virtual OFBool	hasTemplateIdentification () const
	check whether template identification is set More...

virtual OFBool	canUseTemplateIdentification () const
	check whether template identification is possible at all. More...

virtual OFCondition	print (STD_NAMESPACE ostream &stream, const size_t flags=0, const DSRPositionCounter *posCounter=NULL)
	print current SR document tree to specified output stream More...

virtual OFCondition	writeXML (STD_NAMESPACE ostream &stream, const size_t flags=0)
	write current SR document tree in XML format More...

virtual DSRContentItem &	getCurrentContentItem ()
	get reference to current content item. More...

virtual const DSRDocumentTreeNode *	getCurrentNode () const
	get read-only access to current node (content item) More...

virtual OFBool	getCursorToRootNode (DSRDocumentTreeNodeCursor &cursor) const
	get a cursor to the root node of this document tree. More...

virtual OFBool	getCursorToRootNode (DSRIncludedTemplateNodeCursor &cursor) const
	get a cursor to the root node of this document tree. More...

virtual OFBool	getCursorToCurrentNode (DSRDocumentTreeNodeCursor &cursor) const
	get a cursor to the current node of this document tree. More...

virtual OFBool	getCursorToSubTree (DSRDocumentTreeNodeCursor &cursor) const
	get a cursor to the subtree below the current node. More...

size_t	countNodes (const OFBool searchIntoSubTemplates=OFFalse, const OFBool countIncludedTemplateNodes=OFTrue) const
	count number of content items (nodes) in the document tree. More...

virtual size_t	gotoMatchingNode (const DSRDocumentTreeNodeFilter &filter, const OFBool startFromRoot=OFTrue, const OFBool searchIntoSub=OFTrue)
	set internal cursor to a matching node. More...

virtual size_t	gotoNextMatchingNode (const DSRDocumentTreeNodeFilter &filter, const OFBool searchIntoSub=OFTrue)
	set internal cursor to the next matching node. More...

virtual size_t	gotoNamedNode (const DSRCodedEntryValue &conceptName, const OFBool startFromRoot=OFTrue, const OFBool searchIntoSub=OFTrue)
	set internal cursor to a named node. More...

virtual size_t	gotoNamedChildNode (const DSRCodedEntryValue &conceptName)
	set internal cursor to a named node (starting from the first child of the current node and searching on this level only). More...

virtual size_t	gotoNamedNodeInSubTree (const DSRCodedEntryValue &conceptName, const OFBool searchIntoSub=OFTrue)
	set internal cursor to a named node in the subtree below the current node. More...

virtual size_t	gotoNextNamedNode (const DSRCodedEntryValue &conceptName, const OFBool searchIntoSub=OFTrue)
	set internal cursor to the next named node. More...

virtual size_t	gotoAnnotatedNode (const OFString &annotationText, const OFBool startFromRoot=OFTrue)
	set internal cursor to an annotated node. More...

virtual size_t	gotoNextAnnotatedNode (const OFString &annotationText)
	set internal cursor to the next annotated node. More...

virtual OFBool	canAddContentItem (const E_RelationshipType relationshipType, const E_ValueType valueType, const E_AddMode addMode=AM_afterCurrent) const
	check whether specified content item can be added to the current one. More...

virtual OFBool	canAddByReferenceRelationship (const E_RelationshipType relationshipType, const E_ValueType targetValueType) const
	check whether specified by-reference relationship can be added to the current content item. More...

virtual size_t	addContentItem (const E_RelationshipType relationshipType, const E_ValueType valueType, const E_AddMode addMode=AM_afterCurrent)
	add specified content item to the current one. More...

virtual OFCondition	addContentItem (DSRDocumentTreeNode *node, const E_AddMode addMode=AM_afterCurrent, const OFBool deleteIfFail=OFFalse)
	add specified content item to the current one. More...

virtual OFCondition	addContentItem (const E_RelationshipType relationshipType, const E_ValueType valueType, const DSRCodedEntryValue &conceptName, const OFBool check=OFTrue)
	add specified content item after the current one. More...

virtual OFCondition	addChildContentItem (const E_RelationshipType relationshipType, const E_ValueType valueType, const DSRCodedEntryValue &conceptName, const OFBool check=OFTrue)
	add specified content item below the current one. More...

virtual size_t	addByReferenceRelationship (const E_RelationshipType relationshipType, const size_t referencedNodeID)
	add specified by-reference relationship to the current content item. More...

virtual OFCondition	updateByReferenceRelationships (const OFBool updateIncludedTemplates=OFFalse)
	update the position strings used to encode by-reference relationships (if any). More...

virtual OFBool	canInsertSubTree (const DSRDocumentSubTree *tree, const E_AddMode addMode=AM_belowCurrent, const E_RelationshipType defaultRelType=RT_unknown) const
	check whether specified subtree can be inserted at the current position, i.e. added to the current content item. More...

virtual OFCondition	insertSubTree (DSRDocumentSubTree *tree, const E_AddMode addMode=AM_belowCurrent, const E_RelationshipType defaultRelType=RT_unknown, const OFBool deleteIfFail=OFFalse)
	insert specified subtree to this tree, i.e. add it to the current content item. More...

virtual DSRDocumentSubTree *	extractSubTree ()
	extract a subtree, i.e. a fragment from this tree. More...

virtual size_t	removeCurrentContentItem ()
	remove current content item from tree. More...

virtual OFCondition	removeSubTree (const size_t searchID=0)
	remove a subtree from this tree. More...

virtual DSRDocumentTreeNode *	cloneCurrentTreeNode () const
	clone the current tree node. More...

virtual DSRDocumentSubTree *	cloneSubTree (const size_t stopAfterNodeID=0) const
	clone a subtree, i.e. a fragment of this tree. More...

virtual OFCondition	createExpandedSubTree (DSRDocumentSubTree *&tree) const
	created an expanded version of this (sub)tree. More...

virtual OFCondition	setObservationDateTime (const OFString &observationDateTime, const OFBool check=OFTrue)
	set observation date/time for all content items in the document tree. More...

virtual OFBool	compareTemplateIdentification (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="") const
	compare template identification of the root node with given values. More...

virtual OFCondition	getTemplateIdentification (OFString &templateIdentifier, OFString &mappingResource) const
	get template identifier and mapping resource from the root node of this tree. More...

virtual OFCondition	getTemplateIdentification (OFString &templateIdentifier, OFString &mappingResource, OFString &mappingResourceUID) const
	get template identifier, mapping resource and optional mapping resource UID from the root node of this tree. More...

virtual OFCondition	setTemplateIdentification (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="", const OFBool check=OFTrue)
	set template identifier and mapping resource to the root node of this tree. More...

Protected Member Functions inherited from DSRTree< DSRDocumentTreeNode >
	DSRTree (DSRDocumentTreeNode *rootNode)
	special constructor that receives a pointer to the root node. More...

	DSRTree (const DSRTreeNodeCursor< DSRDocumentTreeNode > &startCursor, size_t stopAfterNodeID)
	special copy constructor that clones a particular subtree only More...

void	swap (DSRTree< DSRDocumentTreeNode > &tree)
	fast, non-throwing swap function. More...

virtual DSRDocumentTreeNode *	getRoot () const
	get pointer to root node More...

virtual void	deleteTreeFromRootNode (DSRDocumentTreeNode *rootNode)
	delete a tree given by its root node. More...

	DSRTree ()
	default constructor

	DSRTree (const DSRTree< DSRDocumentTreeNode > &tree)
	copy constructor. More...

virtual	~DSRTree ()
	destructor

DSRTree &	operator= (DSRTree< DSRDocumentTreeNode > tree)
	assignment operator. More...

void	clearAnnotations ()
	clear annotations of all tree nodes

OFBool	isEmpty () const
	check whether tree has any nodes More...

size_t	countNodes () const
	count number of nodes in the tree. More...

size_t	getNextNodeID () const
	get ID of the next node to be created. More...

size_t	gotoRoot ()
	set internal cursor to root node More...

size_t	gotoNode (const size_t searchID, const OFBool startFromRoot=OFTrue)
	set internal cursor to specified node More...

size_t	gotoNode (const OFString &reference, const OFBool startFromRoot=OFTrue)
	set internal cursor to specified node More...

size_t	gotoNode (const DSRTreeNodeAnnotation &annotation, const OFBool startFromRoot=OFTrue)
	set internal cursor to specified node More...

size_t	gotoNode (const DSRDocumentTreeNode &nodeValue, const OFBool startFromRoot=OFTrue)
	set internal cursor to specified node (given by its value). More...

Protected Member Functions inherited from DSRTemplateCommon
	DSRTemplateCommon (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="")
	constructor More...

virtual	~DSRTemplateCommon ()
	destructor

void	clearEntriesInNodeList ()
	clear all entries in the list of node IDs, i.e. set them to their initial value, which is 0

void	reserveEntriesInNodeList (const size_t count, const OFBool initialize=OFFalse)
	reserve a certain number of entries in the list of node IDs. More...

void	storeEntryInNodeList (const size_t pos, const size_t nodeID)
	store given entry at a certain position in the list of node IDs More...

size_t	getEntryFromNodeList (const size_t pos) const
	get a particular entry from the list of node IDs More...

size_t	gotoEntryFromNodeList (DSRDocumentTreeNodeCursor &cursor, const size_t pos) const
	set given cursor to a specific node More...

size_t	gotoEntryFromNodeList (DSRDocumentSubTree *tree, const size_t pos)
	set internal cursor of a given document tree to a specific node More...

size_t	gotoLastEntryFromNodeList (DSRDocumentSubTree *tree, const size_t lastPos, const size_t firstPos=0)
	set internal cursor of a given document tree to a particular node. More...

virtual OFBool	hasTemplateIdentification () const
	check whether template identification is set More...

virtual OFBool	isTemplateIdentificationValid (const OFBool check=OFTrue) const
	check whether template identification is valid More...

virtual OFBool	isExtensible () const
	check whether template is extensible More...

virtual OFBool	isOrderSignificant () const
	check whether the order of content items in this template is significant More...

virtual OFBool	compareTemplateIdentication (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="") const
	compare template identification with given values More...

const OFString &	getTemplateIdentifier () const
	get template identifier More...

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

const OFString &	getMappingResourceUID () const
	get optional mapping resource UID More...

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

virtual void	setOrderSignificant (const OFBool mode=OFTrue)
	change mode specifying whether the order of content items in this template is significant or non-significant More...

Additional Inherited Members
Static Protected Member Functions inherited from DSRDocumentSubTree
static DSRDocumentSubTree *	cloneSubTree (const DSRDocumentTreeNodeCursor &startCursor, const size_t stopAfterNodeID=0)
	clone a particular subtree, i.e. a fragment of a tree More...

Protected Attributes inherited from DSRDocumentSubTree
DSRIODConstraintChecker *	ConstraintChecker
	check relationship content constraints of the associated IOD

Detailed Description

template<typename T_Measurement, typename T_Units, typename T_Method, typename T_Derivation>
class TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >

Implementation of DCMR Template: TID 1501 - Measurement Group (and included templates 1502 and 300).

All added content items are annotated with a text in the format "TID 1501 - Row [n]".

Template Parameters

T_Measurement	concept names for the numeric measurements (context group)
T_Units	units of the numeric measurement values (context group)
T_Method	methods used for measuring the values (context group)
T_Derivation	methods of deriving or calculating the values (context group)

Note: Please note that this template class requires explicit instantiation for those combinations of the template parameters that are actually used. This is because the implementation is "hidden" in a separate source file, which has some advantages over the usual header-only approach.

Constructor & Destructor Documentation

◆ TID1501_MeasurementGroup()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::TID1501_MeasurementGroup ( const OFBool createGroup = OFFalse )

(default) constructor

Parameters

createGroup flag indicating whether to create an empty measurement group by calling createMeasurementGroup() during startup

Member Function Documentation

◆ addFindingSite()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::addFindingSite	(	const DSRCodedEntryValue &	site,
		const CID244e_Laterality &	laterality = `CID244e_Laterality()`,
		const DSRCodedEntryValue &	siteModifier = `DSRCodedEntryValue()`,
		const OFBool	check = `OFTrue`
	)

add a 'Finding Site' content item (TID 1501 - Row 6, 7 and 8).

A measurement group is created automatically (if none is present).

Parameters

site	coded entry describing the anatomic location of the measurements in the current group
laterality	laterality associated with the 'site' (optional)
siteModifier	coded entry describing the topographical modifier of the 'site' (optional)
check	if enabled, check values for validity before setting them

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

◆ addMeasurement()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::addMeasurement	(	const T_Measurement &	conceptName,
		const MeasurementValue &	numericValue,
		const OFBool	checkEmpty = `OFTrue`,
		const OFBool	checkValue = `OFTrue`
	)

add a measurement as defined in 'Measurement' (TID 300 - Row 1).

A measurement group is created automatically (if none is present). There should be at least a single instance of the associated template. Access to the current instance is available through getMeasurement().

Parameters

conceptName	coded entry specifying the concept name of the measurement (e.g. from the given context group 'T_Measurement')
numericValue	numeric measurement value to be set. The measurement unit could be taken from the baseline context group 'T_Units'.
checkEmpty	by default, it is checked whether the current instance of TID 300 is empty, and thus no new instance is created. Setting this parameter to OFFalse disables this check and always creates and adds a new instance of this sub-template.
checkValue	if enabled, check values for validity before setting them

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

◆ addOrReplaceContentItem()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::addOrReplaceContentItem	(	const size_t	nodePos,
		const E_RelationshipType	relationshipType,
		const E_ValueType	valueType,
		const DSRCodedEntryValue &	conceptName,
		const OFString &	annotationText,
		const OFBool	check
	)

protected

add a new or replace an existing content item with a given node ID.

If the content item does not exist, it is added to the measurement group, i.e. below the root node. If it does exist, both the 'valueType' and 'conceptName' are checked before replacing the value. However, the value is not replaced by this method. This is up to the caller after this method returned with success.

Parameters

nodePos	index of the list entry that stores the ID of the node to search for
relationshipType	relationship type of the content item to be added/replaced
valueType	value type of the content item to be added/replaced
conceptName	concept name of the content item to be added/replaced
annotationText	optional text used to annotate the content item
check	if enabled, check values for validity before setting them

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

◆ addQualitativeEvaluation() [1/2]

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::addQualitativeEvaluation	(	const DSRCodedEntryValue &	conceptName,
		const DSRCodedEntryValue &	codeValue,
		const OFBool	check = `OFTrue`
	)

add a qualitative evaluation related to the subject of the measurement group as a coded entry (TID 1501 - Row 11).

A measurement group is created automatically (if none is present).

Parameters

conceptName	coded entry to be set as the concept name
codeValue	coded entry to be set as the value of the new content item
check	if enabled, check values for validity before setting them

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

◆ addQualitativeEvaluation() [2/2]

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::addQualitativeEvaluation	(	const DSRCodedEntryValue &	conceptName,
		const OFString &	stringValue,
		const OFBool	check = `OFTrue`
	)

add a qualitative evaluation related to the subject of the measurement group in text form (TID 1501 - Row 12).

A measurement group is created automatically (if none is present).

Parameters

conceptName	coded entry to be set as the concept name
stringValue	character string to be set as the value of the content item
check	if enabled, check values for validity before setting them

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

◆ clear()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

virtual void TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::clear ( )

virtual

clear internal member variables.

Also see notes on the clear() method of the base class.

Reimplemented from DSRSubTemplate.

◆ createMeasurementGroup()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::createMeasurementGroup ( )

protected

create the mandatory root content item of this template, i.e. TID 1501 - Row 1.

It is expected that the tree is currently empty.

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

◆ getMeasurement()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

TID300_Measurement& TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::getMeasurement ( ) const

inline

get current measurement value of this measurement group as defined by TID 300 (Measurement), i.e. the current instance of TID 1501 - Row 10.

This included template is mandatory, i.e. should be present and not be empty. Further instances can be added by calling addMeasurement().

Returns: reference to internally managed SR template (current instance)

◆ hasMeasurementGroup()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFBool TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::hasMeasurementGroup ( const OFBool checkChildren = OFFalse ) const

check whether the 'Measurement Group' content item (TID 1501 - Row 1) is present.

This mandatory content item can be created by the constructor of this class (if not disabled, which is the default) or internally by createMeasurementGroup(). After clear() has been called, the content item has to be recreated, which is done automatically when needed.

Parameters

checkChildren optional flag indicating whether to also check for any children, i.e. whether the respective content item has child nodes. By default, the presence of the higher-level CONTAINER is checked only.

Returns: OFTrue if the measurement group is present, OFFalse otherwise

◆ hasMeasurements()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFBool TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::hasMeasurements ( const OFBool checkChildren = OFTrue ) const

check whether there is an included 'Measurement' template (TID 1501 - Row 10) in this measurement template.

Initially, this mandatory sub-template is created and included by the constructor of this class. After clear() has been called, the content item has to be recreated, which is done automatically when needed.

Parameters

checkChildren flag, which is enabled by default, indicating whether to check for any children, i.e. whether the respective sub-template has any content (child nodes). If OFFalse, the "included template" content item is checked only.

Returns: OFTrue if measurements are present, OFFalse otherwise

◆ hasTrackingIdentifier()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFBool TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::hasTrackingIdentifier ( ) const

check whether the 'Tracking Identifier' content item (TID 1501 - Row 2) is present.

This content item is mandatory, i.e. should be present with a value.

Returns: OFTrue if the tracking identifier is present, OFFalse otherwise

◆ hasTrackingUniqueIdentifier()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFBool TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::hasTrackingUniqueIdentifier ( ) const

check whether the 'Tracking Unique Identifier' content item (TID 1501 - Row 3) is present.

This content item is mandatory, i.e. should be present with a value.

Returns: OFTrue if the tracking unique identifier is present, OFFalse otherwise

◆ isValid()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFBool TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::isValid ( ) const

virtual

check whether the current internal state is valid.

That means, whether the base class is valid and whether all mandatory content items and included templates are valid (present), i.e. hasMeasurementGroup(), hasTrackingIdentifier(), hasTrackingUniqueIdentifier() and hasMeasurements() return true.

Returns: OFTrue if valid, OFFalse otherwise

Reimplemented from DSRSubTemplate.

◆ setActivitySession()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::setActivitySession	(	const OFString &	session,
		const OFBool	check = `OFTrue`
	)

set the value of the 'Activity Session' content item (TID 1501 - Row 1b).

A measurement group is created automatically (if none is present). If the content item already exists, its value is overwritten.

Parameters

session	identifier of the session during which the measurements were made
check	if enabled, check values for validity before setting them

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

◆ setFinding()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::setFinding	(	const DSRCodedEntryValue &	finding,
		const OFBool	check = `OFTrue`
	)

set the value of the 'Finding' content item (TID 1501 - Row 3b).

A measurement group is created automatically (if none is present). If the content item already exists, its value is overwritten.

Parameters

finding	coded entry that describes the type of the finding
check	if enabled, check values for validity before setting them

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

◆ setMeasurementMethod()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::setMeasurementMethod	(	const T_Method &	method,
		const OFBool	check = `OFTrue`
	)

set the value of the 'Measurement Method' content item (TID 1501 - Row 5).

A measurement group is created automatically (if none is present). If the content item already exists, its value is overwritten.

Parameters

method	coded entry describing the method used for measuring the values in the group (e.g. from the given context group 'T_Method')
check	if enabled, check values for validity before setting them

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

◆ setRealWorldValueMap() [1/2]

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::setRealWorldValueMap	(	const DSRCompositeReferenceValue &	valueMap,
		const OFBool	check = `OFTrue`
	)

set the value of the 'Real World Value Map used for measurement' content item (TID 1501 - Row 9).

A measurement group is created automatically (if none is present). If the content item already exists, its value is overwritten.

Parameters

valueMap	reference to a real world value mapping object applied to the stored image pixel values before their use for a measurement
check	if enabled, check values for validity before setting them

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

◆ setRealWorldValueMap() [2/2]

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::setRealWorldValueMap	(	DcmItem &	dataset,
		const OFBool	check = `OFTrue`
	)

set the value of the 'Real World Value Map used for measurement' content item (TID 1501 - Row 9).

A measurement group is created automatically (if none is present). If the content item already exists, its value is overwritten.

Parameters

dataset	DICOM dataset from which the values for the reference to a real world value mapping object (SOP class UID and SOP instance UID) should be retrieved
check	if enabled, check values for validity before setting them

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

◆ setTimePoint()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::setTimePoint	(	const OFString &	timePoint,
		const OFBool	check = `OFTrue`
	)

set the value of the 'Time Point' content item (TID 1502 - Row 3).

A measurement group is created automatically (if none is present). If the content item already exists, its value is overwritten.

Parameters

timePoint	a short pre-defined label that is human-readable
check	if enabled, check values for validity before setting them

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

◆ setTrackingIdentifier()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::setTrackingIdentifier	(	const OFString &	trackingID,
		const OFBool	check = `OFTrue`
	)

set the value of the 'Tracking Identifier' content item (TID 1501 - Row 2).

A measurement group is created automatically (if none is present). If the content item already exists, its value is overwritten.

Parameters

trackingID	a text label used for tracking a finding or feature
check	if enabled, check values for validity before setting them

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

◆ setTrackingUniqueIdentifier()

template<typename T_Measurement , typename T_Units , typename T_Method , typename T_Derivation >

OFCondition TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >::setTrackingUniqueIdentifier	(	const OFString &	trackingUID,
		const OFBool	check = `OFTrue`
	)

set the value of the 'Tracking Unique Identifier' content item (TID 1501 - Row 3).

A measurement group is created automatically (if none is present). If the content item already exists, its value is overwritten.

Parameters

trackingUID	a unique identifier used for tracking a finding or feature (associated DICOM VR=UI)
check	if enabled, check values for validity before setting them

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/tid1501.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<typename T_Measurement, typename T_Units, typename T_Method, typename T_Derivation> class TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >

Constructor & Destructor Documentation

◆ TID1501_MeasurementGroup()

Member Function Documentation

◆ addFindingSite()

◆ addMeasurement()

◆ addOrReplaceContentItem()

◆ addQualitativeEvaluation() [1/2]

◆ addQualitativeEvaluation() [2/2]

◆ clear()

◆ createMeasurementGroup()

◆ getMeasurement()

◆ hasMeasurementGroup()

◆ hasMeasurements()

◆ hasTrackingIdentifier()

◆ hasTrackingUniqueIdentifier()

◆ isValid()

◆ setActivitySession()

◆ setFinding()

◆ setMeasurementMethod()

◆ setRealWorldValueMap() [1/2]

◆ setRealWorldValueMap() [2/2]

◆ setTimePoint()

◆ setTrackingIdentifier()

◆ setTrackingUniqueIdentifier()

template<typename T_Measurement, typename T_Units, typename T_Method, typename T_Derivation>
class TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >