OFFIS DCMTK Version 3.6.0
Public Member Functions | Protected Member Functions | Private Member Functions
DSRCodeTreeNode Class Reference

Class for content item CODE. More...

Inheritance diagram for DSRCodeTreeNode:
Inheritance graph
[legend]
Collaboration diagram for DSRCodeTreeNode:
Collaboration graph
[legend]

List of all members.

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

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

 DSRCodeTreeNode (const DSRCodeTreeNode &)
DSRCodeTreeNodeoperator= (const DSRCodeTreeNode &)

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:
relationshipTypetype 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:
streamoutput stream to which the content item should be printed
flagsflag 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) [protected, virtual]

read content item (value) from dataset

Parameters:
datasetDICOM 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 
) [protected, virtual]

read content item specific XML data

Parameters:
docdocument containing the XML file content
cursorcursor 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 [protected, virtual]

render content item (value) in HTML/XHTML format

Parameters:
docStreamoutput stream to which the main HTML/XHTML document is written
annexStreamoutput stream to which the HTML/XHTML document annex is written
nestingLevelcurrent nesting level. Used to render section headings.
annexNumberreference to the variable where the current annex number is stored. Value is increased automatically by 1 after a new entry has been added.
flagsflag 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 [protected, virtual]

write content item (value) to dataset

Parameters:
datasetDICOM 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:
streamoutput stream to which the XML document is written
flagsflag 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:


Generated on Sat Jun 11 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.7.4