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

Class for content item SCOORD3D. More...

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

List of all members.

Public Member Functions

 DSRSCoord3DTreeNode (const E_RelationshipType relationshipType)
 constructor
virtual ~DSRSCoord3DTreeNode ()
 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
- Public Member Functions inherited from DSRDocumentTreeNode
 DSRDocumentTreeNode (const E_RelationshipType relationshipType, const E_ValueType valueType)
 constructor.
virtual ~DSRDocumentTreeNode ()
 destructor
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.
virtual OFCondition setConceptName (const DSRCodedEntryValue &conceptName)
 set the concept name.
const OFStringgetObservationDateTime () 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 DSRSpatialCoordinates3DValue
 DSRSpatialCoordinates3DValue ()
 default contructor
 DSRSpatialCoordinates3DValue (const DSRTypes::E_GraphicType3D graphicType)
 constructor
 DSRSpatialCoordinates3DValue (const DSRSpatialCoordinates3DValue &coordinatesValue)
 copy constructor
virtual ~DSRSpatialCoordinates3DValue ()
 destructor
DSRSpatialCoordinates3DValueoperator= (const DSRSpatialCoordinates3DValue &coordinatesValue)
 assignment operator
virtual OFCondition read (DcmItem &dataset)
 read spatial coordinates value from dataset
virtual OFCondition write (DcmItem &dataset) const
 write spatial coordinates reference value to dataset
virtual OFCondition readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor)
 read spatial coordinates value from XML document
virtual OFCondition renderHTML (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, size_t &annexNumber, const size_t flags) const
 render spatial coordinates value in HTML/XHTML format
const
DSRSpatialCoordinates3DValue
getValue () const
 get reference to spatial coordinates value
DSRTypes::E_GraphicType3D getGraphicType () const
 get current graphic type.
OFCondition setGraphicType (const DSRTypes::E_GraphicType3D graphicType)
 set current graphic type.
const OFStringgetFrameOfReferenceUID () const
 get referenced frame of reference UID
OFCondition setFrameOfReferenceUID (const OFString &frameOfReferenceUID)
 set current referenced frame of reference UID
OFCondition getValue (DSRSpatialCoordinates3DValue &coordinatesValue) const
 get copy of spatial coordinates value
OFCondition setValue (const DSRSpatialCoordinates3DValue &coordinatesValue)
 set spatial coordinates value.
DSRGraphicData3DListgetGraphicDataList ()
 get reference to graphic data list.

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
- Protected Member Functions inherited from DSRSpatialCoordinates3DValue
DSRSpatialCoordinates3DValuegetValuePtr ()
 get pointer to spatial coordinates value
OFBool checkData (const DSRTypes::E_GraphicType3D graphicType, const DSRGraphicData3DList &graphicDataList, const OFString &frameOfReferenceUID) const
 check the graphic type, graphic data and frame of reference UID for validity.

Private Member Functions

 DSRSCoord3DTreeNode (const DSRSCoord3DTreeNode &)
DSRSCoord3DTreeNodeoperator= (const DSRSCoord3DTreeNode &)

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 content item SCOORD3D.

Definition at line 46 of file dsrsc3tn.h.


Constructor & Destructor Documentation

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

clear all member variables.

Please note that the content item might become invalid afterwards.

Reimplemented from DSRDocumentTreeNode.

virtual OFBool DSRSCoord3DTreeNode::isShort ( const size_t  flags) const
virtual

check whether the content is short.

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

Parameters:
flagsflag used to customize the output (see DSRTypes::HF_xxx)
Returns:
OFTrue if the content is short, OFFalse otherwise

Reimplemented from DSRDocumentTreeNode.

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

print content item.

A typical output looks like this: has properties SCOORD3D:(,,"SCoord3D Code")= (POINT,100/100/100)

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 DSRSCoord3DTreeNode::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 DSRSCoord3DTreeNode::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 DSRSCoord3DTreeNode::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 DSRSCoord3DTreeNode::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 DSRSCoord3DTreeNode::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