OFFIS DCMTK
Version 3.6.0
|
an item of the text object sequence in a presentation state (internal use only). More...
Public Member Functions | |
DVPSTextObject () | |
default constructor | |
DVPSTextObject (const DVPSTextObject ©) | |
copy constructor | |
DVPSTextObject * | clone () |
clone method. More... | |
virtual | ~DVPSTextObject () |
destructor | |
OFCondition | read (DcmItem &dset) |
reads a text object from a DICOM dataset. More... | |
OFCondition | write (DcmItem &dset) |
writes the text object managed by this object to a DICOM dataset. More... | |
OFBool | haveAnchorPoint () |
checks if this text object contains an anchor point. More... | |
OFBool | haveBoundingBox () |
checks if this text object contains bounding box. More... | |
OFCondition | setAnchorPoint (double x, double y, DVPSannotationUnit unit, OFBool isVisible) |
sets an anchor point for this text object. More... | |
OFCondition | setBoundingBox (double TLHC_x, double TLHC_y, double BRHC_x, double BRHC_y, DVPSannotationUnit unit, DVPSTextJustification justification) |
sets bounding box for this text object. More... | |
OFCondition | setText (const char *text) |
assigns a new "unformatted text value" for this text object. More... | |
void | removeAnchorPoint () |
removes any anchor point from the text object. More... | |
void | removeBoundingBox () |
removes any bounding box from the text object. More... | |
const char * | getText () |
gets the unformatted text value for this text object. More... | |
double | getBoundingBoxTLHC_x () |
gets the bounding box TLHC x value. More... | |
double | getBoundingBoxTLHC_y () |
gets the bounding box TLHC y value. More... | |
double | getBoundingBoxBRHC_x () |
gets the bounding box BRHC x value. More... | |
double | getBoundingBoxBRHC_y () |
gets the bounding box BRHC y value. More... | |
DVPSannotationUnit | getBoundingBoxAnnotationUnits () |
gets the bounding box annotation units. More... | |
DVPSTextJustification | getBoundingBoxHorizontalJustification () |
gets the bounding box horizontal justification. More... | |
double | getAnchorPoint_x () |
gets the anchor point x value. More... | |
double | getAnchorPoint_y () |
gets the anchor point y value. More... | |
OFBool | anchorPointIsVisible () |
gets the anchor point visibility May only be called when an anchor point is present (haveAnchorPoint()==OFTrue) More... | |
DVPSannotationUnit | getAnchorPointAnnotationUnits () |
gets the anchor point annotation units. More... | |
Private Member Functions | |
DVPSTextObject & | operator= (const DVPSTextObject &) |
private undefined assignment operator | |
Private Attributes | |
DcmCodeString | boundingBoxAnnotationUnits |
VR=CS, VM=1, Type 1c. | |
DcmCodeString | anchorPointAnnotationUnits |
VR=CS, VM=1, Type 1c. | |
DcmShortText | unformattedTextValue |
VR=ST, VM=1, Type 1. | |
DcmFloatingPointSingle | boundingBoxTLHC |
VR=FL, VM=2, Type 1c. | |
DcmFloatingPointSingle | boundingBoxBRHC |
VR=FL, VM=2, Type 1c. | |
DcmCodeString | boundingBoxTextHorizontalJustification |
VR=CS, VM=1, Type 1c. | |
DcmFloatingPointSingle | anchorPoint |
VR=FL, VM=2, Type 1c. | |
DcmCodeString | anchorPointVisibility |
VR=CS, VM=1, Type 1c. | |
an item of the text object sequence in a presentation state (internal use only).
This class manages the data structures comprising one item of the Text Object Sequence which is contained in the Graphic Annotation Sequence in a Presentation State object.
OFBool DVPSTextObject::anchorPointIsVisible | ( | ) |
gets the anchor point visibility May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)
Referenced by clone().
|
inline |
clone method.
Definition at line 56 of file dvpstx.h.
References anchorPointIsVisible(), DVPSTextObject(), getAnchorPoint_x(), getAnchorPoint_y(), getAnchorPointAnnotationUnits(), getBoundingBoxAnnotationUnits(), getBoundingBoxBRHC_x(), getBoundingBoxBRHC_y(), getBoundingBoxHorizontalJustification(), getBoundingBoxTLHC_x(), getBoundingBoxTLHC_y(), getText(), haveAnchorPoint(), haveBoundingBox(), operator=(), read(), removeAnchorPoint(), removeBoundingBox(), setAnchorPoint(), setBoundingBox(), setText(), write(), and ~DVPSTextObject().
double DVPSTextObject::getAnchorPoint_x | ( | ) |
gets the anchor point x value.
May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)
Referenced by clone().
double DVPSTextObject::getAnchorPoint_y | ( | ) |
gets the anchor point y value.
May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)
Referenced by clone().
DVPSannotationUnit DVPSTextObject::getAnchorPointAnnotationUnits | ( | ) |
gets the anchor point annotation units.
May only be called when an anchor point is present (haveAnchorPoint()==OFTrue)
Referenced by clone().
DVPSannotationUnit DVPSTextObject::getBoundingBoxAnnotationUnits | ( | ) |
gets the bounding box annotation units.
May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
Referenced by clone().
double DVPSTextObject::getBoundingBoxBRHC_x | ( | ) |
gets the bounding box BRHC x value.
May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
Referenced by clone().
double DVPSTextObject::getBoundingBoxBRHC_y | ( | ) |
gets the bounding box BRHC y value.
May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
Referenced by clone().
DVPSTextJustification DVPSTextObject::getBoundingBoxHorizontalJustification | ( | ) |
gets the bounding box horizontal justification.
May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
Referenced by clone().
double DVPSTextObject::getBoundingBoxTLHC_x | ( | ) |
gets the bounding box TLHC x value.
May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
Referenced by clone().
double DVPSTextObject::getBoundingBoxTLHC_y | ( | ) |
gets the bounding box TLHC y value.
May only be called when a bounding box is present (haveBoundingBox()==OFTrue)
Referenced by clone().
const char* DVPSTextObject::getText | ( | ) |
gets the unformatted text value for this text object.
Referenced by clone().
OFBool DVPSTextObject::haveAnchorPoint | ( | ) |
checks if this text object contains an anchor point.
Referenced by clone().
OFBool DVPSTextObject::haveBoundingBox | ( | ) |
checks if this text object contains bounding box.
Referenced by clone().
OFCondition DVPSTextObject::read | ( | DcmItem & | dset | ) |
reads a text object from a DICOM dataset.
The DICOM elements of the Text Object item are copied from the dataset to this object. The completeness of the item (presence of all required elements, value multiplicity) is checked. If this method returns an error code, the object is in undefined state afterwards.
dset | the item of the TextObjectSequence from which the data is to be read |
Referenced by clone().
void DVPSTextObject::removeAnchorPoint | ( | ) |
removes any anchor point from the text object.
Attention: A text object must always contain either anchor point, bounding box or both. This property is not asserted by the text object itself.
Referenced by clone().
void DVPSTextObject::removeBoundingBox | ( | ) |
removes any bounding box from the text object.
Attention: A text object must always contain either anchor point, bounding box or both. This property is not asserted by the text object itself.
Referenced by clone().
OFCondition DVPSTextObject::setAnchorPoint | ( | double | x, |
double | y, | ||
DVPSannotationUnit | unit, | ||
OFBool | isVisible | ||
) |
sets an anchor point for this text object.
x | anchor point X value |
y | anchor point Y value |
unit | anchor point annotation units (pixel/display) |
isVisible | anchor point visibility |
Referenced by clone().
OFCondition DVPSTextObject::setBoundingBox | ( | double | TLHC_x, |
double | TLHC_y, | ||
double | BRHC_x, | ||
double | BRHC_y, | ||
DVPSannotationUnit | unit, | ||
DVPSTextJustification | justification | ||
) |
sets bounding box for this text object.
TLHC_x | bounding box top-lefthand corner X value |
TLHC_x | bounding box top-lefthand corner Y value |
BRHC_x | bounding box bottom-righthand corner X value |
BRHC_x | bounding box bottom-righthand corner Y value |
unit | bounding box annotation units (pixel/display) |
justification | bounding box horizontal justification (left/right/center) |
Referenced by clone().
OFCondition DVPSTextObject::setText | ( | const char * | text | ) |
assigns a new "unformatted text value" for this text object.
text | unformatted text value. Must not be NULL or empty string. |
Referenced by clone().
OFCondition DVPSTextObject::write | ( | DcmItem & | dset | ) |
writes the text object managed by this object to a DICOM dataset.
Copies of the DICOM element managed by this object are inserted into the DICOM dataset.
dset | the the item of the TextObjectSequence to which the data is written |
Referenced by clone().