OFFIS DCMTK  Version 3.6.0
dvpsgal.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: DVPSGraphicAnnotation_PList
20  *
21  * Last Update: $Author: joergr $
22  * Update Date: $Date: 2010-10-14 13:16:36 $
23  * CVS/RCS Revision: $Revision: 1.13 $
24  * Status: $State: Exp $
25  *
26  * CVS/RCS Log at end of file
27  *
28  */
29 
30 #ifndef DVPSGAL_H
31 #define DVPSGAL_H
32 
33 #include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
34 #include "dcmtk/dcmdata/dcitem.h"
35 #include "dcmtk/dcmpstat/dvpstyp.h" /* for enum types */
36 
38 class DVPSTextObject;
39 class DVPSGraphicObject;
40 
47 {
48 public:
51 
54 
60 
63 
73  OFCondition read(DcmItem &dset);
74 
81  OFCondition write(DcmItem &dset);
82 
87  void clear();
88 
96  void renameLayer(const char *oldName, const char *newName);
97 
102  void removeLayer(const char *name);
103 
107  void cleanupLayers();
108 
114  OFBool usesLayerName(const char *name);
115 
123  size_t getNumberOfTextObjects(const char *layer, const char *instanceUID, unsigned long frame);
124 
134  DVPSTextObject *getTextObject(const char *layer, const char *instanceUID, unsigned long frame, size_t idx);
135 
152  const char *layer,
153  const char *sopclassUID,
154  const char *instanceUID,
155  unsigned long frame,
156  DVPSObjectApplicability applicability,
157  DVPSTextObject *text=NULL);
158 
167  OFCondition removeTextObject(const char *layer, const char *instanceUID, unsigned long frame, size_t idx);
168 
181  const char *old_layer,
182  const char *sopclassUID,
183  const char *instanceUID,
184  unsigned long frame,
185  size_t idx,
186  DVPSObjectApplicability applicability,
187  const char *new_layer);
188 
196  size_t getNumberOfGraphicObjects(const char *layer, const char *instanceUID, unsigned long frame);
197 
207  DVPSGraphicObject *getGraphicObject(const char *layer, const char *instanceUID, unsigned long frame, size_t idx);
208 
224  const char *layer,
225  const char *sopclassUID,
226  const char *instanceUID,
227  unsigned long frame,
228  DVPSObjectApplicability applicability,
229  DVPSGraphicObject *graphic=NULL);
230 
239  OFCondition removeGraphicObject(const char *layer, const char *instanceUID, unsigned long frame, size_t idx);
240 
253  const char *old_layer,
254  const char *sopclassUID,
255  const char *instanceUID,
256  unsigned long frame,
257  size_t idx,
258  DVPSObjectApplicability applicability,
259  const char *new_layer);
260 
261 private:
262 
265 
269 
270 };
271 
272 #endif
273 
274 /*
275  * $Log: dvpsgal.h,v $
276  * Revision 1.13 2010-10-14 13:16:36 joergr
277  * Updated copyright header. Added reference to COPYRIGHT file.
278  *
279  * Revision 1.12 2010-10-07 14:31:35 joergr
280  * Removed leading underscore characters from preprocessor symbols (reserved).
281  *
282  * Revision 1.11 2009-11-24 14:12:57 uli
283  * Switched to logging mechanism provided by the "new" oflog module.
284  *
285  * Revision 1.10 2009-09-30 10:42:38 uli
286  * Make dcmpstat's include headers self-sufficient by including all
287  * needed headers directly and stop using dctk.h
288  *
289  * Revision 1.9 2005-12-08 16:03:44 meichel
290  * Changed include path schema for all DCMTK header files
291  *
292  * Revision 1.8 2003/06/04 10:18:06 meichel
293  * Replaced private inheritance from template with aggregation
294  *
295  * Revision 1.7 2001/09/26 15:36:10 meichel
296  * Adapted dcmpstat to class OFCondition
297  *
298  * Revision 1.6 2001/06/01 15:50:15 meichel
299  * Updated copyright header
300  *
301  * Revision 1.5 2000/06/02 16:00:46 meichel
302  * Adapted all dcmpstat classes to use OFConsole for log and error output
303  *
304  * Revision 1.4 2000/03/08 16:28:51 meichel
305  * Updated copyright header.
306  *
307  * Revision 1.3 1999/07/22 16:39:07 meichel
308  * Adapted dcmpstat data structures and API to supplement 33 letter ballot text.
309  *
310  * Revision 1.2 1998/12/14 16:10:28 meichel
311  * Implemented Presentation State interface for graphic layers,
312  * text and graphic annotations, presentation LUTs.
313  *
314  * Revision 1.1 1998/11/27 14:50:26 meichel
315  * Initial Release.
316  *
317  *
318  */
a class representing a list of DICOM elements in which each element has a different tag and elements ...
Definition: dcitem.h:51
OFCondition moveGraphicObject(const char *old_layer, const char *sopclassUID, const char *instanceUID, unsigned long frame, size_t idx, DVPSObjectApplicability applicability, const char *new_layer)
moves the graphic object with the given index on the given layer to a different layer.
OFCondition removeTextObject(const char *layer, const char *instanceUID, unsigned long frame, size_t idx)
deletes the text object (applicable to the current image and frame) with the given index on the given...
void clear()
reset the object to initial state.
OFCondition read(DcmItem &dset)
reads a list of graphic annotations from a DICOM dataset.
size_t getNumberOfGraphicObjects(const char *layer, const char *instanceUID, unsigned long frame)
returns the number of graphic objects for the given graphic layer.
an item of the text object sequence in a presentation state (internal use only).
Definition: dvpstx.h:43
OFCondition moveTextObject(const char *old_layer, const char *sopclassUID, const char *instanceUID, unsigned long frame, size_t idx, DVPSObjectApplicability applicability, const char *new_layer)
moves the text object (applicable to the current image and frame) with the given index on the given l...
OFList< DVPSGraphicAnnotation * > list_
the list maintained by this object
Definition: dvpsgal.h:268
OFCondition removeGraphicObject(const char *layer, const char *instanceUID, unsigned long frame, size_t idx)
deletes the graphic object with the given index on the given layer.
virtual ~DVPSGraphicAnnotation_PList()
destructor
an item of the graphic annotation sequence in a presentation state (internal use only).
Definition: dvpsga.h:46
size_t getNumberOfTextObjects(const char *layer, const char *instanceUID, unsigned long frame)
returns the number of text objects for the given graphic layer that apply to the given image and fram...
DVPSTextObject * getTextObject(const char *layer, const char *instanceUID, unsigned long frame, size_t idx)
gets the text object (applicable to the current image and frame) with the given index on the given la...
DVPSGraphicAnnotation_PList & operator=(const DVPSGraphicAnnotation_PList &)
private undefined assignment operator
DVPSGraphicAnnotation_PList()
default constructor
an item of the graphic object sequence in a presentation state (internal use only).
Definition: dvpsgr.h:43
OFCondition write(DcmItem &dset)
writes the list of graphic annotations managed by this object to a DICOM dataset. ...
void renameLayer(const char *oldName, const char *newName)
renames the graphic annotation layer name in all activations with a matching old graphic annotation l...
the list of graphic annotations contained in a presentation state (internal use only).
Definition: dvpsgal.h:46
DVPSTextObject * addTextObject(const char *layer, const char *sopclassUID, const char *instanceUID, unsigned long frame, DVPSObjectApplicability applicability, DVPSTextObject *text=NULL)
creates a new text object on the given layer.
DVPSGraphicObject * addGraphicObject(const char *layer, const char *sopclassUID, const char *instanceUID, unsigned long frame, DVPSObjectApplicability applicability, DVPSGraphicObject *graphic=NULL)
creates a new graphic object on the given layer.
void removeLayer(const char *name)
deletes all graphic annotation layers belonging to the given graphic annotation layer name...
OFBool usesLayerName(const char *name)
checks if the given layer name is used for any of the graphic annotation layers managed by this objec...
DVPSGraphicAnnotation_PList * clone()
clone method.
Definition: dvpsgal.h:59
void cleanupLayers()
deletes all graphic annotation sequence items containing no text and no graphic object.
DVPSGraphicObject * getGraphicObject(const char *layer, const char *instanceUID, unsigned long frame, size_t idx)
gets the graphic object with the given index on the given layer.
General purpose class for condition codes.
Definition: ofcond.h:305


Generated on Sun Aug 23 2015 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.9.1