/usr/include/dcmtk/dcmsr/dsrsoprf.h is in libdcmtk2-dev 3.6.0-15.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 | /*
*
* Copyright (C) 2002-2010, OFFIS e.V.
* All rights reserved. See COPYRIGHT file for details.
*
* This software and supporting documentation were developed by
*
* OFFIS e.V.
* R&D Division Health
* Escherweg 2
* D-26121 Oldenburg, Germany
*
*
* Module: dcmsr
*
* Author: Joerg Riesmeier
*
* Purpose:
* classes: DSRSOPInstanceReferenceList
* - InstanceStruct, SeriesStruct, StudyStruct
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:16:33 $
* CVS/RCS Revision: $Revision: 1.15 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef DSRSOPRF_H
#define DSRSOPRF_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/ofstd/oflist.h"
#include "dcmtk/ofstd/ofstring.h"
#include "dcmtk/ofstd/ofcond.h"
#include "dcmtk/dcmdata/dcitem.h"
#include "dcmtk/dcmdata/dctagkey.h"
#include "dcmtk/dcmsr/dsrtypes.h"
/*---------------------*
* class declaration *
*---------------------*/
/** Class for SOP instance reference lists
*/
class DSRSOPInstanceReferenceList
: public DSRTypes
{
public:
/** Internal structure defining the instance list items
*/
struct InstanceStruct
{
/** constructor
** @param sopClassUID SOP class UID
** @param instanceUID SOP instance UID
*/
InstanceStruct(const OFString &sopClassUID,
const OFString &instanceUID);
/// SOP class UID (VR=UI, VM=1)
const OFString SOPClassUID;
/// SOP instance UID (VR=UI, VM=1)
const OFString InstanceUID;
};
/** Internal structure defining the series list items
*/
struct SeriesStruct
{
/** constructor
** @param seriesUID series instance UID
*/
SeriesStruct(const OFString &seriesUID);
/** destructor
*/
~SeriesStruct();
/** get number of instance stored in the list of instances
** @return number of instances
*/
size_t getNumberOfInstances() const;
/** read instance level attributes from dataset
** @param dataset DICOM dataset from which the list should be read
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition read(DcmItem &dataset);
/** write series and instance level attributes to dataset
** @param dataset DICOM dataset to which the list should be written
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition write(DcmItem &dataset) const;
/** read series and instance level attributes from XML document
** @param doc document containing the XML file content
* @param cursor cursor pointing to the starting node
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition readXML(const DSRXMLDocument &doc,
DSRXMLCursor cursor);
/** write series and instance level attributes in XML format
** @param stream output stream to which the XML document is written
* @param flags optional flag used to customize the output (see DSRTypes::XF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition writeXML(STD_NAMESPACE ostream &stream,
const size_t flags = 0) const;
/** set cursor to the specified instance (if existent)
** @param instanceUID SOP instance UID of the entry to be searched for
** @return pointer to the instance structure if successful, NULL otherwise
*/
InstanceStruct *gotoInstance(const OFString &instanceUID);
/** select the first item in the list.
* That means the first instance in the current series.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition gotoFirstItem();
/** select the next item in the list.
* That means the next instance in the current series (if available).
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition gotoNextItem();
/** add new entry to the list of instances (if not already existent).
* Finally, the specified item is selected as the current one.
** @param sopClassUID SOP class UID of the entry to be added
* @param instanceUID SOP instance UID of the entry to be added
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition addItem(const OFString &sopClassUID,
const OFString &instanceUID);
/** remove the current item from the list of instances.
* After sucessful removal the cursor is set to the next valid position.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition removeItem();
/// series instance UID (VR=UI, VM=1)
const OFString SeriesUID;
/// optional: retrieve application entity title (VR=AE, VM=1-n)
OFString RetrieveAETitle;
/// optional: storage media file set ID (VR=SH, VM=1)
OFString StorageMediaFileSetID;
/// optional: storage media file set UID (VR=UI, VM=1)
OFString StorageMediaFileSetUID;
/// list of referenced instances
OFList<InstanceStruct *> InstanceList;
/// currently selected instance (cursor)
OFListIterator(InstanceStruct *) Iterator;
};
/** Internal structure defining the study list items
*/
struct StudyStruct
{
/** constructor
** @param studyUID study instance UID
*/
StudyStruct(const OFString &studyUID);
/** destructor
*/
~StudyStruct();
/** get number of instance stored in the list of series
** @return number of instances
*/
size_t getNumberOfInstances() const;
/** read series and instance level from dataset
** @param dataset DICOM dataset from which the list should be read
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition read(DcmItem &dataset);
/** write study, series and instance level attributes to dataset
** @param dataset DICOM dataset to which the list should be written
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition write(DcmItem &dataset) const;
/** read study, series and instance level attributes from XML document
** @param doc document containing the XML file content
* @param cursor cursor pointing to the starting node
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition readXML(const DSRXMLDocument &doc,
DSRXMLCursor cursor);
/** write study, series and instance level attributes in XML format
** @param stream output stream to which the XML document is written
* @param flags optional flag used to customize the output (see DSRTypes::XF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition writeXML(STD_NAMESPACE ostream &stream,
const size_t flags = 0) const;
/** set cursor to the specified series entry (if existent)
** @param seriesUID series instance UID of the entry to be searched for
** @return pointer to the series structure if successful, NULL otherwise
*/
SeriesStruct *gotoSeries(const OFString &seriesUID);
/** set cursor to the specified instance entry (if existent)
** @param instanceUID SOP instance UID of the entry to be searched for
** @return pointer to the instance structure if successful, NULL otherwise
*/
InstanceStruct *gotoInstance(const OFString &instanceUID);
/** select the first item in the list.
* That means the first instance in the first series of the current study.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition gotoFirstItem();
/** select the next item in the list.
* That means the next instance in the current series, or the first instance
* in the next series (if available).
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition gotoNextItem();
/** add new entry to the list of series and instances (if not already existent).
* Finally, the specified items are selected as the current one.
** @param seriesUID series instance UID of the entry to be added
* @param sopClassUID SOP class UID of the entry to be added
* @param instanceUID SOP instance UID of the entry to be added
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition addItem(const OFString &seriesUID,
const OFString &sopClassUID,
const OFString &instanceUID);
/** remove the current item from the list of series and instances.
* After sucessful removal the cursors are set to the next valid position.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition removeItem();
/** remove empty/incomplete items from the list.
* (e.g. series with no instances)
* Please note that this function modifies the value of 'Iterator'.
*/
void removeIncompleteItems();
/// study instance UID (VR=UI, VM=1)
const OFString StudyUID;
/// list of referenced series
OFList<SeriesStruct *> SeriesList;
/// currently selected series (cursor)
OFListIterator(SeriesStruct *) Iterator;
};
/** constructor
** @param sequence DICOM tag specifying the attribute (sequence) of the reference list
*/
DSRSOPInstanceReferenceList(const DcmTagKey &sequence);
/** destructor
*/
~DSRSOPInstanceReferenceList();
/** clear list of references
*/
void clear();
/** check whether list of references is empty
** @return OFTrue if list is empty, OFFalse otherwise
*/
OFBool empty() const;
/** get number of instance stored in the list of references
** @return number of instances
*/
size_t getNumberOfInstances() const;
/** read list of referenced SOP instances.
* The hierarchical structure is automatically reorganized in a way that each study,
* each series (within a study) and each instance (within a series) only exist once,
* i.e. the structure might look different when written back to a dataset. However,
* the content is identical and this way of storing information saves storage space.
** @param dataset DICOM dataset from which the data should be read
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition read(DcmItem &dataset);
/** write list of referenced SOP instances.
* Does nothing if list is empty.
** @param dataset DICOM dataset to which the data should be written
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition write(DcmItem &dataset) const;
/** read list of references from XML document.
* The hierarchical structure is automatically reorganized in a way that each study,
* each series (within a study) and each instance (within a series) only exist once,
* i.e. the structure might look different when written back to a dataset. However,
* the content is identical and this way of storing information saves storage space.
** @param doc document containing the XML file content
* @param cursor cursor pointing to the starting node
* @param flags optional flag used to customize the reading process (see DSRTypes::XF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition readXML(const DSRXMLDocument &doc,
DSRXMLCursor cursor,
const size_t flags);
/** write current list of references in XML format
** @param stream output stream to which the XML data is written
* @param flags optional flag used to customize the output (see DSRTypes::XF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition writeXML(STD_NAMESPACE ostream &stream,
const size_t flags = 0) const;
/** add the specified item to the list of references.
* Internally the item is inserted into the hierarchical structure of studies, series
* and instances, if not already contained in the list. In any case the specified item
* is selected as the current one.
** @param studyUID study instance UID of the entry to be added
* @param seriesUID series instance UID of the entry to be added
* @param sopClassUID SOP class UID of the entry to be added
* @param instanceUID SOP instance UID of the entry to be added
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition addItem(const OFString &studyUID,
const OFString &seriesUID,
const OFString &sopClassUID,
const OFString &instanceUID);
/** add item from specified DICOM dataset to the list of references.
* Internally an item representing the given dataset is inserted into the hierarchical
* structure of studies, series and instances, if not already contained in the list.
* In any case the specified item is selected as the current one.
** @param dataset reference to DICOM dataset from which the relevant UIDs are retrieved
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition addItem(DcmItem &dataset);
/** remove the current item from the list of referenced SOP instances.
* After sucessful removal the cursor is set to the next valid position.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition removeItem();
/** remove the specified item from the list of references.
* After sucessful removal the cursor is set to the next valid position.
** @param sopClassUID SOP class UID of the item to be removed
* @param instanceUID SOP instance UID of the item to be removed
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition removeItem(const OFString &sopClassUID,
const OFString &instanceUID);
/** remove the specified item from the list of references.
* After sucessful removal the cursor is set to the next valid position.
** @param studyUID study instance UID of the item to be removed
* @param seriesUID series instance UID of the item to be removed
* @param instanceUID SOP instance UID of the item to be removed
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition removeItem(const OFString &studyUID,
const OFString &seriesUID,
const OFString &instanceUID);
/** select the specified item as the current one
** @param sopClassUID SOP class UID of the item to be selected
* @param instanceUID SOP instance UID of the item to be selected
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition gotoItem(const OFString &sopClassUID,
const OFString &instanceUID);
/** select the specified item as the current one
** @param studyUID study instance UID of the item to be selected
* @param seriesUID series instance UID of the item to be selected
* @param instanceUID SOP instance UID of the item to be selected
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition gotoItem(const OFString &studyUID,
const OFString &seriesUID,
const OFString &instanceUID);
/** select the first item in the list.
* That means the first instance in the first series of the first study
* is selected (if available).
** @return status, EC_Normal if successful, an error code otherwise.
* (e.g. if the list is empty)
*/
OFCondition gotoFirstItem();
/** select the next item in the list.
* That means the next instance in the current series, or the first instance
* in the next series, or the first instance in the first series of the next
* study is selected (if available). The combination of this function and
* gotoFirstItem() allows to iterate over all referenced SOP instances.
** @return status, EC_Normal if successful, an error code otherwise.
* (e.g. if the end of the list has been reached)
*/
OFCondition gotoNextItem();
/** get the study instance UID of the currently selected entry
** @param stringValue reference to string variable in which the result is stored
** @return reference to the resulting string (might be empty)
*/
const OFString &getStudyInstanceUID(OFString &stringValue) const;
/** get the series instance UID of the currently selected entry
** @param stringValue reference to string variable in which the result is stored
** @return reference to the resulting string (might be empty)
*/
const OFString &getSeriesInstanceUID(OFString &stringValue) const;
/** get the SOP instance UID of the currently selected entry
** @param stringValue reference to string variable in which the result is stored
** @return reference to the resulting string (might be empty)
*/
const OFString &getSOPInstanceUID(OFString &stringValue) const;
/** get the SOP class UID of the currently selected entry
** @param stringValue reference to string variable in which the result is stored
** @return reference to the resulting string (might be empty)
*/
const OFString &getSOPClassUID(OFString &stringValue) const;
/** get the retrieve application entity title of the currently selected entry (optional).
* The resulting string may contain multiple values separated by a backslash ("\").
** @param stringValue reference to string variable in which the result is stored
** @return reference to the resulting string (might be empty)
*/
const OFString &getRetrieveAETitle(OFString &stringValue) const;
/** get the storage media file set ID of the currently selected entry (optional)
** @param stringValue reference to string variable in which the result is stored
** @return reference to the resulting string (might be empty)
*/
const OFString &getStorageMediaFileSetID(OFString &stringValue) const;
/** get the storage media file set UID of the currently selected entry (optional)
** @param stringValue reference to string variable in which the result is stored
** @return reference to the resulting string (might be empty)
*/
const OFString &getStorageMediaFileSetUID(OFString &stringValue) const;
/** set the retrieve application entity title of the currently selected entry.
* Multiple values are to be separated by a backslash ("\").
** @param value string value to be set (use empty string to omit optional attribute)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setRetrieveAETitle(const OFString &value);
/** set the storage media file set ID of the currently selected entry
** @param value string value to be set (use empty string to omit optional attribute)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setStorageMediaFileSetID(const OFString &value);
/** set the storage media file set UID of the currently selected entry
** @param value string value to be set (use empty string to omit optional attribute)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setStorageMediaFileSetUID(const OFString &value);
protected:
/** set cursor to the specified study entry (if existent)
** @param studyUID study instance UID of the entry to be searched for
** @return pointer to the study structure if successful, NULL otherwise
*/
StudyStruct *gotoStudy(const OFString &studyUID);
/** get pointer to currently selected study structure (if any)
** @return pointer to the study structure if successful, NULL otherwise
*/
StudyStruct *getCurrentStudy() const;
/** get pointer to currently selected series structure (if any)
** @return pointer to the series structure if successful, NULL otherwise
*/
SeriesStruct *getCurrentSeries() const;
/** get pointer to currently selected instance structure (if any)
** @return pointer to the instance structure if successful, NULL otherwise
*/
InstanceStruct *getCurrentInstance() const;
/** remove empty/incomplete items from the list.
* (e.g. series with no instances or studies with no series)
* Please note that this function modifies the value of 'Iterator'.
*/
void removeIncompleteItems();
private:
/// DICOM tag specifying the attribute (sequence) of the reference list
const DcmTagKey SequenceTag;
/// list of studies
OFList<StudyStruct *> StudyList;
/// internal cursor to current (selected) list item
OFListIterator(StudyStruct *) Iterator;
// default constructor - not implemented!
DSRSOPInstanceReferenceList();
// copy constructor - not implemented!
DSRSOPInstanceReferenceList(const DSRSOPInstanceReferenceList &);
// assignment operator - not implemented!
DSRSOPInstanceReferenceList &operator=(const DSRSOPInstanceReferenceList &);
};
#endif
/*
* CVS/RCS Log:
* $Log: dsrsoprf.h,v $
* Revision 1.15 2010-10-14 13:16:33 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.14 2010-02-22 11:39:55 uli
* Remove some unneeded includes.
*
* Revision 1.13 2009-10-13 14:57:50 uli
* Switched to logging mechanism provided by the "new" oflog module.
*
* Revision 1.12 2007-11-15 16:33:19 joergr
* Fixed coding style to be more consistent.
*
* Revision 1.11 2006/08/15 16:40:03 meichel
* Updated the code in module dcmsr to correctly compile when
* all standard C++ classes remain in namespace std.
*
* Revision 1.10 2006/05/11 09:18:21 joergr
* Moved containsExtendedCharacters() from dcmsr to dcmdata module.
*
* Revision 1.9 2005/12/08 16:05:18 meichel
* Changed include path schema for all DCMTK header files
*
* Revision 1.8 2005/07/27 16:33:39 joergr
* Added method that allows to add a DICOM dataset to the list of references.
*
* Revision 1.7 2004/11/22 16:39:09 meichel
* Added method that checks if the SR document contains non-ASCII characters
* in any of the strings affected by SpecificCharacterSet.
*
* Revision 1.6 2003/08/07 18:01:42 joergr
* Removed libxml dependency from header files.
*
* Revision 1.5 2003/08/07 12:50:12 joergr
* Added readXML functionality.
* Renamed parameters/variables "string" to avoid name clash with STL class.
* Enhanced class DSRSOPInstanceReferenceList: empty/incomplete items (e.g.
* series with no instances or studies with no series) are automatically
* removed from the list.
*
* Revision 1.4 2002/08/30 14:16:59 joergr
* Removed "friend" statements from class declaration and moved sub-classes to
* the "public" section (required for Sun CC 6).
*
* Revision 1.3 2002/05/14 08:16:07 joergr
* Added removeItem() methods.
*
* Revision 1.2 2002/05/07 14:04:44 joergr
* Added "friend" statements to class declaration (required for MSVC).
*
* Revision 1.1 2002/05/07 12:49:31 joergr
* Added support for the Current Requested Procedure Evidence Sequence and the
* Pertinent Other Evidence Sequence to the dcmsr module.
*
*
*/
|