OFFIS DCMTK  Version 3.6.0
dvpsril.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: DVPSReferencedImage_PList
20  *
21  * Last Update: $Author: joergr $
22  * Update Date: $Date: 2010-10-14 13:16:36 $
23  * CVS/RCS Revision: $Revision: 1.14 $
24  * Status: $State: Exp $
25  *
26  * CVS/RCS Log at end of file
27  *
28  */
29 
30 #ifndef DVPSRIL_H
31 #define DVPSRIL_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 
39 
47 {
48 public:
51 
54 
60 
63 
72  OFCondition read(DcmItem &dset);
73 
80  OFCondition write(DcmItem &dset);
81 
86  void clear();
87 
94  OFBool isValid(OFString& sopclassuid);
95 
101  DVPSReferencedImage *findImageReference(const char *sopinstanceuid);
102 
109  void removeFrameReference(const char *sopinstanceuid, unsigned long frame, unsigned long numberOfFrames);
110 
115  void removeImageReference(const char *sopinstanceuid);
116 
128  const char *sopclassUID,
129  const char *instanceUID,
130  const char *frames=NULL);
131 
143  const char *sopclassUID,
144  const char *instanceUID,
145  unsigned long frame,
146  DVPSObjectApplicability applicability);
147 
161  DVPSReferencedSeries_PList& allReferences,
162  const char *instanceUID,
163  unsigned long frame,
164  unsigned long numberOfFrames,
165  DVPSObjectApplicability applicability);
166 
170  size_t size() const { return list_.size(); }
171 
180  size_t idx,
181  OFString& sopclassUID,
182  OFString& instanceUID,
183  OFString& frames);
184 
191  OFBool isApplicable(const char *instanceUID, unsigned long frame);
192 
200  OFBool matchesApplicability(const char *instanceUID, unsigned long frame, DVPSObjectApplicability applicability);
201 
202 private:
203 
206 
210 
211 };
212 
213 
214 #endif
215 
216 /*
217  * $Log: dvpsril.h,v $
218  * Revision 1.14 2010-10-14 13:16:36 joergr
219  * Updated copyright header. Added reference to COPYRIGHT file.
220  *
221  * Revision 1.13 2010-10-07 14:31:36 joergr
222  * Removed leading underscore characters from preprocessor symbols (reserved).
223  *
224  * Revision 1.12 2009-11-24 14:12:57 uli
225  * Switched to logging mechanism provided by the "new" oflog module.
226  *
227  * Revision 1.11 2009-09-30 10:42:38 uli
228  * Make dcmpstat's include headers self-sufficient by including all
229  * needed headers directly and stop using dctk.h
230  *
231  * Revision 1.10 2005-12-08 16:04:00 meichel
232  * Changed include path schema for all DCMTK header files
233  *
234  * Revision 1.9 2003/06/04 10:18:06 meichel
235  * Replaced private inheritance from template with aggregation
236  *
237  * Revision 1.8 2001/09/26 15:36:15 meichel
238  * Adapted dcmpstat to class OFCondition
239  *
240  * Revision 1.7 2001/06/01 15:50:20 meichel
241  * Updated copyright header
242  *
243  * Revision 1.6 2000/06/02 16:00:50 meichel
244  * Adapted all dcmpstat classes to use OFConsole for log and error output
245  *
246  * Revision 1.5 2000/03/08 16:28:55 meichel
247  * Updated copyright header.
248  *
249  * Revision 1.4 1999/07/22 16:39:10 meichel
250  * Adapted dcmpstat data structures and API to supplement 33 letter ballot text.
251  *
252  * Revision 1.3 1999/01/15 17:33:03 meichel
253  * added methods to DVPresentationState allowing to access the image
254  * references in the presentation state. Also added methods allowing to
255  * get the width and height of the attached image.
256  *
257  * Revision 1.2 1998/12/14 16:10:33 meichel
258  * Implemented Presentation State interface for graphic layers,
259  * text and graphic annotations, presentation LUTs.
260  *
261  * Revision 1.1 1998/11/27 14:50:32 meichel
262  * Initial Release.
263  *
264  *
265  */
void clear()
reset the object to initial state.
OFCondition read(DcmItem &dset)
reads a list of image references (ReferencedImageSequence) from a DICOM dataset.
void removeFrameReference(const char *sopinstanceuid, unsigned long frame, unsigned long numberOfFrames)
update the reference to the given image such that the given frame is not referenced any more...
a class representing a list of DICOM elements in which each element has a different tag and elements ...
Definition: dcitem.h:51
virtual ~DVPSReferencedImage_PList()
destructor
DVPSReferencedImage_PList & operator=(const DVPSReferencedImage_PList &)
private undefined assignment operator
OFBool isValid(OFString &sopclassuid)
checks if images are referenced within this ReferencedImageSequence and whether all images share the ...
OFCondition getImageReference(size_t idx, OFString &sopclassUID, OFString &instanceUID, OFString &frames)
gets an image reference with the given index.
DVPSReferencedImage * findImageReference(const char *sopinstanceuid)
checks if an image reference with the given SOP instance UID exists in this ReferencedImageSequence.
OFList< DVPSReferencedImage * > list_
the list maintained by this object
Definition: dvpsril.h:209
size_t size() const
gets the number of image references in this list.
Definition: dvpsril.h:170
an item of the referenced image sequence in a presentation state (internal use only).
Definition: dvpsri.h:43
the list of referenced series contained in a presentation state (internal use only).
Definition: dvpsrsl.h:45
OFCondition addImageReference(const char *sopclassUID, const char *instanceUID, const char *frames=NULL)
add a new image reference.
OFBool isApplicable(const char *instanceUID, unsigned long frame)
checks if the object containing this list of image references is applicable to the given image and fr...
OFCondition write(DcmItem &dset)
writes the list of image references managed by this object to a DICOM dataset.
a simple string class that implements a subset of std::string.
Definition: ofstring.h:86
DVPSReferencedImage_PList * clone()
clone method.
Definition: dvpsril.h:59
size_t size() const
returns number of elements in the list.
Definition: oflist.h:358
OFBool matchesApplicability(const char *instanceUID, unsigned long frame, DVPSObjectApplicability applicability)
checks if the object containing this list of image references matches exactly the applicability defin...
void removeImageReference(const char *sopinstanceuid)
checks if an image reference with the given SOP instance UID exists in this ReferencedImageSequence a...
the list of referenced images contained in a presentation state (internal use only).
Definition: dvpsril.h:46
DVPSReferencedImage_PList()
default constructor
General purpose class for condition codes.
Definition: ofcond.h:305


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