Class for content item CODE. More...

Inheritance diagram for DSRCodeTreeNode:

Collaboration diagram for DSRCodeTreeNode:

Public Member Functions
	DSRCodeTreeNode (const E_RelationshipType relationshipType)
	constructor
virtual	~DSRCodeTreeNode ()
	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
Public Member Functions inherited from DSRDocumentTreeNode
	DSRDocumentTreeNode (const E_RelationshipType relationshipType, const E_ValueType valueType)
	constructor.
virtual	~DSRDocumentTreeNode ()
	destructor
virtual OFBool	isShort (const size_t flags) const
	check whether the content is short.
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
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.
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
Public Member Functions inherited from DSRCodedEntryValue
	DSRCodedEntryValue ()
	default contructor
	DSRCodedEntryValue (const OFString &codeValue, const OFString &codingSchemeDesignator, const OFString &codeMeaning)
	constructor.
	DSRCodedEntryValue (const OFString &codeValue, const OFString &codingSchemeDesignator, const OFString &codingSchemeVersion, const OFString &codeMeaning)
	constructor.
	DSRCodedEntryValue (const DSRCodedEntryValue &codedEntryValue)
	copy constructor
virtual	~DSRCodedEntryValue ()
	destructor
DSRCodedEntryValue &	operator= (const DSRCodedEntryValue &codedEntryValue)
	assignment operator
OFBool	operator== (const DSRCodedEntryValue &codedEntryValue) const
	comparison operator.
virtual OFBool	isEmpty () const
	check whether the current code is empty.
void	print (STD_NAMESPACE ostream &stream, const OFBool printCodeValue=OFTrue, const OFBool printInvalid=OFFalse) const
	print code.
OFCondition	readSequence (DcmItem &dataset, const DcmTagKey &tagKey, const OFString &type)
	read code sequence from dataset.
OFCondition	writeSequence (DcmItem &dataset, const DcmTagKey &tagKey) const
	write code sequence to dataset
OFCondition	readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor)
	read code from XML document
OFCondition	renderHTML (STD_NAMESPACE ostream &stream, const size_t flags, const OFBool fullCode=OFTrue, const OFBool valueFirst=OFFalse) const
	render code in HTML/XHTML format
const DSRCodedEntryValue &	getValue () const
	get reference to code value
OFCondition	getValue (DSRCodedEntryValue &codedEntryValue) const
	get copy of code value
const OFString &	getCodeValue () const
	get code value.
const OFString &	getCodingSchemeDesignator () const
	get coding scheme designator.
const OFString &	getCodingSchemeVersion () const
	get coding scheme version.
const OFString &	getCodeMeaning () const
	get code meaning.
OFCondition	setValue (const DSRCodedEntryValue &codedEntryValue)
	set code value.
OFCondition	setCode (const OFString &codeValue, const OFString &codingSchemeDesignator, const OFString &codeMeaning)
	set code value.
OFCondition	setCode (const OFString &codeValue, const OFString &codingSchemeDesignator, const OFString &codingSchemeVersion, const OFString &codeMeaning)
	set code value.

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
Protected Member Functions inherited from DSRCodedEntryValue
DSRCodedEntryValue *	getValuePtr ()
	get pointer to code value
OFCondition	readItem (DcmItem &dataset, const char *moduleName=NULL)
	read code from dataset
OFCondition	writeItem (DcmItem &dataset) const
	write code to dataset
OFBool	checkCode (const OFString &codeValue, const OFString &codingSchemeDesignator, const OFString &codeMeaning) const
	check the specified code for validity.

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

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 CODE.

Definition at line 46 of file dsrcodtn.h.

Constructor & Destructor Documentation

DSRCodeTreeNode::DSRCodeTreeNode ( 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 DSRCodeTreeNode::clear ( )

virtual

clear all member variables.

Please note that the content item might become invalid afterwards.

Reimplemented from DSRCodedEntryValue.

virtual OFBool DSRCodeTreeNode::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 DSRCodedEntryValue.

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

virtual

print content item.

A typical output looks like this: has concept mod CODE:(,,"Code")=(1234,99_OFFIS_DCMTK, "Code Meaning")

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

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

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

dcmsr/include/dcmtk/dcmsr/dsrcodtn.h

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation