DSRSubTemplate Class Reference

Class managing an SR document tree that is based on an arbitrary SR template. More...

Inheritance diagram for DSRSubTemplate:

Public Member Functions
	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...
virtual void	clear ()
	clear internal member variables. More...
virtual OFBool	isValid () const
	check whether the current internal state is valid. 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
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...

Friends
class	DSRIncludedTemplateNodeCursor

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

Class managing an SR document tree that is based on an arbitrary SR template.

This class provides a more template-specific API than the general subtree class and should be used for non-root templates only.

Note

The main focus of this class currently lies in the creation of SR documents that are based on an SR non-root template. Support for reading SR documents into the underlying structures might be added in the future.

Constructor & Destructor Documentation

DSRSubTemplate() [1/2]

DSRSubTemplate::DSRSubTemplate	(	const OFString &	templateIdentifier,
		const OFString &	mappingResource,
		const OFString &	mappingResourceUID = ""
	)

constructor

Parameters

templateIdentifier	identifier of the template
mappingResource	mapping resource that defines the template
mappingResourceUID	uniquely identifies the mapping resource (optional)

DSRSubTemplate() [2/2]

DSRSubTemplate::DSRSubTemplate

(

const DSRSubTemplate &

subTemplate

)

copy constructor.

Also see notes on DSRDocumentSubTree's copy constructor.

Parameters

subTemplate

template to be copied

Member Function Documentation

addExtraContentItem()

virtual OFCondition DSRSubTemplate::addExtraContentItem ( const E_RelationshipType  relationshipType, const E_ValueType  valueType, const E_AddMode  addMode = AM_afterCurrent  )

virtual

add extra content item to the current one (if the template is extensible).

See DSRDocumentSubTree::addContentItem() for details.

Parameters

relationshipType	relationship type of node to be added with regard to the current one
valueType	value type of node to be added
addMode	flag specifying at which position to add the new node (e.g. after or below the current node)

Returns

status, EC_Normal if successful, an error code otherwise

clear()

virtual void DSRSubTemplate::clear ( )

virtual

clear internal member variables.

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

Reimplemented from DSRTemplateCommon.

Reimplemented in TID1411_VolumetricROIMeasurements< T_Measurement, T_Units, T_Method, T_Derivation >, TID1419_ROIMeasurements_Measurement< T_Measurement, T_Units, T_Method, T_Derivation >, TID300_Measurement< T_Measurement, T_Units, T_Method, T_Derivation >, and TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >.

clone()

virtual DSRSubTemplate* DSRSubTemplate::clone ( ) const

virtual

clone this template.

Internally, the copy constructor is used, so the corresponding comments apply.

Returns

copy of this template

Reimplemented from DSRDocumentSubTree.

cloneTree()

virtual DSRDocumentSubTree* DSRSubTemplate::cloneTree ( ) const

virtual

clone the internally stored subtree of this template.

Internally, the copy constructor of DSRDocumentSubTree is used, so the corresponding comments apply. In addition, the template identification is set for the root node of the cloned subtree (if applicable).

Returns

copy of the internally stored subtree

countNodes()

size_t DSRDocumentSubTree::countNodes

count number of content items (nodes) in the document tree.

This method iterates over all nodes that are stored in the document tree. By default, included sub-templates are counted as a single node (see options).

Parameters

searchIntoSubTemplates	optional flag indicating whether to also count the content of included sub-templates (i.e. the nodes of the managed subtrees)
countIncludedTemplateNodes	optional flag indicating whether to count the DSRIncludedTemplateTreeNode instances as nodes. See includeTemplate() for details.

Returns

number of nodes, 0 if document tree is empty

getCurrentContentItem()

virtual DSRContentItem& DSRDocumentSubTree::getCurrentContentItem

get reference to current content item.

This mechanism allows to access all content items without using pointers.

Returns

reference to current content item (might be invalid)

getTree()

virtual const DSRDocumentSubTree& DSRSubTemplate::getTree ( )

virtual

get read-only access to internally stored subtree.

This method is not "const" because the template identification is set/updated automatically for the root node of the subtree (if applicable).

Returns

constant reference to internally stored subtree

gotoAnnotatedNode()

virtual size_t DSRDocumentSubTree::gotoAnnotatedNode

set internal cursor to an annotated node.

If more than one node exists with the given annotation text, the first one will be selected. Use gotoNextAnnotatedNode() in order to go to the next matching node. In contrast to gotoNamedNode(), a "deep search" is always performed.

Parameters

annotationText	annotation text of the node to be searched for
startFromRoot	flag indicating whether to start from the root node or the current one

Returns

ID of the new current node if successful, 0 otherwise

gotoNamedNode()

virtual size_t DSRDocumentSubTree::gotoNamedNode

