Class for spatial coordinate values.
More...
Class for spatial coordinate values.
Definition at line 48 of file dsrtcovl.h.
constructor
- Parameters
-
temporalRangeType | type of temporal extent of the region of interest |
copy constructor
- Parameters
-
coordinatesValue | temporal coordinates value to be copied (not checked !) |
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 |
- 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.
get reference to list of referenced datetime
- Returns
- reference to list
Definition at line 182 of file dsrtcovl.h.
References DatetimeList.
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 167 of file dsrtcovl.h.
References TemporalRangeType.
get reference to list of referenced time offsets
- Returns
- reference to list
Definition at line 198 of file dsrtcovl.h.
References TimeOffsetList.
get reference to temporal coordinates value
- Returns
- reference to temporal coordinates value
Definition at line 143 of file dsrtcovl.h.
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
get pointer to temporal coordinates value
- Returns
- pointer to temporal coordinates value (never NULL)
Definition at line 209 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.
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 |
( |
STD_NAMESPACE 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.
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 |
- Returns
- status, EC_Normal if successful, an error code otherwise
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 |
( |
STD_NAMESPACE ostream & |
docStream, |
|
|
STD_NAMESPACE ostream & |
annexStream, |
|
|
size_t & |
annexNumber, |
|
|
const size_t |
flags |
|
) |
| const |
|
virtual |
render temporal coordinates value in HTML/XHTML format
- Parameters
-
docStream | output stream to which the main HTML/XHTML document is written |
annexStream | output stream to which the HTML/XHTML 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) |
- Returns
- status, EC_Normal if successful, an error code otherwise
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
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
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 |
- Returns
- status, EC_Normal if successful, an error code otherwise
virtual OFCondition DSRTemporalCoordinatesValue::writeXML |
( |
STD_NAMESPACE ostream & |
stream, |
|
|
const size_t |
flags |
|
) |
| 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) |
- Returns
- status, EC_Normal if successful, an error code otherwise
Reimplemented in DSRTCoordTreeNode.
The documentation for this class was generated from the following file: