OFFIS DCMTK  Version 3.6.0
dvpstx.h
1 /*
2  *
3  * Copyright (C) 1998-2010, OFFIS e.V.
4  * All rights reserved. See COPYRIGHT file for details.
5  *
6  * This software and supporting documentation were developed by
7  *
8  * OFFIS e.V.
9  * R&D Division Health
10  * Escherweg 2
11  * D-26121 Oldenburg, Germany
12  *
13  *
14  * Module: dcmpstat
15  *
16  * Author: Marco Eichelberg
17  *
18  * Purpose:
19  * classes: DVPSTextObject
20  *
21  * Last Update: $Author: joergr $
22  * Update Date: $Date: 2010-10-14 13:16:37 $
23  * CVS/RCS Revision: $Revision: 1.11 $
24  * Status: $State: Exp $
25  *
26  * CVS/RCS Log at end of file
27  *
28  */
29 
30 #ifndef DVPSTX_H
31 #define DVPSTX_H
32 
33 #include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
34 #include "dcmtk/dcmdata/dctk.h"
35 #include "dcmtk/dcmpstat/dvpstyp.h"
36 
44 {
45 public:
48 
50  DVPSTextObject(const DVPSTextObject& copy);
51 
56  DVPSTextObject *clone() { return new DVPSTextObject(*this); }
57 
59  virtual ~DVPSTextObject();
60 
70  OFCondition read(DcmItem &dset);
71 
78  OFCondition write(DcmItem &dset);
79 
83  OFBool haveAnchorPoint();
84 
88  OFBool haveBoundingBox();
89 
97  OFCondition setAnchorPoint(double x, double y, DVPSannotationUnit unit, OFBool isVisible);
98 
108  OFCondition setBoundingBox(double TLHC_x, double TLHC_y, double BRHC_x,
109  double BRHC_y, DVPSannotationUnit unit, DVPSTextJustification justification);
110 
115  OFCondition setText(const char *text);
116 
121  void removeAnchorPoint();
122 
127  void removeBoundingBox();
128 
132  const char *getText();
133 
138  double getBoundingBoxTLHC_x();
139 
144  double getBoundingBoxTLHC_y();
145 
150  double getBoundingBoxBRHC_x();
151 
156  double getBoundingBoxBRHC_y();
157 
162  DVPSannotationUnit getBoundingBoxAnnotationUnits();
163 
168  DVPSTextJustification getBoundingBoxHorizontalJustification();
169 
174  double getAnchorPoint_x();
175 
180  double getAnchorPoint_y();
181 
186  OFBool anchorPointIsVisible();
187 
192  DVPSannotationUnit getAnchorPointAnnotationUnits();
193 
194 private:
198 
215 
216 };
217 
218 #endif
219 
220 /*
221  * $Log: dvpstx.h,v $
222  * Revision 1.11 2010-10-14 13:16:37 joergr
223  * Updated copyright header. Added reference to COPYRIGHT file.
224  *
225  * Revision 1.10 2010-10-07 14:31:36 joergr
226  * Removed leading underscore characters from preprocessor symbols (reserved).
227  *
228  * Revision 1.9 2009-11-24 14:12:58 uli
229  * Switched to logging mechanism provided by the "new" oflog module.
230  *
231  * Revision 1.8 2005-12-08 16:04:08 meichel
232  * Changed include path schema for all DCMTK header files
233  *
234  * Revision 1.7 2001/09/26 15:36:18 meichel
235  * Adapted dcmpstat to class OFCondition
236  *
237  * Revision 1.6 2001/06/01 15:50:24 meichel
238  * Updated copyright header
239  *
240  * Revision 1.5 2000/06/02 16:00:54 meichel
241  * Adapted all dcmpstat classes to use OFConsole for log and error output
242  *
243  * Revision 1.4 2000/03/08 16:28:58 meichel
244  * Updated copyright header.
245  *
246  * Revision 1.3 1999/07/22 16:39:14 meichel
247  * Adapted dcmpstat data structures and API to supplement 33 letter ballot text.
248  *
249  * Revision 1.2 1998/12/14 16:10:36 meichel
250  * Implemented Presentation State interface for graphic layers,
251  * text and graphic annotations, presentation LUTs.
252  *
253  * Revision 1.1 1998/11/27 14:50:34 meichel
254  * Initial Release.
255  *
256  *
257  */
DcmCodeString anchorPointAnnotationUnits
VR=CS, VM=1, Type 1c.
Definition: dvpstx.h:202
a class representing a list of DICOM elements in which each element has a different tag and elements ...
Definition: dcitem.h:51
DVPSTextObject & operator=(const DVPSTextObject &)
private undefined assignment operator
DVPSTextObject()
default constructor
OFCondition setText(const char *text)
assigns a new "unformatted text value" for this text object.
OFBool haveAnchorPoint()
checks if this text object contains an anchor point.
DcmFloatingPointSingle boundingBoxBRHC
VR=FL, VM=2, Type 1c.
Definition: dvpstx.h:208
double getBoundingBoxBRHC_y()
gets the bounding box BRHC y value.
double getAnchorPoint_y()
gets the anchor point y value.
an item of the text object sequence in a presentation state (internal use only).
Definition: dvpstx.h:43
DVPSannotationUnit getBoundingBoxAnnotationUnits()
gets the bounding box annotation units.
DcmCodeString boundingBoxAnnotationUnits
VR=CS, VM=1, Type 1c.
Definition: dvpstx.h:200
OFBool anchorPointIsVisible()
gets the anchor point visibility May only be called when an anchor point is present (haveAnchorPoint(...
virtual ~DVPSTextObject()
destructor
OFBool haveBoundingBox()
checks if this text object contains bounding box.
const char * getText()
gets the unformatted text value for this text object.
DVPSannotationUnit getAnchorPointAnnotationUnits()
gets the anchor point annotation units.
DcmFloatingPointSingle boundingBoxTLHC
VR=FL, VM=2, Type 1c.
Definition: dvpstx.h:206
DVPSTextJustification getBoundingBoxHorizontalJustification()
gets the bounding box horizontal justification.
OFCondition write(DcmItem &dset)
writes the text object managed by this object to a DICOM dataset.
a class representing the DICOM value representation 'Short Text' (ST)
Definition: dcvrst.h:40
double getBoundingBoxBRHC_x()
gets the bounding box BRHC x value.
double getBoundingBoxTLHC_y()
gets the bounding box TLHC y value.
a class representing the DICOM value representation 'Code String' (CS)
Definition: dcvrcs.h:40
DcmCodeString anchorPointVisibility
VR=CS, VM=1, Type 1c.
Definition: dvpstx.h:214
double getBoundingBoxTLHC_x()
gets the bounding box TLHC x value.
DcmShortText unformattedTextValue
VR=ST, VM=1, Type 1.
Definition: dvpstx.h:204
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.
double getAnchorPoint_x()
gets the anchor point x value.
void removeBoundingBox()
removes any bounding box from the text object.
a class representing the DICOM value representation 'Floating Point Single' (FL)
Definition: dcvrfl.h:40
OFCondition read(DcmItem &dset)
reads a text object from a DICOM dataset.
DVPSTextObject * clone()
clone method.
Definition: dvpstx.h:56
OFCondition setAnchorPoint(double x, double y, DVPSannotationUnit unit, OFBool isVisible)
sets an anchor point for this text object.
DcmFloatingPointSingle anchorPoint
VR=FL, VM=2, Type 1c.
Definition: dvpstx.h:212
DcmCodeString boundingBoxTextHorizontalJustification
VR=CS, VM=1, Type 1c.
Definition: dvpstx.h:210
General purpose class for condition codes.
Definition: ofcond.h:305
void removeAnchorPoint()
removes any anchor point from the text object.


Generated on Wed Dec 14 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.11