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 (STD_NAMESPACE 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 (STD_NAMESPACE ostream &stream, const size_t flags) const |
| write temporal coordinates value in XML format | |
| virtual OFCondition | renderHTML (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, size_t &annexNumber, const size_t flags) const |
| render temporal coordinates value in HTML/XHTML 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) |
| read temporal coordinates value from dataset. | |
| virtual OFCondition | write (DcmItem &dataset) const |
| write temporal coordinates reference value to dataset. | |
| OFBool | checkData (const DSRTypes::E_TemporalRangeType temporalRangeType, const DSRReferencedSamplePositionList &samplePositionList, const DSRReferencedTimeOffsetList &timeOffsetList, const DSRReferencedDatetimeList &datetimeList) 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 |
Definition at line 48 of file dsrtcovl.h.
| DSRTemporalCoordinatesValue::DSRTemporalCoordinatesValue | ( | const DSRTypes::E_TemporalRangeType | temporalRangeType | ) |
constructor
| temporalRangeType | type of temporal extent of the region of interest |
| DSRTemporalCoordinatesValue::DSRTemporalCoordinatesValue | ( | const DSRTemporalCoordinatesValue & | coordinatesValue | ) |
copy constructor
| coordinatesValue | temporal coordinates value to be copied (not checked !) |
| DSRTemporalCoordinatesValue& DSRTemporalCoordinatesValue::operator= | ( | const DSRTemporalCoordinatesValue & | coordinatesValue | ) |
assignment operator
| coordinatesValue | Temporal coordinates value to be copied (not checked !) |
| 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.
| 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).
Reimplemented in DSRTCoordTreeNode.
| 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()).
| flags | flag used to customize the output (see DSRTypes::HF_xxx) |
Reimplemented in DSRTCoordTreeNode.
| 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)
| stream | output stream to which the temporal coordinates value should be printed | |
| flags | flag used to customize the output (see DSRTypes::PF_xxx) |
Reimplemented in DSRTCoordTreeNode.
| virtual OFCondition DSRTemporalCoordinatesValue::readXML | ( | const DSRXMLDocument & | doc, | |
| DSRXMLCursor | cursor | |||
| ) | [virtual] |
read temporal coordinates value from XML document
| doc | document containing the XML file content | |
| cursor | cursor pointing to the starting node |
| virtual OFCondition DSRTemporalCoordinatesValue::writeXML | ( | STD_NAMESPACE ostream & | stream, | |
| const size_t | flags | |||
| ) | const [virtual] |
write temporal coordinates value in XML format
| stream | output stream to which the XML document is written | |
| flags | flag used to customize the output (see DSRTypes::XF_xxx) |
Reimplemented in DSRTCoordTreeNode.
| 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
| 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) |
| const DSRTemporalCoordinatesValue& DSRTemporalCoordinatesValue::getValue | ( | ) | const [inline] |
get reference to temporal coordinates value
Definition at line 143 of file dsrtcovl.h.
| OFCondition DSRTemporalCoordinatesValue::getValue | ( | DSRTemporalCoordinatesValue & | coordinatesValue | ) | const |
get copy of temporal coordinates value
| coordinatesValue | reference to variable in which the value should be stored |
| 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.
| coordinatesValue | value to be set |
| 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.
Definition at line 167 of file dsrtcovl.h.
References TemporalRangeType.
| 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.
| temporalRangeType | temporal range type to be set (TRT_invalid is not allowed) |
| DSRReferencedDatetimeList& DSRTemporalCoordinatesValue::getDatetimeList | ( | ) | [inline] |
get reference to list of referenced datetime
Definition at line 182 of file dsrtcovl.h.
References DatetimeList.
| DSRReferencedSamplePositionList& DSRTemporalCoordinatesValue::getSamplePositionList | ( | ) | [inline] |
get reference to list of referenced sample positions
Definition at line 190 of file dsrtcovl.h.
References SamplePositionList.
| DSRReferencedTimeOffsetList& DSRTemporalCoordinatesValue::getTimeOffsetList | ( | ) | [inline] |
get reference to list of referenced time offsets
Definition at line 198 of file dsrtcovl.h.
References TimeOffsetList.
| DSRTemporalCoordinatesValue* DSRTemporalCoordinatesValue::getValuePtr | ( | ) | [inline, protected] |
get pointer to temporal coordinates value
Definition at line 209 of file dsrtcovl.h.
| virtual OFCondition DSRTemporalCoordinatesValue::read | ( | DcmItem & | dataset | ) | [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.
| dataset | DICOM dataset from which the value should be read |
| virtual OFCondition DSRTemporalCoordinatesValue::write | ( | DcmItem & | dataset | ) | 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.
| dataset | DICOM dataset to which the value should be written |
| OFBool DSRTemporalCoordinatesValue::checkData | ( | const DSRTypes::E_TemporalRangeType | temporalRangeType, | |
| const DSRReferencedSamplePositionList & | samplePositionList, | |||
| const DSRReferencedTimeOffsetList & | timeOffsetList, | |||
| const DSRReferencedDatetimeList & | datetimeList | |||
| ) | 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).
| 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 |