Interface class for content items. More...

Inheritance diagram for DSRContentItem:

Public Member Functions
virtual	~DSRContentItem ()
	destructor
OFBool	isValid () const
	check for validity/completeness.
OFBool	isMarked () const
	check for mark flag.
void	setMark (const OFBool flag)
	mark/unmark item.
E_ValueType	getValueType () const
	get value type.
E_RelationshipType	getRelationshipType () const
	get relationship type.
size_t	getReferencedNodeID () const
	get ID of the referenced node.
const OFString &	getStringValue () const
	get string value.
OFCondition	setStringValue (const OFString &stringValue)
	set string value.
DSRCodedEntryValue *	getCodeValuePtr ()
	get pointer to code value.
const DSRCodedEntryValue &	getCodeValue () const
	get code value.
OFCondition	getCodeValue (DSRCodedEntryValue &codeValue) const
	get copy of code value.
OFCondition	setCodeValue (const DSRCodedEntryValue &codeValue)
	set code value.
DSRNumericMeasurementValue *	getNumericValuePtr ()
	get pointer to numeric value.
const DSRNumericMeasurementValue &	getNumericValue () const
	get numeric value.
OFCondition	getNumericValue (DSRNumericMeasurementValue &numericValue) const
	get copy of numeric value.
OFCondition	setNumericValue (const DSRNumericMeasurementValue &numericValue)
	set numeric value.
DSRSpatialCoordinatesValue *	getSpatialCoordinatesPtr ()
	get pointer to spatial coordinates.
const DSRSpatialCoordinatesValue &	getSpatialCoordinates () const
	get spatial coordinates.
OFCondition	getSpatialCoordinates (DSRSpatialCoordinatesValue &coordinatesValue) const
	get copy of spatial coordinates.
OFCondition	setSpatialCoordinates (const DSRSpatialCoordinatesValue &coordinatesValue)
	set spatial coordinates.
DSRSpatialCoordinates3DValue *	getSpatialCoordinates3DPtr ()
	get pointer to spatial coordinates 3D.
const DSRSpatialCoordinates3DValue &	getSpatialCoordinates3D () const
	get spatial coordinates 3D.
OFCondition	getSpatialCoordinates3D (DSRSpatialCoordinates3DValue &coordinatesValue) const
	get copy of spatial coordinates 3D.
OFCondition	setSpatialCoordinates3D (const DSRSpatialCoordinates3DValue &coordinatesValue)
	set spatial coordinates 3D.
DSRTemporalCoordinatesValue *	getTemporalCoordinatesPtr ()
	get pointer to temporal coordinates.
const DSRTemporalCoordinatesValue &	getTemporalCoordinates () const
	get temporal coordinates.
OFCondition	getTemporalCoordinates (DSRTemporalCoordinatesValue &coordinatesValue) const
	get copy of temporal coordinates.
OFCondition	setTemporalCoordinates (const DSRTemporalCoordinatesValue &coordinatesValue)
	set temporal coordinates.
DSRCompositeReferenceValue *	getCompositeReferencePtr ()
	get pointer to composite reference.
const DSRCompositeReferenceValue &	getCompositeReference () const
	get composite reference.
OFCondition	getCompositeReference (DSRCompositeReferenceValue &referenceValue) const
	get copy of composite reference.
OFCondition	setCompositeReference (const DSRCompositeReferenceValue &referenceValue)
	set composite reference.
DSRImageReferenceValue *	getImageReferencePtr ()
	get pointer to image reference.
const DSRImageReferenceValue &	getImageReference () const
	get image reference.
OFCondition	getImageReference (DSRImageReferenceValue &referenceValue) const
	get copy of image reference.
OFCondition	setImageReference (const DSRImageReferenceValue &referenceValue)
	set image reference.
DSRWaveformReferenceValue *	getWaveformReferencePtr ()
	get pointer to waveform reference.
const DSRWaveformReferenceValue &	getWaveformReference () const
	get waveform reference.
OFCondition	getWaveformReference (DSRWaveformReferenceValue &referenceValue) const
	get copy of waveform reference.
OFCondition	setWaveformReference (const DSRWaveformReferenceValue &referenceValue)
	set waveform reference.
E_ContinuityOfContent	getContinuityOfContent () const
	get continuity of content flag.
