Class for content item CONTAINER. More...

Inheritance diagram for DSRContainerTreeNode:

Collaboration diagram for DSRContainerTreeNode:

Public Member Functions
	DSRContainerTreeNode (const E_RelationshipType relationshipType, const E_ContinuityOfContent continuityOfContent=COC_Separate)
	constructor
virtual	~DSRContainerTreeNode ()
	destructor
virtual void	clear ()
	clear all member variables.
virtual OFBool	isValid () const
	check whether the content item is valid.
virtual OFBool	isShort (const size_t flags) const
	check whether the content is short.
virtual OFCondition	print (STD_NAMESPACE ostream &stream, const size_t flags) const
	print content item.
virtual OFCondition	writeXML (STD_NAMESPACE ostream &stream, const size_t flags) const
	write content item in XML format
virtual OFCondition	renderHTML (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, const size_t nestingLevel, size_t &annexNumber, const size_t flags) const
	render content item in HTML/XHTML format.
E_ContinuityOfContent	getContinuityOfContent () const
	get continuity of content flag.
OFCondition	setContinuityOfContent (const E_ContinuityOfContent continuityOfContent)
	set continuity of content flag.
Public Member Functions inherited from DSRDocumentTreeNode
	DSRDocumentTreeNode (const E_RelationshipType relationshipType, const E_ValueType valueType)
	constructor.
virtual	~DSRDocumentTreeNode ()
	destructor
virtual OFCondition	read (DcmItem &dataset, const DSRIODConstraintChecker *constraintChecker, const size_t flags)
	read content item from dataset.
virtual OFCondition	write (DcmItem &dataset, DcmStack *markedItems=NULL)
	write content item to dataset.
virtual OFCondition	readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor, const E_DocumentType documentType, const size_t flags)
	read general XML document tree node data
OFBool	isSigned ()
	check whether content item is digitally signed.
OFBool	isMarked () const
	check whether content item is marked.
void	setMark (const OFBool flag)
	mark/unmark the current content item.
OFBool	isReferenceTarget () const
	check whether the current content item is target of a by-reference relationship
void	setReferenceTarget (const OFBool isTarget=OFTrue)
	specify whether the current content item is target of a by-reference relationship
OFBool	hasChildNodes () const
	check whether the current content item has any children
OFBool	hasSiblingNodes () const
	check whether the current content item has any siblings
size_t	getNodeID () const
	get ID of the current tree node
E_RelationshipType	getRelationshipType () const
	get relationship type of the current content item
E_ValueType	getValueType () const
	get value type of the current content item
const DSRCodedEntryValue &	getConceptName () const
	get reference to the concept name
OFCondition	getConceptName (DSRCodedEntryValue &conceptName) const
	get copy of the concept name.
virtual OFCondition	setConceptName (const DSRCodedEntryValue &conceptName)
	set the concept name.
const OFString &	getObservationDateTime () const
	get observation date time.
virtual OFCondition	setObservationDateTime (const OFString &observationDateTime)
	set observation date time.
OFCondition	getTemplateIdentification (OFString &templateIdentifier, OFString &mappingResource) const
	get template identifier and mapping resource.
virtual OFCondition	setTemplateIdentification (const OFString &templateIdentifier, const OFString &mappingResource)
	set template identifier and mapping resource.
void	removeSignatures ()
	remove digital signatures from content item.
Public Member Functions inherited from DSRTreeNode
	DSRTreeNode ()
	default constructor
virtual	~DSRTreeNode ()
	destructor

Protected Member Functions
virtual OFCondition	readContentItem (DcmItem &dataset)
	read content item (value) from dataset
virtual OFCondition	writeContentItem (DcmItem &dataset) const
	write content item (value) to dataset
virtual OFCondition	readXMLContentItem (const DSRXMLDocument &doc, DSRXMLCursor cursor)
	read content item specific XML data
virtual OFCondition	renderHTMLContentItem (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, const size_t nestingLevel, size_t &annexNumber, const size_t flags) const
	render content item (value) in HTML/XHTML format