set internal cursor to a named node.

If more than one node exists with the given concept name, the first one will be selected. Use gotoNextNamedNode() in order to go to the next matching node.

Parameters

conceptName	concept name of the node to be searched for
startFromRoot	flag indicating whether to start from the root node or the current one
searchIntoSub	flag indicating whether to search into sub-trees ("deep search") or on the current level only

Returns

ID of the new current node if successful, 0 otherwise

gotoNextAnnotatedNode()

virtual size_t DSRDocumentSubTree::gotoNextAnnotatedNode

set internal cursor to the next annotated node.

Starts from "next" node, i.e. either the first child of the current node or the first sibling following the current node.

Parameters

annotationText

annotation text of the node to be searched for

Returns

ID of the new current node if successful, 0 otherwise

gotoNextNamedNode()

virtual size_t DSRDocumentSubTree::gotoNextNamedNode

set internal cursor to the next named node.

Starts from "next" node, i.e. either the first child of the current node or the first sibling following the current node.

Parameters

conceptName	concept name of the node to be searched for
searchIntoSub	flag indicating whether to search into sub-trees ("deep search") or on the current level only

Returns

ID of the new current node if successful, 0 otherwise

insertExtraTemplate()

virtual OFCondition DSRSubTemplate::insertExtraTemplate ( const DSRSubTemplate &  subTemplate, const E_AddMode  addMode = AM_belowCurrent, const E_RelationshipType  defaultRelType = RT_unknown  )

virtual

insert tree from given extra template to internally stored subtree.

If possible, this method adds a copy of the given tree to the current content item. However, in case this template is non-extensible, an error code will be returned.

Parameters

subTemplate	template that contains the tree that should be inserted
addMode	flag specifying at which position to add the new subtree (e.g. after or below the current node)
defaultRelType	default relationship type between the top-level nodes of the given subtree and the current node. This relationship type is used if the one of a top-level node is "unknown".

Returns

status, EC_Normal if successful, an error code otherwise

isCursorValid()

virtual OFBool DSRDocumentSubTree::isCursorValid

check whether the internal cursor, which points to the current content item, is valid

Returns

OFTrue if cursor is valid, OFFalse otherwise

isRootTemplate()

OFBool DSRSubTemplate::isRootTemplate ( ) const

inline

check whether this template is a root template, i.e. describes a complete SR document tree starting from the root node

Returns

always returns OFFalse since this class handles non-root templates only

isValid()

virtual OFBool DSRSubTemplate::isValid ( ) const

virtual

check whether the current internal state is valid.

That means, whether both the internally stored subtree and the template identification are valid.

Returns

OFTrue if valid, OFFalse otherwise

Reimplemented from DSRDocumentSubTree.

Reimplemented in TID1600_ImageLibrary, TID1411_VolumetricROIMeasurements< T_Measurement, T_Units, T_Method, T_Derivation >, TID1419_ROIMeasurements_Measurement< T_Measurement, T_Units, T_Method, T_Derivation >, TID1501_MeasurementGroup< T_Measurement, T_Units, T_Method, T_Derivation >, and TID300_Measurement< T_Measurement, T_Units, T_Method, T_Derivation >.

print()

virtual OFCondition DSRDocumentSubTree::print

print current SR document tree to specified output stream

Parameters

stream	output stream
flags	optional flag used to customize the output (see DSRTypes::PF_xxx)
posCounter	optional pointer to position counter that should be used to initialize the counter for line indentation or numbering of nested content items

Returns

status, EC_Normal if successful, an error code otherwise

updateByReferenceRelationships()

virtual OFCondition DSRDocumentSubTree::updateByReferenceRelationships

update the position strings used to encode by-reference relationships (if any).

Internally, this method calls checkByReferenceRelationships() with the 'mode' parameter being DSRTypes::CM_updatePositionString. It should be called before this subtree is cloned in order to make sure that the by-reference relationships (if any) still work on the cloned subtree. This method should also be called before accessing the position string of a referenced content item, see DSRByReferenceTreeNode::getReferencedContentItem().

Parameters

updateIncludedTemplates

optional flag indicating whether to also update the subtrees managed by included sub-templates

Returns

status, EC_Normal if successful, an error code otherwise

updateTreeForOutput()

virtual void DSRSubTemplate::updateTreeForOutput ( )

protectedvirtual

update the tree for subsequent output, e.g. for being printed or added to an SR document.

This function is called automatically by the affected output methods.

Reimplemented from DSRDocumentSubTree.

writeXML()

virtual OFCondition DSRDocumentSubTree::writeXML

write current SR document tree in XML format

Parameters

stream	output stream to which the XML document is written
flags	optional flag used to customize the output (see DSRTypes::XF_xxx)

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