DSRByReferenceTreeNode Class Reference

Class for by-reference relationships. More...

Inheritance diagram for DSRByReferenceTreeNode:


Public Member Functions
	DSRByReferenceTreeNode (const E_RelationshipType relationshipType)
	constructor
	DSRByReferenceTreeNode (const E_RelationshipType relationshipType, const size_t referencedNodeID)
	constructor
virtual	~DSRByReferenceTreeNode ()
	destructor
virtual void	clear ()
	clear all member variables.
virtual OFBool	isValid () const
	check whether the content item is valid.
virtual OFCondition	print (ostream &stream, const size_t flags) const
	print content item.
virtual OFCondition	writeXML (ostream &stream, const size_t flags, OFConsole *logStream) const
	write content item in XML format
virtual OFCondition	setConceptName (const DSRCodedEntryValue &conceptName)
	set the concept name
virtual OFCondition	setObservationDateTime (const OFString &observationDateTime)
	set observation date time
virtual OFCondition	setTemplateIdentification (const OFString &templateIdentifier, const OFString &mappingResource)
	set template identifier and mapping resource
size_t	getReferencedNodeID () const
	get ID of the referenced node
Protected Member Functions
virtual OFCondition	readContentItem (DcmItem &dataset, OFConsole *logStream)
	read content item (value) from dataset
virtual OFCondition	writeContentItem (DcmItem &dataset, OFConsole *logStream) const
	write content item (value) to dataset
virtual OFCondition	readXMLContentItem (const DSRXMLDocument &doc, DSRXMLCursor cursor)
	read content item specific XML data
virtual OFCondition	renderHTMLContentItem (ostream &docStream, ostream &annexStream, const size_t nestingLevel, size_t &annexNumber, const size_t flags, OFConsole *logStream) const
	render content item (value) in HTML format
Private Member Functions
	DSRByReferenceTreeNode (const DSRByReferenceTreeNode &)
DSRByReferenceTreeNode &	operator= (const DSRByReferenceTreeNode &)
Private Attributes
OFBool	ValidReference
	flag indicating whether the reference is valid or not (i.e. checked)
OFString	ReferencedContentItem
	position string of the referenced content item (target)
size_t	ReferencedNodeID
	node ID of the referenced content item (target)
Friends
class	DSRDocumentTree

Detailed Description

Class for by-reference relationships.

Definition at line 50 of file dsrreftn.h.

Constructor & Destructor Documentation

DSRByReferenceTreeNode::DSRByReferenceTreeNode ( const E_RelationshipType relationshipType )

constructor

Parameters:

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

DSRByReferenceTreeNode::DSRByReferenceTreeNode ( const E_RelationshipType relationshipType,

const size_t referencedNodeID

)

constructor

Parameters:

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

referencedNodeID ID of the node to be referenced

Member Function Documentation

virtual void DSRByReferenceTreeNode::clear ( ) [virtual]

clear all member variables.
Please note that the content item becomes invalid afterwards.
Reimplemented from DSRDocumentTreeNode.

size_t DSRByReferenceTreeNode::getReferencedNodeID ( ) const [inline]

get ID of the referenced node

Returns:
ID of the referenced node if valid, 0 otherwise

Definition at line 132 of file dsrreftn.h.
References ReferencedNodeID.

virtual OFBool DSRByReferenceTreeNode::isValid ( ) const [virtual]

check whether the content item is valid.
The content item is valid if the base class is valid, the concept name is empty and the reference (checked from outside this class) is valid.
Returns:
OFTrue if tree node is valid, OFFalse otherwise

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRByReferenceTreeNode::print ( ostream & stream,

const size_t flags

) const [virtual]

print content item.
A typical output looks like this: inferred from 1.2.3
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 DSRByReferenceTreeNode::readContentItem ( DcmItem & dataset,

OFConsole * logStream

) [protected, virtual]

read content item (value) from dataset

Parameters:

dataset DICOM dataset from which the content item should be read

logStream pointer to error/warning output stream (output disabled if NULL)

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

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRByReferenceTreeNode::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 DSRByReferenceTreeNode::renderHTMLContentItem ( ostream & docStream,

ostream & annexStream,

const size_t nestingLevel,

size_t & annexNumber,

const size_t flags,

OFConsole * logStream

) const [protected, virtual]

render content item (value) in HTML format

Parameters:

docStream output stream to which the main HTML document is written

annexStream output stream to which the HTML 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)

logStream pointer to error/warning output stream (output disabled if NULL)

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

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRByReferenceTreeNode::setConceptName ( const DSRCodedEntryValue & conceptName ) [virtual]

set the concept name

Parameters:

conceptName dummy parameter

Returns:
always returns EC_IllegalCall, since this content item has no concept name

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRByReferenceTreeNode::setObservationDateTime ( const OFString & observationDateTime ) [virtual]

set observation date time

Parameters:

observationDateTime dummy parameter

Returns:
always returns EC_IllegalCall, since this content item has no observation date and time (part of Document Relationship Macro)

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRByReferenceTreeNode::setTemplateIdentification ( const OFString & templateIdentifier,

const OFString & mappingResource

) [virtual]

set template identifier and mapping resource

Parameters:

templateIdentifier dummy parameter

mappingResource dummy parameter

Returns:
always returns EC_IllegalCall, since this content item has no template identification (part of Document Relationship Macro)

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRByReferenceTreeNode::writeContentItem ( DcmItem & dataset,

OFConsole * logStream

) const [protected, virtual]

write content item (value) to dataset

Parameters:

dataset DICOM dataset to which the content item should be written

logStream pointer to error/warning output stream (output disabled if NULL)

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

Reimplemented from DSRDocumentTreeNode.

virtual OFCondition DSRByReferenceTreeNode::writeXML ( ostream & stream,

const size_t flags,

OFConsole * logStream

) 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)

logStream pointer to error/warning output stream (output disabled if NULL)

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

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5

DSRByReferenceTreeNode Class Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation