OFFIS DCMTK  Version 3.6.0
dvpsrs.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: DVPSReferencedSeries
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 DVPSRS_H
31 #define DVPSRS_H
32 
33 #include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
34 #include "dcmtk/dcmpstat/dvpsril.h" /* for DVPSReferencedImage_PList */
35 #include "dcmtk/dcmdata/dcvrae.h"
36 #include "dcmtk/dcmdata/dcvrsh.h"
37 #include "dcmtk/dcmdata/dcvrui.h"
38 
45 {
46 public:
49 
52 
58 
60  virtual ~DVPSReferencedSeries();
61 
71  OFCondition read(DcmItem &dset);
72 
79  OFCondition write(DcmItem &dset);
80 
89  OFBool isValid(OFString& sopclassuid);
90 
96  OFBool isSeriesUID(const char *uid);
97 
98 
104  DVPSReferencedImage *findImageReference(const char *sopinstanceuid);
105 
111  void removeImageReference(const char *sopinstanceuid);
112 
116  void setSeriesInstanceUID(const char *uid);
117 
123  void setRetrieveLocation(const char *aetitle=NULL, const char *filesetID=NULL, const char *filesetUID=NULL);
124 
128  const char *getRetrieveAETitle();
129 
133  const char *getStorageMediaFileSetID();
134 
138  const char *getStorageMediaFileSetUID();
139 
154  const char *sopclassUID,
155  const char *instanceUID,
156  const char *frames=NULL);
157 
161  size_t numberOfImageReferences() const { return referencedImageList.size(); }
162 
175  size_t idx,
176  OFString& seriesUID,
177  OFString& sopclassUID,
178  OFString& instanceUID,
179  OFString& frames,
180  OFString& aetitle,
181  OFString& filesetID,
182  OFString& filesetUID);
183 
184 private:
185 
188 
199 
200 };
201 
202 #endif
203 
204 /*
205  * $Log: dvpsrs.h,v $
206  * Revision 1.14 2010-10-14 13:16:36 joergr
207  * Updated copyright header. Added reference to COPYRIGHT file.
208  *
209  * Revision 1.13 2010-10-07 14:31:36 joergr
210  * Removed leading underscore characters from preprocessor symbols (reserved).
211  *
212  * Revision 1.12 2010-03-01 09:08:49 uli
213  * Removed some unnecessary include directives in the headers.
214  *
215  * Revision 1.11 2009-11-24 14:12:57 uli
216  * Switched to logging mechanism provided by the "new" oflog module.
217  *
218  * Revision 1.10 2009-09-30 10:42:38 uli
219  * Make dcmpstat's include headers self-sufficient by including all
220  * needed headers directly and stop using dctk.h
221  *
222  * Revision 1.9 2005-12-08 16:04:01 meichel
223  * Changed include path schema for all DCMTK header files
224  *
225  * Revision 1.8 2001/09/26 15:36:15 meichel
226  * Adapted dcmpstat to class OFCondition
227  *
228  * Revision 1.7 2001/06/01 15:50:21 meichel
229  * Updated copyright header
230  *
231  * Revision 1.6 2000/06/02 16:00:51 meichel
232  * Adapted all dcmpstat classes to use OFConsole for log and error output
233  *
234  * Revision 1.5 2000/03/08 16:28:56 meichel
235  * Updated copyright header.
236  *
237  * Revision 1.4 1999/07/22 16:39:10 meichel
238  * Adapted dcmpstat data structures and API to supplement 33 letter ballot text.
239  *
240  * Revision 1.3 1999/01/15 17:33:04 meichel
241  * added methods to DVPresentationState allowing to access the image
242  * references in the presentation state. Also added methods allowing to
243  * get the width and height of the attached image.
244  *
245  * Revision 1.2 1998/12/14 16:10:33 meichel
246  * Implemented Presentation State interface for graphic layers,
247  * text and graphic annotations, presentation LUTs.
248  *
249  * Revision 1.1 1998/11/27 14:50:32 meichel
250  * Initial Release.
251  *
252  *
253  */
a class representing a list of DICOM elements in which each element has a different tag and elements ...
Definition: dcitem.h:51
size_t numberOfImageReferences() const
gets the number of image references in this object.
Definition: dvpsrs.h:161
DVPSReferencedSeries & operator=(const DVPSReferencedSeries &)
private undefined assignment operator
DVPSReferencedImage_PList referencedImageList
Referenced Image Sequence.
Definition: dvpsrs.h:190
a class representing the DICOM value representation 'Unique Identifier' (UI)
Definition: dcvrui.h:39
DVPSReferencedImage * findImageReference(const char *sopinstanceuid)
checks if an image reference with the given SOP instance UID exists in the ReferencedImageSequence of...
virtual ~DVPSReferencedSeries()
destructor
OFBool isValid(OFString &sopclassuid)
check if the passed SOP Class UID is equal to the ones stored in this object.
OFCondition addImageReference(const char *sopclassUID, const char *instanceUID, const char *frames=NULL)
add image reference to this series reference.
void setSeriesInstanceUID(const char *uid)
set Series Instance UID of this series reference.
an item of the referenced series sequence in a presentation state (internal use only).
Definition: dvpsrs.h:44
size_t size() const
gets the number of image references in this list.
Definition: dvpsril.h:170
OFCondition getImageReference(size_t idx, OFString &seriesUID, OFString &sopclassUID, OFString &instanceUID, OFString &frames, OFString &aetitle, OFString &filesetID, OFString &filesetUID)
gets an image reference with the given index.
DcmUniqueIdentifier seriesInstanceUID
VR=UI, VM=1, Type 1c.
Definition: dvpsrs.h:192
OFBool isSeriesUID(const char *uid)
compare SOP Instance UID.
DVPSReferencedSeries * clone()
clone method.
Definition: dvpsrs.h:57
OFCondition read(DcmItem &dset)
reads an series reference from a DICOM dataset.
DcmUniqueIdentifier storageMediaFileSetUID
VR=UI, VM=1, Type 3.
Definition: dvpsrs.h:198
a class representing the DICOM value representation 'Short String' (SH)
Definition: dcvrsh.h:40
an item of the referenced image sequence in a presentation state (internal use only).
Definition: dvpsri.h:43
DcmShortString storageMediaFileSetID
VR=SH, VM=1, Type 3.
Definition: dvpsrs.h:196
DVPSReferencedSeries()
default constructor
void removeImageReference(const char *sopinstanceuid)
remove image reference from this series reference if present.
const char * getRetrieveAETitle()
gets the retrieveAETitle for this series reference.
DcmApplicationEntity retrieveAETitle
VR=AE, VM=1, Type 3.
Definition: dvpsrs.h:194
a simple string class that implements a subset of std::string.
Definition: ofstring.h:86
const char * getStorageMediaFileSetUID()
gets the storageMediaFileSetUID for this series reference.
const char * getStorageMediaFileSetID()
gets the storageMediaFileSetID for this series reference.
void setRetrieveLocation(const char *aetitle=NULL, const char *filesetID=NULL, const char *filesetUID=NULL)
set the optional retrieve location for this series reference.
a class representing the DICOM value representation 'Application Entity' (AE)
Definition: dcvrae.h:40
OFCondition write(DcmItem &dset)
writes the series reference managed by this object to a DICOM dataset.
the list of referenced images contained in a presentation state (internal use only).
Definition: dvpsril.h:46
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