DSRTimeTreeNode Class Reference

Class for content item TIME. More...

Inheritance diagram for DSRTimeTreeNode:

List of all members.

Public Member Functions
	DSRTimeTreeNode (const E_RelationshipType relationshipType)
	constructor
	DSRTimeTreeNode (const E_RelationshipType relationshipType, const OFString &stringValue)
	constructor
virtual	~DSRTimeTreeNode ()
	destructor
virtual void	clear ()
	clear all member variables.
virtual OFBool	isValid () const
	check whether the content item is valid.
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.
Static Public Member Functions
static OFString &	getValueFromXMLNodeContent (const DSRXMLDocument &doc, DSRXMLCursor cursor, OFString &timeValue, const OFBool clearString=OFTrue)
	get DICOM time value from given XML element.
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
Private Member Functions
	DSRTimeTreeNode (const DSRTimeTreeNode &)
DSRTimeTreeNode &	operator= (const DSRTimeTreeNode &)

---

Detailed Description

Class for content item TIME.

---

Constructor & Destructor Documentation

DSRTimeTreeNode::DSRTimeTreeNode

(

const E_RelationshipType

relationshipType

)

constructor

Parameters:

relationshipType

type of relationship to the parent tree node. Should not be RT_invalid or RT_isRoot.

DSRTimeTreeNode::DSRTimeTreeNode	(	const E_RelationshipType	relationshipType,
		const OFString &	stringValue
	)

constructor

Parameters:

relationshipType	type of relationship to the parent tree node. Should not be RT_invalid or RT_isRoot.
stringValue	initial string value to be set

---

Member Function Documentation

virtual void DSRTimeTreeNode::clear

(

)

[virtual]

clear all member variables.

Please note that the content item might become invalid afterwards.

Reimplemented from DSRDocumentTreeNode.

static OFString& DSRTimeTreeNode::getValueFromXMLNodeContent	(	const DSRXMLDocument &	doc,
		DSRXMLCursor	cursor,
		OFString &	timeValue,
		const OFBool	clearString = OFTrue
	)		[static]

get DICOM time value from given XML element.

The DICOM Time (TM) value is expected to be stored in ISO format as created by writeXML().

Parameters:

doc	document containing the XML file content
cursor	cursor pointing to the corresponding node
timeValue	reference to string object in which the value should be stored
clearString	flag specifying whether to clear the 'dateTimeValue' or not

Returns:

reference to string object (might be empty)

virtual OFBool DSRTimeTreeNode::isValid

(

)

const [virtual]

check whether the content item is valid.

The content item is valid if the two base classes and the concept name are valid.

Returns:

OFTrue if tree node is valid, OFFalse otherwise

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRTimeTreeNode::print	(	STD_NAMESPACE ostream &	stream,
		const size_t	flags
	)		const [virtual]

print content item.

A typical output looks like this: contains TIME:(,,"Code")="12000000"

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 DSRTimeTreeNode::readContentItem

(

DcmItem &

dataset

)

[protected, virtual]

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 DSRTimeTreeNode::readXMLContentItem	(	const DSRXMLDocument &	doc,
		DSRXMLCursor	cursor
	)		[protected, virtual]

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 DSRTimeTreeNode::renderHTMLContentItem	(	STD_NAMESPACE ostream &	docStream,
		STD_NAMESPACE ostream &	annexStream,
		const size_t	nestingLevel,
		size_t &	annexNumber,
		const size_t	flags
	)		const [protected, virtual]

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.

virtual OFCondition DSRTimeTreeNode::writeContentItem

(

DcmItem &

dataset

)

const [protected, virtual]

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 DSRTimeTreeNode::writeXML	(	STD_NAMESPACE ostream &	stream,
		const size_t	flags
	)		const [virtual]

write content item in XML format.

Uses ISO formatted time value.

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