DSRSCoordTreeNode Class Reference

Class for content item SCOORD. More...

Inheritance diagram for DSRSCoordTreeNode:

List of all members.

Public Member Functions
	DSRSCoordTreeNode (const E_RelationshipType relationshipType)
	constructor
virtual	~DSRSCoordTreeNode ()
	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
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
	DSRSCoordTreeNode (const DSRSCoordTreeNode &)
DSRSCoordTreeNode &	operator= (const DSRSCoordTreeNode &)

---

Detailed Description

Class for content item SCOORD.

Definition at line 46 of file dsrscotn.h.

---

Constructor & Destructor Documentation

DSRSCoordTreeNode::DSRSCoordTreeNode

(

const E_RelationshipType

relationshipType

)

constructor

Parameters:

relationshipType

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

---

Member Function Documentation

virtual void DSRSCoordTreeNode::clear

(

)

[virtual]

clear all member variables.

Please note that the content item might become invalid afterwards.

Reimplemented from DSRDocumentTreeNode.

virtual OFBool DSRSCoordTreeNode::isValid

(

)

const [virtual]

check whether the content item is valid.

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

Returns:

OFTrue if tree node is valid, OFFalse otherwise

Reimplemented from DSRDocumentTreeNode.

virtual OFBool DSRSCoordTreeNode::isShort

(

const size_t

flags

)

const [virtual]

check whether the content is short.

The method isShort() from the base class DSRSpatialCoordinatesValue is called.

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

print content item.

A typical output looks like this: has properties SCOORD:(,,"SCoord Code")= (CIRCLE,0/0,255/255)

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 DSRSCoordTreeNode::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.

virtual OFCondition DSRSCoordTreeNode::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 DSRSCoordTreeNode::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 DSRSCoordTreeNode::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 DSRSCoordTreeNode::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.

---

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

• dcmsr/include/dcmtk/dcmsr/dsrscotn.h

---

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1