Class for spatial coordinate (3D) values.
More...
Class for spatial coordinate (3D) values.
Definition at line 46 of file dsrsc3vl.h.
constructor
- Parameters
-
graphicType | graphic type specifying the geometry of the coordinates |
copy constructor
- Parameters
-
coordinatesValue | spatial coordinates value to be copied (not checked !) |
check the graphic type, graphic data and frame of reference UID for validity.
If 'graphicType' is valid the number of entries in the 'graphicDatalist' are checked. A POINT needs exactly 1 value triplets (x,y,z), a MULTIPOINT at least 1?, a POLYLINE at least 1?, a POLYGON at least 1? where the first and last triplet are equal, an ELLIPSE exactly 4 and an ELLIPSOID exactly 6.
- Parameters
-
graphicType | graphic type to be checked |
graphicDataList | list of graphic data to be checked |
frameOfReferenceUID | referenced frame of reference UID to be checked |
- Returns
- OFTrue if graphic type and data are valid, OFFalse otherwise
virtual void DSRSpatialCoordinates3DValue::clear |
( |
| ) |
|
|
virtual |
clear all internal variables.
Graphic type is set to GT3_invalid. Since an empty list of graphic data is invalid the spatial coordinates value becomes invalid afterwards.
Reimplemented in DSRSCoord3DTreeNode.
const OFString& DSRSpatialCoordinates3DValue::getFrameOfReferenceUID |
( |
| ) |
const |
|
inline |
get referenced frame of reference UID
- Returns
- referenced frame of reference UID (might be empty)
Definition at line 178 of file dsrsc3vl.h.
References FrameOfReferenceUID.
get reference to graphic data list.
This list contains an ordered set of (x,y,z) triplets that denote positions in an image. The allowed number of triplets is depending on the graphic type.
- Returns
- reference to graphic data list
Definition at line 209 of file dsrsc3vl.h.
References GraphicDataList.
get current graphic type.
The graphic type specifies the geometry of the coordinates stored in the graphic data list.
- Returns
- graphic type (might be GT3_invalid)
Definition at line 162 of file dsrsc3vl.h.
References GraphicType.
get reference to spatial coordinates value
- Returns
- reference to spatial coordinates value
Definition at line 152 of file dsrsc3vl.h.
get copy of spatial 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 spatial coordinates value
- Returns
- pointer to spatial coordinates value (never NULL)
Definition at line 220 of file dsrsc3vl.h.
virtual OFBool DSRSpatialCoordinates3DValue::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 DSRSCoord3DTreeNode.
virtual OFBool DSRSpatialCoordinates3DValue::isValid |
( |
| ) |
const |
|
virtual |
check whether the current spatial coordinates value is valid.
The value is valid if the graphic type is not GT3_invalid and the graphic data is valid (see checkData() for details).
- Returns
- OFTrue if reference value is valid, OFFalse otherwise
Reimplemented in DSRSCoord3DTreeNode.
assignment operator
- Parameters
-
coordinatesValue | spatial coordinates value to be copied (not checked !) |
- Returns
- reference to this spatial coordinates value after 'coordinatesValue' has been copied
virtual OFCondition DSRSpatialCoordinates3DValue::print |
( |
STD_NAMESPACE ostream & |
stream, |
|
|
const size_t |
flags |
|
) |
| const |
|
virtual |
print spatial coordinates.
The output of a typical spatial coordinates value looks like this: (POINT,,100/100/100).
- Parameters
-
stream | output stream to which the spatial 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 DSRSCoord3DTreeNode.
read spatial coordinates value from dataset
- Parameters
-
dataset | DICOM dataset from which the value should be read |
- Returns
- status, EC_Normal if successful, an error code otherwise
read spatial 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 DSRSpatialCoordinates3DValue::renderHTML |
( |
STD_NAMESPACE ostream & |
docStream, |
|
|
STD_NAMESPACE ostream & |
annexStream, |
|
|
size_t & |
annexNumber, |
|
|
const size_t |
flags |
|
) |
| const |
|
virtual |
render spatial 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
OFCondition DSRSpatialCoordinates3DValue::setFrameOfReferenceUID |
( |
const OFString & |
frameOfReferenceUID | ) |
|
set current referenced frame of reference UID
- Parameters
-
frameOfReferenceUID | referenced frame of reference UID to be set |
- Returns
- status, EC_Normal if successful, an error code otherwise
set current graphic type.
The graphic type specifies the geometry of the coordinates stored in the graphic data list.
- Parameters
-
graphicType | graphic type to be set (GT3_invalid is not allowed) |
- Returns
- status, EC_Normal if successful, an error code otherwise
set spatial coordinates value.
Before setting the value the graphic type, graphic data and frame of reference UID 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 spatial coordinates reference value to dataset
- Parameters
-
dataset | DICOM dataset to which the value should be written |
- Returns
- status, EC_Normal if successful, an error code otherwise
virtual OFCondition DSRSpatialCoordinates3DValue::writeXML |
( |
STD_NAMESPACE ostream & |
stream, |
|
|
const size_t |
flags |
|
) |
| const |
|
virtual |
write spatial 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 DSRSCoord3DTreeNode.
The documentation for this class was generated from the following file: