OFFIS DCMTK  Version 3.6.0
dvpsabl.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: DVPSAnnotationContent_PList
20  *
21  * Last Update: $Author: joergr $
22  * Update Date: $Date: 2010-10-14 13:16:36 $
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 DVPSABL_H
31 #define DVPSABL_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 
45 {
46 public:
47 
50 
53 
59 
62 
71  OFCondition read(DcmItem &dset);
72 
79  OFCondition write(DcmItem &dset);
80 
85  void clear();
86 
90  size_t size() const { return list_.size(); }
91 
99  const char *instanceuid,
100  const char *text,
101  Uint16 position);
102 
107  OFCondition deleteAnnotation(size_t idx);
108 
113  OFCondition deleteMultipleAnnotations(size_t number);
114 
120  OFCondition setAnnotationSOPInstanceUID(size_t idx, const char *value);
121 
126  const char *getSOPInstanceUID(size_t idx);
127 
136  OFCondition prepareBasicAnnotationBox(size_t idx, DcmItem &dset);
137 
141 
142 private:
143 
147 
154 
158 
159 };
160 
161 
162 #endif
163 
164 /*
165  * $Log: dvpsabl.h,v $
166  * Revision 1.11 2010-10-14 13:16:36 joergr
167  * Updated copyright header. Added reference to COPYRIGHT file.
168  *
169  * Revision 1.10 2010-10-07 14:31:35 joergr
170  * Removed leading underscore characters from preprocessor symbols (reserved).
171  *
172  * Revision 1.9 2009-11-24 14:12:57 uli
173  * Switched to logging mechanism provided by the "new" oflog module.
174  *
175  * Revision 1.8 2009-09-30 10:42:38 uli
176  * Make dcmpstat's include headers self-sufficient by including all
177  * needed headers directly and stop using dctk.h
178  *
179  * Revision 1.7 2005-12-08 16:03:33 meichel
180  * Changed include path schema for all DCMTK header files
181  *
182  * Revision 1.6 2003/06/04 10:18:06 meichel
183  * Replaced private inheritance from template with aggregation
184  *
185  * Revision 1.5 2001/09/26 15:36:08 meichel
186  * Adapted dcmpstat to class OFCondition
187  *
188  * Revision 1.4 2001/06/01 15:50:12 meichel
189  * Updated copyright header
190  *
191  * Revision 1.3 2000/06/02 16:00:42 meichel
192  * Adapted all dcmpstat classes to use OFConsole for log and error output
193  *
194  * Revision 1.2 2000/03/08 16:28:48 meichel
195  * Updated copyright header.
196  *
197  * Revision 1.1 1999/10/19 14:46:05 meichel
198  * added support for the Basic Annotation Box SOP Class
199  * as well as access methods for Max Density and Min Density.
200  *
201  *
202  */
a class representing a list of DICOM elements in which each element has a different tag and elements ...
Definition: dcitem.h:51
DVPSAnnotationContent_PList()
default constructor
size_t size() const
returns number of elements in the list.
Definition: oflist.h:358
DVPSAnnotationContent_PList * clone()
clone method.
Definition: dvpsabl.h:58
OFCondition addAnnotationBox(const char *instanceuid, const char *text, Uint16 position)
creates a new annotation object and sets the content of this annotation object.
OFCondition deleteAnnotation(size_t idx)
deletes one of the registered annotations.
OFCondition read(DcmItem &dset)
reads a list of annotations (AnnotationContentSequence) from a DICOM dataset.
OFCondition deleteMultipleAnnotations(size_t number)
deletes multiple of the registered annotations, starting with the first one.
the representation of a Annotation Content SQ item for Stored Print
Definition: dvpsab.h:42
void clearAnnotationSOPInstanceUIDs()
removes all UIDs from the annotation boxes managed by this object
the list of Annotations contained in a stored print object.
Definition: dvpsabl.h:44
const char * getSOPInstanceUID(size_t idx)
gets the current SOP Instance UID for the given registered annotation.
DVPSAnnotationContent * getAnnotationBox(size_t idx)
returns a pointer to the annotation with the given index or NULL if it does not exist.
OFCondition setAnnotationSOPInstanceUID(size_t idx, const char *value)
sets the SOP instance UID for the given annotation.
OFCondition prepareBasicAnnotationBox(size_t idx, DcmItem &dset)
writes the attributes managed by the referenced object that are part of a basic annotation box N-SET ...
DVPSAnnotationContent_PList & operator=(const DVPSAnnotationContent_PList &)
private undefined assignment operator
OFCondition write(DcmItem &dset)
writes the list of annotations managed by this object to a DICOM dataset.
virtual ~DVPSAnnotationContent_PList()
destructor
size_t size() const
gets the number of annotations in this list.
Definition: dvpsabl.h:90
OFList< DVPSAnnotationContent * > list_
the list maintained by this object
Definition: dvpsabl.h:157
General purpose class for condition codes.
Definition: ofcond.h:305
void clear()
reset the object to initial state.


Generated on Wed Dec 28 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.8