DSRTemporalCoordinatesValue Class Reference

Class for spatial coordinate values. More...

Inheritance diagram for DSRTemporalCoordinatesValue:


Public Member Functions
	DSRTemporalCoordinatesValue ()
	default contructor
	DSRTemporalCoordinatesValue (const DSRTypes::E_TemporalRangeType temporalRangeType)
	constructor
	DSRTemporalCoordinatesValue (const DSRTemporalCoordinatesValue &coordinatesValue)
	copy constructor
virtual	~DSRTemporalCoordinatesValue ()
	destructor
DSRTemporalCoordinatesValue &	operator= (const DSRTemporalCoordinatesValue &coordinatesValue)
	assignment operator
virtual void	clear ()
	clear all internal variables.
virtual OFBool	isValid () const
	check whether the current spatial coordinates value is valid.
virtual OFBool	isShort (const size_t flags) const
	check whether the content is short.
virtual OFCondition	print (ostream &stream, const size_t flags) const
	print temporal coordinates.
virtual OFCondition	readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor)
	read temporal coordinates value from XML document
virtual OFCondition	writeXML (ostream &stream, const size_t flags, OFConsole *logStream) const
	write temporal coordinates value in XML format
virtual OFCondition	renderHTML (ostream &docStream, ostream &annexStream, size_t &annexNumber, const size_t flags, OFConsole *logStream) const
	render temporal coordinates value in HTML format
const DSRTemporalCoordinatesValue &	getValue () const
	get reference to temporal coordinates value
OFCondition	getValue (DSRTemporalCoordinatesValue &coordinatesValue) const
	get copy of temporal coordinates value
OFCondition	setValue (const DSRTemporalCoordinatesValue &coordinatesValue)
	set temporal coordinates value.
DSRTypes::E_TemporalRangeType	getTemporalRangeType () const
	get current temporal range type.
OFCondition	setTemporalRangeType (const DSRTypes::E_TemporalRangeType temporalRangeType)
	set current temporal range type.
DSRReferencedDatetimeList &	getDatetimeList ()
	get reference to list of referenced datetime
DSRReferencedSamplePositionList &	getSamplePositionList ()
	get reference to list of referenced sample positions
DSRReferencedTimeOffsetList &	getTimeOffsetList ()
	get reference to list of referenced time offsets
Protected Member Functions
DSRTemporalCoordinatesValue *	getValuePtr ()
	get pointer to temporal coordinates value
virtual OFCondition	read (DcmItem &dataset, OFConsole *logStream)
	read temporal coordinates value from dataset.
virtual OFCondition	write (DcmItem &dataset, OFConsole *logStream) const
	write temporal coordinates reference value to dataset.
OFBool	checkData (const DSRTypes::E_TemporalRangeType temporalRangeType, const DSRReferencedSamplePositionList &samplePositionList, const DSRReferencedTimeOffsetList &timeOffsetList, const DSRReferencedDatetimeList &datetimeList, OFConsole *logStream=NULL) const
	check the temporal range type and other data for validity.
Private Attributes
DSRTypes::E_TemporalRangeType	TemporalRangeType
	temporal range type (associated DICOM VR=CS, type 1)
DSRReferencedSamplePositionList	SamplePositionList
	list of referenced sample positions (associated DICOM VR=UL, VM=1-n, type 1C)
DSRReferencedTimeOffsetList	TimeOffsetList
	list of referenced time offsets (associated DICOM VR=DS, VM=1-n, type 1C)
DSRReferencedDatetimeList	DatetimeList
	list of referenced datetime (associated DICOM VR=DT, VM=1-n, type 1C)
Friends
class	DSRContentItem

Detailed Description

Class for spatial coordinate values.

Definition at line 52 of file dsrtcovl.h.

Constructor & Destructor Documentation

DSRTemporalCoordinatesValue::DSRTemporalCoordinatesValue ( const DSRTypes::E_TemporalRangeType temporalRangeType )

constructor

Parameters:

temporalRangeType type of temporal extent of the region of interest

DSRTemporalCoordinatesValue::DSRTemporalCoordinatesValue ( const DSRTemporalCoordinatesValue & coordinatesValue )

copy constructor

Parameters:

coordinatesValue temporal coordinates value to be copied (not checked !)

Member Function Documentation

OFBool DSRTemporalCoordinatesValue::checkData ( const DSRTypes::E_TemporalRangeType temporalRangeType,

const DSRReferencedSamplePositionList & samplePositionList,

const DSRReferencedTimeOffsetList & timeOffsetList,

const DSRReferencedDatetimeList & datetimeList,

OFConsole * logStream = NULL

) const [protected]

check the temporal range type and other data for validity.
The data is valid if the 'temporalRangeType' is valid and at least one of the three lists are non-empty. If more the one list is non-empty a warning is reported since they are mutually exclusive (type 1C).
Parameters:

temporalRangeType temporal range type to be checked

samplePositionList list of referenced sample positions to be checked

timeOffsetList list of referenced time offsets to be checked

datetimeList list of referenced datetime to be checked

logStream pointer to error/warning output stream (output disabled if NULL)

Returns:
OFTrue if data is valid, OFFalse otherwise

virtual void DSRTemporalCoordinatesValue::clear ( ) [virtual]

clear all internal variables.
Temporal range type is set to TRT_invalid. Since an empty list of graphic data is invalid the spatial coordinates value becomes invalid afterwards.
Reimplemented in DSRTCoordTreeNode.

DSRReferencedDatetimeList& DSRTemporalCoordinatesValue::getDatetimeList ( ) [inline]

get reference to list of referenced datetime

Returns:
reference to list

Definition at line 190 of file dsrtcovl.h.
References DatetimeList.

