Implementation of DCMR Template: TID 1500 - Measurement Report (and included templates 1204, 1001, 1600, 1411, 1501). More...

Inheritance diagram for TID1500_MeasurementReport:

Public Member Functions
	TID1500_MeasurementReport (const CID7021_MeasurementReportDocumentTitles &title=CID7021_MeasurementReportDocumentTitles(), const OFBool check=OFTrue)
	(default) constructor. More...

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

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

OFBool	hasProcedureReported () const
	check whether there are any 'Procedure reported' content items (TID 1500 - Row 4) in this measurement report. More...

OFBool	hasImagingMeasurements (const OFBool checkChildren=OFFalse) const
	check whether there is an 'Imaging Measurements' content item (TID 1500 - Row 6) in this measurement report. More...

OFBool	hasVolumetricROIMeasurements (const OFBool checkChildren=OFFalse) const
	check whether there is an included 'Volumetric ROI Measurements' template (TID 1500 - Row 8) in this measurement report. More...

OFBool	hasIndividualMeasurements (const OFBool checkChildren=OFFalse) const
	check whether there is an included 'Measurement Group' template (TID 1500 - Row 9) in this measurement report. More...

OFBool	hasQualitativeEvaluations (const OFBool checkChildren=OFFalse) const
	check whether there is an 'Qualitative Evaluations' content item (TID 1500 - Row 12) in this measurement report More...

TID1204_LanguageOfContentItemAndDescendants &	getLanguage () const
	get language of this report as defined by TID 1204 (Language of Content Item and Descendants). More...

TID1001_ObservationContext &	getObservationContext () const
	get observation context of this report as defined by TID 1001 (Observation Context). More...

TID1600_ImageLibrary &	getImageLibrary () const
	get image library of this report as defined by TID 1600 (Image Library). More...

TID1411_Measurements &	getVolumetricROIMeasurements () const
	get volumetric ROI measurements of this report as defined by TID 1411 (Volumetric ROI Measurements), i.e. the current instance of TID 1500 - Row 8. More...

TID1501_Measurements &	getIndividualMeasurements () const
	get individual measurements of this report as defined by TID 1501 (Measurement Group), i.e. the current instance of TID 1500 - Row 9. More...

OFCondition	getDocumentTitle (DSRCodedEntryValue &titleCode)
	get document title of this report, i.e. the concept name of the root node More...

OFCondition	createNewMeasurementReport (const CID7021_MeasurementReportDocumentTitles &title, const OFBool check=OFTrue)
	create a new measurement report. More...

OFCondition	setLanguage (const CID5000_Languages &language, const CID5001_Countries &country=CID5001_Countries(), const OFBool check=OFTrue)
	set language of this report as defined by TID 1204 (Language of Content Item and Descendants) More...

OFCondition	addProcedureReported (const CID100_QuantitativeDiagnosticImagingProcedures &procedure, const OFBool check=OFTrue)
	add the imaging procedure whose results are reported (TID 1500 - Row 4). More...

OFCondition	addVolumetricROIMeasurements (const OFBool checkEmpty=OFTrue)
	create another instance of TID 1411 (Volumetric ROI Measurements) and add it as an included template to this report (TID 1500 - Row 8). More...

OFCondition	addIndividualMeasurements (const OFBool checkEmpty=OFTrue)
	create another instance of TID 1501 (Measurement Group) and add it as an included template to this report (TID 1500 - Row 9). More...

OFCondition	addQualitativeEvaluation (const DSRCodedEntryValue &conceptName, const DSRCodedEntryValue &codeValue, const OFBool check=OFTrue)
	add a qualitative evaluation related to the entire subject of the report as a coded entry (TID 1500 - Row 13). More...

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

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

	DSRRootTemplate (const DSRRootTemplate &rootTemplate)
	copy constructor. More...

virtual	~DSRRootTemplate ()
	destructor

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

virtual DSRDocumentTree *	cloneTree () const
	clone the internally stored document tree 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 DSRDocumentTree &	getTree ()
	get read-only access to internally stored document tree. 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 document tree. More...

E_DocumentType	getDocumentType () const
	get document type More...

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

virtual OFCondition	print (STD_NAMESPACE ostream &stream, const size_t flags, const DSRPositionCounter *posCounter)
	print current SR document tree to specified output stream. 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	createMeasurementReport (const CID7021_MeasurementReportDocumentTitles &title, const OFBool check)
	create the mandatory (and other supported) content items of this template, i.e. TID 1500 - Row 1 to 6 and 8. More...

OFCondition	createQualitativeEvaluations ()
	create the 'Qualitative Evaluations' content item (TID 1500 - Row 12) if not existing yet More...

Protected Member Functions inherited from DSRRootTemplate
virtual OFCondition	read (DcmItem &dataset, const E_DocumentType documentType, const size_t flags=0)
	read SR document tree from DICOM dataset More...

virtual OFCondition	readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags)
	read XML document tree More...

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 DSRDocumentTree
void	swap (DSRDocumentTree &tree)
	fast, non-throwing swap function. More...

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

	DSRDocumentTree (const E_DocumentType documentType)
	constructor More...

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

virtual	~DSRDocumentTree ()
	destructor

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

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

virtual OFCondition	write (DcmItem &dataset, DcmStack *markedItems=NULL)
	write current SR document tree to DICOM dataset. More...

virtual OFCondition	renderHTML (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, const size_t flags=0)
	render current SR document tree in HTML/XHTML format. More...

E_DocumentType	getDocumentType () const
	get document type More...

virtual OFCondition	changeDocumentType (const E_DocumentType documentType, const OFBool deleteTree)
	change document type. 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	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	checkDocumentTreeConstraints (DSRIODConstraintChecker *checker)
	check whether the document tree complies with the constraints of the given checker. More...

void	unmarkAllContentItems ()
	unmark all content items in the document tree. More...

void	removeSignatures ()
	remove digital signatures from the document tree. 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	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	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 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

Implementation of DCMR Template: TID 1500 - Measurement Report (and included templates 1204, 1001, 1600, 1411, 1501).

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

Note: Please note that currently only the mandatory and some optional/conditional content items and included templates are supported.

Constructor & Destructor Documentation

◆ TID1500_MeasurementReport()

TID1500_MeasurementReport::TID1500_MeasurementReport	(	const CID7021_MeasurementReportDocumentTitles &	title = `CID7021_MeasurementReportDocumentTitles()`,
		const OFBool	check = `OFTrue`
	)

(default) constructor.

Also creates an initial, almost empty measurement report by calling createNewMeasurementReport(), but only if a non-empty 'title' is passed.

Parameters

title	optional document title to be set (from CID 7021 - Measurement Report Document Titles), i.e. the concept name of the root node
check	if enabled, check value for validity before setting it

Member Function Documentation

◆ addIndividualMeasurements()

OFCondition TID1500_MeasurementReport::addIndividualMeasurements ( const OFBool checkEmpty = OFTrue )

create another instance of TID 1501 (Measurement Group) and add it as an included template to this report (TID 1500 - Row 9).

A first instance of TID 1501 is created and added by calling createNewMeasurementReport(). Access to the current instance is available through getIndividualMeasurements(). Please note that a new instance of TID 1501 is only added if the current one is not empty!

Parameters

checkEmpty by default, it is checked whether the current instance of TID 1501 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.

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

◆ addProcedureReported()

OFCondition TID1500_MeasurementReport::addProcedureReported	(	const CID100_QuantitativeDiagnosticImagingProcedures &	procedure,
		const OFBool	check = `OFTrue`
	)

add the imaging procedure whose results are reported (TID 1500 - Row 4).

There should be at least a single instance of the associated content item.

Parameters

procedure	coded entry that describes the imaging procedure to be added (from CID 100 - Quantitative Diagnostic Imaging Procedures)
check	if enabled, check value for validity before setting it

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

◆ addQualitativeEvaluation() [1/2]

OFCondition TID1500_MeasurementReport::addQualitativeEvaluation	(	const DSRCodedEntryValue &	conceptName,
		const DSRCodedEntryValue &	codeValue,
		const OFBool	check = `OFTrue`
	)

add a qualitative evaluation related to the entire subject of the report as a coded entry (TID 1500 - Row 13).

The higher-level CONTAINER (Row 12) 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]

OFCondition TID1500_MeasurementReport::addQualitativeEvaluation	(	const DSRCodedEntryValue &	conceptName,
		const OFString &	stringValue,
		const OFBool	check = `OFTrue`
	)

add a qualitative evaluation related to the entire subject of the report in text form (TID 1500 - Row 14).

The higher-level CONTAINER (Row 12) 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

◆ addVolumetricROIMeasurements()

OFCondition TID1500_MeasurementReport::addVolumetricROIMeasurements ( const OFBool checkEmpty = OFTrue )

create another instance of TID 1411 (Volumetric ROI Measurements) and add it as an included template to this report (TID 1500 - Row 8).

A first instance of TID 1411 is created and added by calling createNewMeasurementReport(). Access to the current instance is available through getVolumetricROIMeasurements().

Parameters

checkEmpty by default, it is checked whether the current instance of TID 1411 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.

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

◆ clear()

virtual void TID1500_MeasurementReport::clear ( )

virtual

clear internal member variables.

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

Reimplemented from DSRRootTemplate.

◆ createMeasurementReport()

OFCondition TID1500_MeasurementReport::createMeasurementReport	(	const CID7021_MeasurementReportDocumentTitles &	title,
		const OFBool	check
	)

protected

create the mandatory (and other supported) content items of this template, i.e. TID 1500 - Row 1 to 6 and 8.

It is expected that the tree is currently empty.

Parameters

title	coded entry that specifies the document title to be set
check	if enabled, check value for validity before setting it

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

◆ createNewMeasurementReport()

OFCondition TID1500_MeasurementReport::createNewMeasurementReport	(	const CID7021_MeasurementReportDocumentTitles &	title,
		const OFBool	check = `OFTrue`
	)

create a new measurement report.

Clear the report and create the mandatory (and other supported) content items of this template, i.e. TID 1500 - Row 1 to 6 and 8 to 9.

Parameters

title	document title to be set (from CID 7021 - Measurement Report Document Titles), i.e. the concept name of the root node
check	if enabled, check value for validity before setting it

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

◆ createQualitativeEvaluations()

OFCondition TID1500_MeasurementReport::createQualitativeEvaluations ( )

protected

create the 'Qualitative Evaluations' content item (TID 1500 - Row 12) if not existing yet

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

◆ getDocumentTitle()

OFCondition TID1500_MeasurementReport::getDocumentTitle ( DSRCodedEntryValue & titleCode )

get document title of this report, i.e. the concept name of the root node

Parameters

titleCode coded entry that specifies the document title of this report

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

◆ getImageLibrary()

TID1600_ImageLibrary& TID1500_MeasurementReport::getImageLibrary ( ) const

inline

get image library of this report as defined by TID 1600 (Image Library).

This included template is mandatory, i.e. should not be empty.

Returns: reference to internally managed SR template

◆ getIndividualMeasurements()

TID1501_Measurements& TID1500_MeasurementReport::getIndividualMeasurements ( ) const

inline

get individual measurements of this report as defined by TID 1501 (Measurement Group), i.e. the current instance of TID 1500 - Row 9.

This included template is optional, i.e. might be empty (but not absent). Further instances can be added by calling addIndividualMeasurements().

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

◆ getLanguage()

TID1204_LanguageOfContentItemAndDescendants& TID1500_MeasurementReport::getLanguage ( ) const

inline

get language of this report as defined by TID 1204 (Language of Content Item and Descendants).

This included template is mandatory, i.e. should not be empty.

Returns: reference to internally managed SR template

◆ getObservationContext()

TID1001_ObservationContext& TID1500_MeasurementReport::getObservationContext ( ) const

inline

get observation context of this report as defined by TID 1001 (Observation Context).

This included template is mandatory, i.e. should not be empty.

Returns: reference to internally managed SR template

◆ getVolumetricROIMeasurements()

TID1411_Measurements& TID1500_MeasurementReport::getVolumetricROIMeasurements ( ) const

inline

get volumetric ROI measurements of this report as defined by TID 1411 (Volumetric ROI Measurements), i.e. the current instance of TID 1500 - Row 8.

This included template is optional, i.e. might be empty (but not absent). Further instances can be added by calling addVolumetricROIMeasurements().

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

◆ hasImagingMeasurements()

OFBool TID1500_MeasurementReport::hasImagingMeasurements ( const OFBool checkChildren = OFFalse ) const

check whether there is an 'Imaging Measurements' content item (TID 1500 - Row 6) in this measurement report.

Initially, this conditional content item is created by the constructor of this class. After clear() has been called or no document title is passed to the constructor, it can be created again by calling createNewMeasurementReport().

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 imaging measurements are present, OFFalse otherwise

◆ hasIndividualMeasurements()

OFBool TID1500_MeasurementReport::hasIndividualMeasurements ( const OFBool checkChildren = OFFalse ) const

check whether there is an included 'Measurement Group' template (TID 1500 - Row 9) in this measurement report.

Initially, this optional sub-template is created and included by the constructor of this class. After clear() has been called or no document title is passed to the constructor, it can be created again by calling createNewMeasurementReport().

Parameters

checkChildren optional flag indicating whether to also check for any children, i.e. whether the respective sub-template has any content (child nodes). By default, the presence of the "included template" content item is checked only.

Returns: OFTrue if volumetric ROI measurements are present, OFFalse otherwise

◆ hasProcedureReported()

OFBool TID1500_MeasurementReport::hasProcedureReported ( ) const

check whether there are any 'Procedure reported' content items (TID 1500 - Row 4) in this measurement report.

This content item is mandatory, i.e. one or more instances of the associated content item should be present.

Returns: OFTrue if at least one procedure reported is present, OFFalse otherwise

◆ hasQualitativeEvaluations()

OFBool TID1500_MeasurementReport::hasQualitativeEvaluations ( const OFBool checkChildren = OFFalse ) const

check whether there is an 'Qualitative Evaluations' content item (TID 1500 - Row 12) in this measurement report

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 qualitative evaluations are present, OFFalse otherwise

◆ hasVolumetricROIMeasurements()

OFBool TID1500_MeasurementReport::hasVolumetricROIMeasurements ( const OFBool checkChildren = OFFalse ) const

check whether there is an included 'Volumetric ROI Measurements' template (TID 1500 - Row 8) in this measurement report.

Initially, this optional sub-template is created and included by the constructor of this class. After clear() has been called or no document title is passed to the constructor, it can be created again by calling createNewMeasurementReport().

Parameters

checkChildren optional flag indicating whether to also check for any children, i.e. whether the respective sub-template has any content (child nodes). By default, the presence of the "included template" content item is checked only.

Returns: OFTrue if volumetric ROI measurements are present, OFFalse otherwise

◆ isValid()

virtual OFBool TID1500_MeasurementReport::isValid ( ) const

virtual

check whether the current internal state is valid.

That means, check whether the base class is valid, the mandatory included templates TID 1204, 1001 and 1600 are valid, and whether hasProcedureReported() as well as hasImagingMeasurements() or hasQualitativeEvaluations() return true. In addition, each of the included templates TID 1411 and 1501 should either be empty or valid.

Returns: OFTrue if valid, OFFalse otherwise

Reimplemented from DSRRootTemplate.

◆ setLanguage()

OFCondition TID1500_MeasurementReport::setLanguage	(	const CID5000_Languages &	language,
		const CID5001_Countries &	country = `CID5001_Countries()`,
		const OFBool	check = `OFTrue`
	)

set language of this report as defined by TID 1204 (Language of Content Item and Descendants)

Parameters

language	language of the report, being a language that is primarily used for human communication (from CID 5000 - Languages)
country	coded entry that describes the country-specific variant of 'language' (optional, from CID 5001 - Countries)
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/tid1500.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TID1500_MeasurementReport()

Member Function Documentation

◆ addIndividualMeasurements()

◆ addProcedureReported()

◆ addQualitativeEvaluation() [1/2]

◆ addQualitativeEvaluation() [2/2]

◆ addVolumetricROIMeasurements()

◆ clear()

◆ createMeasurementReport()

◆ createNewMeasurementReport()

◆ createQualitativeEvaluations()

◆ getDocumentTitle()

◆ getImageLibrary()

◆ getIndividualMeasurements()

◆ getLanguage()

◆ getObservationContext()

◆ getVolumetricROIMeasurements()

◆ hasImagingMeasurements()

◆ hasIndividualMeasurements()

◆ hasProcedureReported()

◆ hasQualitativeEvaluations()

◆ hasVolumetricROIMeasurements()

◆ isValid()

◆ setLanguage()