OFCondition	setContinuityOfContent (const E_ContinuityOfContent continuityOfContent)
	set continuity of content flag.
DSRCodedEntryValue *	getConceptNamePtr ()
	get pointer to concept name.
const DSRCodedEntryValue &	getConceptName () const
	get concept name.
OFCondition	getConceptName (DSRCodedEntryValue &conceptName) const
	get copy of concept name.
OFCondition	setConceptName (const DSRCodedEntryValue &conceptName)
	set concept name.
const OFString &	getObservationDateTime () const
	get observation date time.
OFCondition	setObservationDateTime (const OFString &observationDateTime)
	set observation date time.
const OFString &	getObservationUID () const
	get observation unique identifier.
OFCondition	setObservationUID (const OFString &observationUID)
	set observation unique identifier.
OFCondition	getTemplateIdentification (OFString &templateIdentifier, OFString &mappingResource) const
	get template identifier and mapping resource.
OFCondition	setTemplateIdentification (const OFString &templateIdentifier, const OFString &mappingResource)
	set template identifier and mapping resource.
Protected Member Functions
	DSRContentItem ()
	default constructor (protected)
void	setTreeNode (DSRDocumentTreeNode *node)
	set internal tree node pointer (protected)
Private Member Functions
	DSRContentItem (const DSRContentItem &)
DSRContentItem &	operator= (const DSRContentItem &)
Private Attributes
DSRDocumentTreeNode *	TreeNode
	internal tree node pointer (current conten item)
const DSRNumericMeasurementValue	EmptyNumericMeasurement
	empty numeric measurement value.
Static Private Attributes
static const OFString	EmptyString
	empty string value. Used as default return value for getStringValue()
static const DSRCodedEntryValue	EmptyCodedEntry
	empty coded entry value. Used as default return value for getCodeValue() and getConceptName()
static const DSRSpatialCoordinatesValue	EmptySpatialCoordinates
	empty spatial coordinates value. Used as default return value for getSpatialCoordinates()
static const DSRSpatialCoordinates3DValue	EmptySpatialCoordinates3D
	empty spatial coordinates 3D value. Used as default return value for getSpatialCoordinates3D()
static const DSRTemporalCoordinatesValue	EmptyTemporalCoordinates
	empty temporal coordinates value. Used as default return value for getTemporalCoordinates()
static const DSRCompositeReferenceValue	EmptyCompositeReference
	empty composite reference value. Used as default return value for getCompositeReference()
static const DSRImageReferenceValue	EmptyImageReference
	empty image reference value. Used as default return value for getImageReference()
static const DSRWaveformReferenceValue	EmptyWaveformReference
	empty waveform reference value. Used as default return value for getWaveformReference()
Friends
class	DSRDocumentTree

Detailed Description

Interface class for content items.

This class allows to access the document tree nodes without using any pointers.

Member Function Documentation

const DSRCodedEntryValue& DSRContentItem::getCodeValue ( ) const

get code value.

Applicable to: CODE

Returns:: coded entry value of current content item if valid, EmptyCodedEntry otherwise

OFCondition DSRContentItem::getCodeValue ( DSRCodedEntryValue & codeValue ) const

get copy of code value.

Applicable to: CODE

Parameters:

codeValue variable where the copy should be stored

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

DSRCodedEntryValue* DSRContentItem::getCodeValuePtr ( )

get pointer to code value.

Applicable to: CODE

Returns:: pointer to code value of current content item if valid, NULL otherwise

const DSRCompositeReferenceValue& DSRContentItem::getCompositeReference ( ) const

get composite reference.

Applicable to: COMPOSITE

Returns:: reference value of current content item if valid, EmptyReference otherwise

OFCondition DSRContentItem::getCompositeReference ( DSRCompositeReferenceValue & referenceValue ) const

get copy of composite reference.

Applicable to: COMPOSITE

Parameters:

referenceValue variable where the copy should be stored (cleared if an error occurs)

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

DSRCompositeReferenceValue* DSRContentItem::getCompositeReferencePtr ( )

get pointer to composite reference.

Applicable to: COMPOSITE

Returns:: pointer to reference value of current content item if valid, NULL otherwise

const DSRCodedEntryValue& DSRContentItem::getConceptName ( ) const

get concept name.

Code describing the concept represented by this content item. Also conveys the value of document title and section headings in documents. Applicable to all content items (by-value only).

Returns:: concept name value of current content item if valid, EmptyCodedEntry otherwise

OFCondition DSRContentItem::getConceptName ( DSRCodedEntryValue & conceptName ) const

get copy of concept name.

Code describing the concept represented by this content item. Also conveys the value of document title and section headings in documents. Applicable to all content items (by-value only).

Parameters:

conceptName variable where the copy should be stored (cleared if an error occurs)

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

DSRCodedEntryValue* DSRContentItem::getConceptNamePtr ( )

get pointer to concept name.

Code describing the concept represented by this content item. Also conveys the value of document title and section headings in documents. Applicable to all content items (by-value only).

Returns:: pointer to comcept name value of current content item if valid, NULL otherwise

E_ContinuityOfContent DSRContentItem::getContinuityOfContent ( ) const

get continuity of content flag.

This flag specifies whether or not its contained content items (child nodes) are logically linked in a continuous textual flow, or are sparate items. Applicable to: CONTAINER

Returns:: continuity of content flag if successful, COC_invalid otherwise

const DSRImageReferenceValue& DSRContentItem::getImageReference ( ) const

get image reference.

Applicable to: IMAGE

Returns:: image reference value of current content item if valid, EmptyImageReference otherwise

OFCondition DSRContentItem::getImageReference ( DSRImageReferenceValue & referenceValue ) const

get copy of image reference.

Applicable to: IMAGE

Parameters:

referenceValue variable where the copy should be stored (cleared if an error occurs)

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

DSRImageReferenceValue* DSRContentItem::getImageReferencePtr ( )

get pointer to image reference.

Applicable to: IMAGE

Returns:: pointer to image reference value of current content item if valid, NULL otherwise

const DSRNumericMeasurementValue& DSRContentItem::getNumericValue ( ) const

get numeric value.

Applicable to: NUM

Returns:: numeric measurement value of current content item if valid, EmptyNumericMeasurement otherwise

OFCondition DSRContentItem::getNumericValue ( DSRNumericMeasurementValue & numericValue ) const

get copy of numeric value.

Applicable to: NUM

Parameters:

numericValue variable where the copy should be stored (cleared if an error occurs)

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

DSRNumericMeasurementValue* DSRContentItem::getNumericValuePtr ( )

get pointer to numeric value.

Applicable to: NUM

Returns:: pointer to numeric value of current content item if valid, NULL otherwise

const OFString& DSRContentItem::getObservationDateTime ( ) const

get observation date time.

This is the date and time on which this content item was completed. Might be empty if the date and time do not differ from the content date and time, see DSRDocument. Applicable to all content items (by-value only, optional attribute).

Returns:: observation date and time of current content item if valid, EmptyString otherwise

const OFString& DSRContentItem::getObservationUID ( ) const

get observation unique identifier.

The UID represents the semantic content of the observation; an encoding of the same observation with the same context into another representation may use the same UID. Applicable to all content items (by-value only, optional attribute).

Returns:: observation unique identifier of current content item if valid, EmptyString otherwise

size_t DSRContentItem::getReferencedNodeID ( ) const

get ID of the referenced node.

Applicable to: byReference relationships

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

E_RelationshipType DSRContentItem::getRelationshipType ( ) const

get relationship type.

Applicable to all content items.

Returns:: relationship type of current content item if valid, RT_invalid otherwise

const DSRSpatialCoordinatesValue& DSRContentItem::getSpatialCoordinates ( ) const

get spatial coordinates.

Applicable to: SCOORD

Returns:: spatial coordinates value of current content item if valid, EmptySpatialCoordinates otherwise

OFCondition DSRContentItem::getSpatialCoordinates ( DSRSpatialCoordinatesValue & coordinatesValue ) const

get copy of spatial coordinates.

Applicable to: SCOORD

Parameters:

coordinatesValue variable where the copy should be stored (cleared if an error occurs)

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

const DSRSpatialCoordinates3DValue& DSRContentItem::getSpatialCoordinates3D ( ) const

get spatial coordinates 3D.

Applicable to: SCOORD3D

Returns:: spatial coordinates 3D value of current content item if valid, EmptySpatialCoordinates3D otherwise

OFCondition DSRContentItem::getSpatialCoordinates3D ( DSRSpatialCoordinates3DValue & coordinatesValue ) const

get copy of spatial coordinates 3D.

Applicable to: SCOORD3D

Parameters:

coordinatesValue variable where the copy should be stored (cleared if an error occurs)

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

DSRSpatialCoordinates3DValue* DSRContentItem::getSpatialCoordinates3DPtr ( )

get pointer to spatial coordinates 3D.

Applicable to: SCOORD3D

Returns:: pointer to spatial coordinates 3D value of current content item if valid, NULL otherwise

DSRSpatialCoordinatesValue* DSRContentItem::getSpatialCoordinatesPtr ( )

get pointer to spatial coordinates.

Applicable to: SCOORD

Returns:: pointer to spatial coordinates value of current content item if valid, NULL otherwise

const OFString& DSRContentItem::getStringValue ( ) const

get string value.

Applicable to: TEXT, DATETIME, DATE, TIME, UIDREF, PNAME

Returns:: string value of current content item if valid, EmptyString otherwise

OFCondition DSRContentItem::getTemplateIdentification	(	OFString &	templateIdentifier,
		OFString &	mappingResource
	)		const

get template identifier and mapping resource.

This value pair identifies the template that was used to create this content item (and its children). According to the DICOM standard is is "required if a template was used to define the content of this Item, and the template consists of a single CONTAINER with nested content, and it is the outermost invocation of a set of nested templates that start with the same CONTAINER." However, this condition is currently not checked. The identification is valid if both values are either present (non-empty) or absent (empty). Applicable to all content items (by-value only, optional attribute).

Parameters:

templateIdentifier	identifier of the template (might be empty)
mappingResource	mapping resource that defines the template (might be empty)

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

const DSRTemporalCoordinatesValue& DSRContentItem::getTemporalCoordinates ( ) const

get temporal coordinates.

Applicable to: TCOORD

Returns:: temporal coordinates value of current content item if valid, EmptyTemporalCoordinates otherwise

OFCondition DSRContentItem::getTemporalCoordinates ( DSRTemporalCoordinatesValue & coordinatesValue ) const

get copy of temporal coordinates.

Applicable to: TCOORD

Parameters:

coordinatesValue variable where the copy should be stored (cleared if an error occurs)

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

DSRTemporalCoordinatesValue* DSRContentItem::getTemporalCoordinatesPtr ( )

get pointer to temporal coordinates.

Applicable to: TCOORD

Returns:: pointer to temporal coordinates value of current content item if valid, NULL otherwise

E_ValueType DSRContentItem::getValueType ( ) const

get value type.

Applicable to all content items.

Returns:: value type of current content item if valid, VT_invalid otherwise

const DSRWaveformReferenceValue& DSRContentItem::getWaveformReference ( ) const

get waveform reference.

Applicable to: WAVEFORM

Returns:: waveform reference value of current content item if valid, EmptyWaveformReference otherwise

OFCondition DSRContentItem::getWaveformReference ( DSRWaveformReferenceValue & referenceValue ) const

get copy of waveform reference.

Applicable to: WAVEFORM

Parameters:

referenceValue variable where the copy should be stored (cleared if an error occurs)

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

DSRWaveformReferenceValue* DSRContentItem::getWaveformReferencePtr ( )

get pointer to waveform reference.

Applicable to: WAVEFORM

Returns:: pointer to waveform reference value of current content item if valid, NULL otherwise

OFBool DSRContentItem::isMarked ( ) const

check for mark flag.

Applicable to all content items.

Returns:: OFTrue if current content item is marked, OFFalse otherwise

OFBool DSRContentItem::isValid ( ) const

check for validity/completeness.

Applicable to all content items.

Returns:: OFTrue if current content item is valid, OFFalse otherwise

OFCondition DSRContentItem::setCodeValue ( const DSRCodedEntryValue & codeValue )

set code value.

Applicable to: CODE

Parameters:

codeValue value to be set

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

OFCondition DSRContentItem::setCompositeReference ( const DSRCompositeReferenceValue & referenceValue )

set composite reference.

Applicable to: COMPOSITE

Parameters:

referenceValue value to be set

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

OFCondition DSRContentItem::setConceptName ( const DSRCodedEntryValue & conceptName )

set concept name.

Code describing the concept represented by this content item. Also conveys the value of document title and section headings in documents. Applicable to all content items (by-value only, optional/conditional for some value types).

Parameters:

conceptName value to be set

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

OFCondition DSRContentItem::setContinuityOfContent ( const E_ContinuityOfContent continuityOfContent )

set continuity of content flag.

This flag specifies whether or not its contained content items (child nodes) are logically linked in a continuous textual flow, or are sparate items. Applicable to: CONTAINER

Parameters:

continuityOfContent value to be set (should be different from COC_onvalid)

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

OFCondition DSRContentItem::setImageReference ( const DSRImageReferenceValue & referenceValue )

set image reference.

Applicable to: IMAGE

Parameters:

referenceValue value to be set

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

void DSRContentItem::setMark ( const OFBool flag )

mark/unmark item.

Applicable to all content items.

Parameters:

flag	mark item if OFTrue, unmark otherwise

OFCondition DSRContentItem::setNumericValue ( const DSRNumericMeasurementValue & numericValue )

set numeric value.

Applicable to: NUM

Parameters:

numericValue value to be set

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

OFCondition DSRContentItem::setObservationDateTime ( const OFString & observationDateTime )

set observation date time.

This is the date and time on which this content item was completed. Might be empty if the date and time do not differ from the content date and time, see DSRDocument. Please use the correct DICOM format (VR=DT). Applicable to all content items (by-value only).

Parameters:

observationDateTime value to be set (might be an empty string)

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

OFCondition DSRContentItem::setObservationUID ( const OFString & observationUID )

set observation unique identifier.

The UID represents the semantic content of the observation; an encoding of the same observation with the same context into another representation may use the same UID. Please use the correct DICOM format (VR=UI). Applicable to all content items (by-value only).

Parameters:

observationUID value to be set (might be an empty string)

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

OFCondition DSRContentItem::setSpatialCoordinates ( const DSRSpatialCoordinatesValue & coordinatesValue )

set spatial coordinates.

Applicable to: SCOORD

Parameters:

coordinatesValue value to be set

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

OFCondition DSRContentItem::setSpatialCoordinates3D ( const DSRSpatialCoordinates3DValue & coordinatesValue )

set spatial coordinates 3D.

Applicable to: SCOORD3D

Parameters:

coordinatesValue value to be set

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

OFCondition DSRContentItem::setStringValue ( const OFString & stringValue )

set string value.

Please use the correct format for the string value depending on the corresponding content item (value type). Applicable to: TEXT, DATETIME, DATE, TIME, UIDREF, PNAME

Parameters:

stringValue value to be set

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

OFCondition DSRContentItem::setTemplateIdentification	(	const OFString &	templateIdentifier,
		const OFString &	mappingResource
	)

set template identifier and mapping resource.

The identification is valid if both values are either present (non-empty) or absent (empty). See getTemplateIdentification() for details. Applicable to all content items (by-value only).

Parameters:

templateIdentifier	identifier of the template to be set (VR=CS)
mappingResource	mapping resource that defines the template (VR=CS)

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

OFCondition DSRContentItem::setTemporalCoordinates ( const DSRTemporalCoordinatesValue & coordinatesValue )

set temporal coordinates.

Applicable to: TCOORD

Parameters:

coordinatesValue value to be set

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

void DSRContentItem::setTreeNode ( DSRDocumentTreeNode * node ) [inline, protected]

set internal tree node pointer (protected)

Parameters:

node	pointer to the document tree node (content item)

OFCondition DSRContentItem::setWaveformReference ( const DSRWaveformReferenceValue & referenceValue )

set waveform reference.

Applicable to: WAVEFORM

Parameters:

referenceValue value to be set

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

Member Data Documentation

const DSRNumericMeasurementValue DSRContentItem::EmptyNumericMeasurement [private]

empty numeric measurement value.

Used as default return value for getNumericValue(). A static member variable (as for the other values below) cannot be used because this class contains members that again contain OFCondition instances that cannot be defined before the main() function starts.

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

dcmsr/include/dcmtk/dcmsr/dsrcitem.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Function Documentation

Member Data Documentation