DSRReferencedSamplePositionList& DSRTemporalCoordinatesValue::getSamplePositionList ( ) [inline]

get reference to list of referenced sample positions

Returns:
reference to list

Definition at line 198 of file dsrtcovl.h.
References SamplePositionList.

DSRTypes::E_TemporalRangeType DSRTemporalCoordinatesValue::getTemporalRangeType ( ) const [inline]

get current temporal range type.
This value represents the type of temporal extent of the region of interest.
Returns:
region type (might be TRT_invalid)

Definition at line 175 of file dsrtcovl.h.
References TemporalRangeType.

DSRReferencedTimeOffsetList& DSRTemporalCoordinatesValue::getTimeOffsetList ( ) [inline]

get reference to list of referenced time offsets

Returns:
reference to list

Definition at line 206 of file dsrtcovl.h.
References TimeOffsetList.

OFCondition DSRTemporalCoordinatesValue::getValue ( DSRTemporalCoordinatesValue & coordinatesValue ) const

get copy of temporal coordinates value

Parameters:

coordinatesValue reference to variable in which the value should be stored

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

const DSRTemporalCoordinatesValue& DSRTemporalCoordinatesValue::getValue ( ) const [inline]

get reference to temporal coordinates value

Returns:
reference to temporal coordinates value

Definition at line 151 of file dsrtcovl.h.

DSRTemporalCoordinatesValue* DSRTemporalCoordinatesValue::getValuePtr ( ) [inline, protected]

get pointer to temporal coordinates value

Returns:
pointer to temporal coordinates value (never NULL)

Definition at line 217 of file dsrtcovl.h.

virtual OFBool DSRTemporalCoordinatesValue::isShort ( const size_t flags ) const [virtual]

check whether the content is short.
This method is used to check whether the rendered output of this content item can be expanded inline or not (used for renderHTML()).
Parameters:

flags flag used to customize the output (see DSRTypes::HF_xxx)

Returns:
OFTrue if the content is short, OFFalse otherwise

Reimplemented in DSRTCoordTreeNode.

virtual OFBool DSRTemporalCoordinatesValue::isValid ( ) const [virtual]

check whether the current spatial coordinates value is valid.
The value is valid if the temporal range type is not TRT_invalid and the other data is valid (see checkData() for details).
Returns:
OFTrue if reference value is valid, OFFalse otherwise

Reimplemented in DSRTCoordTreeNode.

DSRTemporalCoordinatesValue& DSRTemporalCoordinatesValue::operator= ( const DSRTemporalCoordinatesValue & coordinatesValue )

assignment operator

Parameters:

coordinatesValue Temporal coordinates value to be copied (not checked !)

Returns:
reference to this Temporal coordinates value after 'coordinatesValue' has been copied

virtual OFCondition DSRTemporalCoordinatesValue::print ( ostream & stream,

const size_t flags

) const [virtual]

print temporal coordinates.
The output of a typical temporal coordinates value looks like this (depending on the referenced data list): (SEGMENT,1,2,3) or (SEGMENT,1,2.5,3.1) or (POINT,20001010120000)
Parameters:

stream output stream to which the temporal coordinates value 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 in DSRTCoordTreeNode.

virtual OFCondition DSRTemporalCoordinatesValue::read ( DcmItem & dataset,

OFConsole * logStream

) [protected, virtual]

read temporal coordinates value from dataset.
Please note that all three lists are (tried to) read from the dataset. If more than one list is present a warning messsage is reported.
Parameters:

dataset DICOM dataset from which the value should be read

logStream pointer to error/warning output stream (output disabled if NULL)

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

virtual OFCondition DSRTemporalCoordinatesValue::readXML ( const DSRXMLDocument & doc,

DSRXMLCursor cursor

) [virtual]

read temporal coordinates value from XML document

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

virtual OFCondition DSRTemporalCoordinatesValue::renderHTML ( ostream & docStream,

ostream & annexStream,

size_t & annexNumber,

const size_t flags,

OFConsole * logStream

) const [virtual]

render temporal coordinates value in HTML format

Parameters:

docStream output stream to which the main HTML document is written

annexStream output stream to which the HTML document annex is written

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)

logStream pointer to error/warning output stream (output disabled if NULL)

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

OFCondition DSRTemporalCoordinatesValue::setTemporalRangeType ( const DSRTypes::E_TemporalRangeType temporalRangeType )

set current temporal range type.
This value represents the type of temporal extent of the region of interest.
Parameters:

temporalRangeType temporal range type to be set (TRT_invalid is not allowed)

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

OFCondition DSRTemporalCoordinatesValue::setValue ( const DSRTemporalCoordinatesValue & coordinatesValue )

set temporal coordinates value.
Before setting the value the temporal range type and other data are checked (see checkData()). If the value is invalid the current value is not replaced and remains unchanged.
Parameters:

coordinatesValue value to be set

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

virtual OFCondition DSRTemporalCoordinatesValue::write ( DcmItem & dataset,

OFConsole * logStream

) const [protected, virtual]

write temporal coordinates reference value to dataset.
Please note that only one of the three lists is actually written to the dataset.
Parameters:

dataset DICOM dataset to which the value should be written

logStream pointer to error/warning output stream (output disabled if NULL)

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

virtual OFCondition DSRTemporalCoordinatesValue::writeXML ( ostream & stream,

const size_t flags,

OFConsole * logStream

) const [virtual]

write temporal coordinates value 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)

logStream pointer to error/warning output stream (output disabled if NULL)

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

Reimplemented in DSRTCoordTreeNode.

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

dcmsr/include/dcmtk/dcmsr/dsrtcovl.h

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5

DSRTemporalCoordinatesValue Class Reference

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation