OFFIS DCMTK  Version 3.6.0
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends
DSRByReferenceTreeNode Class Reference

Class for by-reference relationships. More...

Inheritance diagram for DSRByReferenceTreeNode:
[legend]
Collaboration diagram for DSRByReferenceTreeNode:
[legend]

List of all members.

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 (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
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
- 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 DSRCodedEntryValuegetConceptName () const
 get reference to the concept name
OFCondition getConceptName (DSRCodedEntryValue &conceptName) const
 get copy of the concept name.
const OFStringgetObservationDateTime () const
 get observation date time.
OFCondition getTemplateIdentification (OFString &templateIdentifier, OFString &mappingResource) const
 get 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

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

Private Member Functions

 DSRByReferenceTreeNode (const DSRByReferenceTreeNode &)
DSRByReferenceTreeNodeoperator= (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

Additional Inherited Members

- Static Protected Member Functions inherited from DSRDocumentTreeNode
static const OFStringgetRelationshipText (const E_RelationshipType relationshipType, OFString &relationshipText, const size_t flags)
 convert relationship type into a text used for HTML rendering

Detailed Description

Class for by-reference relationships.

Definition at line 46 of file dsrreftn.h.


Constructor & Destructor Documentation

DSRByReferenceTreeNode::DSRByReferenceTreeNode ( const E_RelationshipType  relationshipType)

constructor

Parameters:
relationshipTypetype 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:
relationshipTypetype of relationship to the parent/source tree node. Should not be RT_invalid or RT_isRoot.
referencedNodeIDID 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 126 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 ( STD_NAMESPACE ostream &  stream,
const size_t  flags 
) const
virtual

print content item.

A typical output looks like this: inferred from 1.2.3

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 DSRByReferenceTreeNode::readContentItem ( DcmItem dataset)
protectedvirtual

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 DSRByReferenceTreeNode::readXMLContentItem ( const DSRXMLDocument doc,
DSRXMLCursor  cursor 
)
protectedvirtual

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 DSRByReferenceTreeNode::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:
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 DSRByReferenceTreeNode::setConceptName ( const DSRCodedEntryValue conceptName)
virtual

set the concept name

Parameters:
conceptNamedummy 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:
observationDateTimedummy 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:
templateIdentifierdummy parameter
mappingResourcedummy 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) const
protectedvirtual

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 DSRByReferenceTreeNode::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 DSRDocumentTreeNode.


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


Generated on Thu May 31 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.1