Protected Member Functions inherited from DSRDocumentTreeNode
DSRCodedEntryValue *	getConceptNamePtr ()
	get pointer to the concept name
OFCondition	createAndAppendNewNode (DSRDocumentTreeNode &previousNode, const E_RelationshipType relationshipType, const E_ValueType valueType, const DSRIODConstraintChecker constraintChecker=NULL)
	create a new node and append it to the current one
void	writeXMLItemStart (STD_NAMESPACE ostream &stream, const size_t flags, const OFBool closingBracket=OFTrue) const
	write common item start (XML tag)
void	writeXMLItemEnd (STD_NAMESPACE ostream &stream, const size_t flags) const
	write common item start (XML tag)
OFCondition	readSRDocumentContentModule (DcmItem &dataset, const DSRIODConstraintChecker *constraintChecker, const size_t flags)
	read SR document content module
OFCondition	writeSRDocumentContentModule (DcmItem &dataset, DcmStack *markedItems)
	write SR document content module
OFCondition	readDocumentRelationshipMacro (DcmItem &dataset, const DSRIODConstraintChecker *constraintChecker, const OFString &posString, const size_t flags)
	read document relationship macro
OFCondition	writeDocumentRelationshipMacro (DcmItem &dataset, DcmStack *markedItems)
	write document relationship macro
OFCondition	readDocumentContentMacro (DcmItem &dataset, const OFString &posString, const size_t flags)
	read document content macro
OFCondition	writeDocumentContentMacro (DcmItem &dataset) const
	write document content macro
OFCondition	readContentSequence (DcmItem &dataset, const DSRIODConstraintChecker *constraintChecker, const OFString &posString, const size_t flags)
	read content sequence
OFCondition	writeContentSequence (DcmItem &dataset, DcmStack *markedItems) const
	write content sequence
OFCondition	renderHTMLConceptName (STD_NAMESPACE ostream &docStream, const size_t flags) const
	render concept name in HTML/XHTML format.
OFCondition	renderHTMLChildNodes (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, const size_t nestingLevel, size_t &annexNumber, const size_t flags) const
	render child nodes in HTML/XHTML format

Private Member Functions
	DSRContainerTreeNode (const DSRContainerTreeNode &)
DSRContainerTreeNode &	operator= (const DSRContainerTreeNode &)

Private Attributes
E_ContinuityOfContent	ContinuityOfContent
	continuity of content flag (associated DICOM VR=CS, mandatory)

Additional Inherited Members
Static Protected Member Functions inherited from DSRDocumentTreeNode
static const OFString &	getRelationshipText (const E_RelationshipType relationshipType, OFString &relationshipText, const size_t flags)
	convert relationship type into a text used for HTML rendering

Detailed Description

Class for content item CONTAINER.

Definition at line 45 of file dsrcontn.h.

Constructor & Destructor Documentation

DSRContainerTreeNode::DSRContainerTreeNode	(	const E_RelationshipType	relationshipType,
		const E_ContinuityOfContent	continuityOfContent = `COC_Separate`
	)

constructor

Parameters:

relationshipType	type of relationship to the parent tree node. Should not be RT_invalid or RT_isRoot.
continuityOfContent	Continuity of content flag (default: separate). Should be different from COC_invalid.

Member Function Documentation

virtual void DSRContainerTreeNode::clear ( )

virtual

clear all member variables.

Please note that the content item might become invalid afterwards.

Reimplemented from DSRDocumentTreeNode.

E_ContinuityOfContent DSRContainerTreeNode::getContinuityOfContent ( ) const

inline

get continuity of content flag.

This flag specifies whether or not its contained content items (child nodes) are logically linked in a continuous textual flow, or are sparate items.

Returns:: continuity of content flag if successful, COC_invalid otherwise

Definition at line 125 of file dsrcontn.h.

References ContinuityOfContent.

virtual OFBool DSRContainerTreeNode::isShort ( const size_t flags ) const

virtual

check whether the content is short.

A container content item is defined to be never short (return always OFFalse).

Parameters:

flags flag used to customize the output (see DSRTypes::HF_xxx)

Returns:: OFTrue if the content is short, OFFalse otherwise

Reimplemented from DSRDocumentTreeNode.

virtual OFBool DSRContainerTreeNode::isValid ( ) const

virtual

check whether the content item is valid.

The content item is valid if the base class is valid, the continuity of content flag is valid, and the concept name is valid or the content item is not the root item.

Returns:: OFTrue if tree node is valid, OFFalse otherwise

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRContainerTreeNode::print	(	STD_NAMESPACE ostream &	stream,
		const size_t	flags
	)		const

virtual

print content item.

A typical output looks like this: CONTAINER:(,,"Diagnosis")=SEPARATE for the root node and contains CONTAINER:=CONTINUOUS for a "normal" content item.

Parameters:

stream	output stream to which the content item should be printed
flags	flag used to customize the output (see DSRTypes::PF_xxx)

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

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRContainerTreeNode::readContentItem ( DcmItem & dataset )

protectedvirtual

read content item (value) from dataset

Parameters:

dataset DICOM dataset from which the content item should be read

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

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRContainerTreeNode::readXMLContentItem	(	const DSRXMLDocument &	doc,
		DSRXMLCursor	cursor
	)

protectedvirtual

read content item specific XML data

Parameters:

doc	document containing the XML file content
cursor	cursor pointing to the starting node

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

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRContainerTreeNode::renderHTML	(	STD_NAMESPACE ostream &	docStream,
		STD_NAMESPACE ostream &	annexStream,
		const size_t	nestingLevel,
		size_t &	annexNumber,
		const size_t	flags
	)		const

virtual

render content item in HTML/XHTML format.

After rendering the current content item all child nodes (if any) are also rendered (see renderHTMLChildNodes() for details). This method overwrites the one specified in base class DSRDocumentTree since the rendering of the child nodes depends on the value of the flag 'ContinuityOfContent'.

Parameters:

docStream	output stream to which the main HTML/XHTML document is written
annexStream	output stream to which the HTML/XHTML document annex is written
nestingLevel	current nesting level. Used to render section headings.
annexNumber	reference to the variable where the current annex number is stored. Value is increased automatically by 1 after a new entry has been added.
flags	flag used to customize the output (see DSRTypes::HF_xxx)

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

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRContainerTreeNode::renderHTMLContentItem	(	STD_NAMESPACE ostream &	docStream,
		STD_NAMESPACE ostream &	annexStream,
		const size_t	nestingLevel,
		size_t &	annexNumber,
		const size_t	flags
	)		const

protectedvirtual

render content item (value) in HTML/XHTML format

Parameters:

docStream	output stream to which the main HTML/XHTML document is written
annexStream	output stream to which the HTML/XHTML document annex is written
nestingLevel	current nesting level. Used to render section headings.
annexNumber	reference to the variable where the current annex number is stored. Value is increased automatically by 1 after a new entry has been added.
flags	flag used to customize the output (see DSRTypes::HF_xxx)

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

Reimplemented from DSRDocumentTreeNode.

OFCondition DSRContainerTreeNode::setContinuityOfContent ( const E_ContinuityOfContent continuityOfContent )

set continuity of content flag.

This flag specifies whether or not its contained content items (child nodes) are logically linked in a continuous textual flow, or are sparate items.

Parameters:

continuityOfContent value to be set (should be different from COC_onvalid)

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

virtual OFCondition DSRContainerTreeNode::writeContentItem ( DcmItem & dataset ) const

protectedvirtual

write content item (value) to dataset

Parameters:

dataset DICOM dataset to which the content item should be written

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

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRContainerTreeNode::writeXML	(	STD_NAMESPACE ostream &	stream,
		const size_t	flags
	)		const

virtual

write content item in XML format

Parameters:

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

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

Reimplemented from DSRDocumentTreeNode.

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

dcmsr/include/dcmtk/dcmsr/dsrcontn.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation