/usr/include/dcmtk/dcmrt/seq/drtpcs.h is in libdcmtk-dev 3.6.2-3build3.
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 | /*
*
* Copyright (C) 2008-2012, OFFIS e.V. and ICSMED AG, Oldenburg, Germany
* Copyright (C) 2013-2017, J. Riesmeier, Oldenburg, Germany
* All rights reserved. See COPYRIGHT file for details.
*
* Header file for class DRTProcedureCodeSequence
*
* Generated automatically from DICOM PS 3.3-2017a
* File created on 2017-03-13 11:22:36
*
*/
#ifndef DRTPCS_H
#define DRTPCS_H
#include "dcmtk/config/osconfig.h" // make sure OS specific configuration is included first
#include "dcmtk/ofstd/oflist.h" // for standard list class
#include "dcmtk/dcmrt/drttypes.h" // module-specific helper class
#include "dcmtk/dcmrt/seq/drtecs.h" // for EquivalentCodeSequence
/** Interface class for ProcedureCodeSequence (0008,1032)
*/
class DCMTK_DCMRT_EXPORT DRTProcedureCodeSequence
: protected DRTTypes
{
public:
/** Item class
*/
class DCMTK_DCMRT_EXPORT Item
: protected DRTTypes
{
public:
// --- constructors, destructor and operators ---
/** (default) constructor
* @param emptyDefaultItem flag used to mark the empty default item
*/
Item(const OFBool emptyDefaultItem = OFFalse);
/** copy constructor
* @param copy item object to be copied
*/
Item(const Item ©);
/** destructor
*/
virtual ~Item();
/** assigment operator
* @param copy item object to be copied
* @return reference to this object
*/
Item &operator=(const Item ©);
// --- general methods ---
/** clear all internal member variables
*/
void clear();
/** check if item is empty
* @return OFTrue if item is empty, OFFalse otherwise
*/
OFBool isEmpty();
/** check if item is valid, i.e.\ not the empty default item
* @return OFTrue if item is valid, OFFalse otherwise
*/
OFBool isValid() const;
// --- input/output methods ---
/** read elements from sequence item
* @param item reference to DICOM sequence item from which the elements should be read
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition read(DcmItem &item);
/** write elements to sequence item
* @param item reference to DICOM sequence item to which the elements should be written
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition write(DcmItem &item);
// --- get DICOM attribute values ---
/** get CodeMeaning (0008,0104)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getCodeMeaning(OFString &value, const signed long pos = 0) const;
/** get CodeValue (0008,0100)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getCodeValue(OFString &value, const signed long pos = 0) const;
/** get CodingSchemeDesignator (0008,0102)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getCodingSchemeDesignator(OFString &value, const signed long pos = 0) const;
/** get CodingSchemeVersion (0008,0103)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getCodingSchemeVersion(OFString &value, const signed long pos = 0) const;
/** get ContextGroupExtensionCreatorUID (0008,010d)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getContextGroupExtensionCreatorUID(OFString &value, const signed long pos = 0) const;
/** get ContextGroupExtensionFlag (0008,010b)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getContextGroupExtensionFlag(OFString &value, const signed long pos = 0) const;
/** get ContextGroupLocalVersion (0008,0107)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getContextGroupLocalVersion(OFString &value, const signed long pos = 0) const;
/** get ContextGroupVersion (0008,0106)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getContextGroupVersion(OFString &value, const signed long pos = 0) const;
/** get ContextIdentifier (0008,010f)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getContextIdentifier(OFString &value, const signed long pos = 0) const;
/** get ContextUID (0008,0117)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getContextUID(OFString &value, const signed long pos = 0) const;
/** get LongCodeValue (0008,0119)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getLongCodeValue(OFString &value, const signed long pos = 0) const;
/** get MappingResource (0008,0105)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getMappingResource(OFString &value, const signed long pos = 0) const;
/** get MappingResourceName (0008,0122)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getMappingResourceName(OFString &value, const signed long pos = 0) const;
/** get MappingResourceUID (0008,0118)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getMappingResourceUID(OFString &value, const signed long pos = 0) const;
/** get URNCodeValue (0008,0120)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1), -1 for all components
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getURNCodeValue(OFString &value, const signed long pos = 0) const;
// --- get DICOM sequence attributes ---
/** get EquivalentCodeSequence (0008,0121)
* @return reference to sequence element
*/
DRTEquivalentCodeSequence &getEquivalentCodeSequence()
{ return EquivalentCodeSequence; }
/** get EquivalentCodeSequence (0008,0121)
* @return const reference to sequence element
*/
const DRTEquivalentCodeSequence &getEquivalentCodeSequence() const
{ return EquivalentCodeSequence; }
// --- set DICOM attribute values ---
/** set CodeMeaning (0008,0104)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (LO) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setCodeMeaning(const OFString &value, const OFBool check = OFTrue);
/** set CodeValue (0008,0100)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (SH) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setCodeValue(const OFString &value, const OFBool check = OFTrue);
/** set CodingSchemeDesignator (0008,0102)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (SH) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setCodingSchemeDesignator(const OFString &value, const OFBool check = OFTrue);
/** set CodingSchemeVersion (0008,0103)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (SH) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setCodingSchemeVersion(const OFString &value, const OFBool check = OFTrue);
/** set ContextGroupExtensionCreatorUID (0008,010d)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (UI) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setContextGroupExtensionCreatorUID(const OFString &value, const OFBool check = OFTrue);
/** set ContextGroupExtensionFlag (0008,010b)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (CS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setContextGroupExtensionFlag(const OFString &value, const OFBool check = OFTrue);
/** set ContextGroupLocalVersion (0008,0107)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (DT) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setContextGroupLocalVersion(const OFString &value, const OFBool check = OFTrue);
/** set ContextGroupVersion (0008,0106)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (DT) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setContextGroupVersion(const OFString &value, const OFBool check = OFTrue);
/** set ContextIdentifier (0008,010f)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (CS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setContextIdentifier(const OFString &value, const OFBool check = OFTrue);
/** set ContextUID (0008,0117)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (UI) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setContextUID(const OFString &value, const OFBool check = OFTrue);
/** set LongCodeValue (0008,0119)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (UC) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setLongCodeValue(const OFString &value, const OFBool check = OFTrue);
/** set MappingResource (0008,0105)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (CS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setMappingResource(const OFString &value, const OFBool check = OFTrue);
/** set MappingResourceName (0008,0122)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (LO) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setMappingResourceName(const OFString &value, const OFBool check = OFTrue);
/** set MappingResourceUID (0008,0118)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (UI) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setMappingResourceUID(const OFString &value, const OFBool check = OFTrue);
/** set URNCodeValue (0008,0120)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (UR) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setURNCodeValue(const OFString &value, const OFBool check = OFTrue);
private:
/// internal flag used to mark the empty default item
/*const*/ OFBool EmptyDefaultItem;
/// CodeMeaning (0008,0104) vr=LO, vm=1, type=1
DcmLongString CodeMeaning;
/// CodeValue (0008,0100) vr=SH, vm=1, type=1C
DcmShortString CodeValue;
/// CodingSchemeDesignator (0008,0102) vr=SH, vm=1, type=1C
DcmShortString CodingSchemeDesignator;
/// CodingSchemeVersion (0008,0103) vr=SH, vm=1, type=1C
DcmShortString CodingSchemeVersion;
/// ContextGroupExtensionCreatorUID (0008,010d) vr=UI, vm=1, type=1C
DcmUniqueIdentifier ContextGroupExtensionCreatorUID;
/// ContextGroupExtensionFlag (0008,010b) vr=CS, vm=1, type=3
DcmCodeString ContextGroupExtensionFlag;
/// ContextGroupLocalVersion (0008,0107) vr=DT, vm=1, type=1C
DcmDateTime ContextGroupLocalVersion;
/// ContextGroupVersion (0008,0106) vr=DT, vm=1, type=1C
DcmDateTime ContextGroupVersion;
/// ContextIdentifier (0008,010f) vr=CS, vm=1, type=3
DcmCodeString ContextIdentifier;
/// ContextUID (0008,0117) vr=UI, vm=1, type=3
DcmUniqueIdentifier ContextUID;
/// EquivalentCodeSequence (0008,0121) vr=SQ, vm=1, type=3
DRTEquivalentCodeSequence EquivalentCodeSequence;
/// LongCodeValue (0008,0119) vr=UC, vm=1, type=1C
DcmUnlimitedCharacters LongCodeValue;
/// MappingResource (0008,0105) vr=CS, vm=1, type=1C
DcmCodeString MappingResource;
/// MappingResourceName (0008,0122) vr=LO, vm=1, type=3
DcmLongString MappingResourceName;
/// MappingResourceUID (0008,0118) vr=UI, vm=1, type=3
DcmUniqueIdentifier MappingResourceUID;
/// URNCodeValue (0008,0120) vr=UR, vm=1, type=1C
DcmUniversalResourceIdentifierOrLocator URNCodeValue;
};
// --- constructors, destructor and operators ---
/** (default) constructor
* @param emptyDefaultSequence internal flag used to mark the empty default sequence
*/
DRTProcedureCodeSequence(const OFBool emptyDefaultSequence = OFFalse);
/** copy constructor
* @param copy sequence object to be copied
*/
DRTProcedureCodeSequence(const DRTProcedureCodeSequence ©);
/** destructor
*/
virtual ~DRTProcedureCodeSequence();
/** assigment operator
* @param copy sequence object to be copied
* @return reference to this object
*/
DRTProcedureCodeSequence &operator=(const DRTProcedureCodeSequence ©);
// --- general methods ---
/** clear all internal member variables
*/
void clear();
/** check if sequence is empty
* @return OFTrue if sequence is empty, OFFalse otherwise
*/
OFBool isEmpty();
/** check if sequence is valid, i.e.\ not the empty default sequence
* @return OFTrue if sequence is valid, OFFalse otherwise
*/
OFBool isValid() const;
/** get number of items in the sequence
* @return number of items
*/
size_t getNumberOfItems() const;
/** goto first item in the sequence
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition gotoFirstItem();
/** goto next item in the sequence
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition gotoNextItem();
/** goto particular item in the sequence
* @param num number of the item to be selected (0..num-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition gotoItem(const size_t num);
/** get current item in the sequence
* @param item reference to item pointer (result variable)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getCurrentItem(Item *&item) const;
/** get current item in the sequence
* @return reference to specified item if successful, empty default item otherwise
*/
Item &getCurrentItem();
/** get current item in the sequence
* @return const reference to specified item if successful, empty default item otherwise
*/
const Item &getCurrentItem() const;
/** get particular item in the sequence
* @param num number of the item to be retrieved (0..num-1)
* @param item reference to item pointer (result variable)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getItem(const size_t num, Item *&item);
/** get particular item in the sequence
* @param num number of the item to be retrieved (0..num-1)
* @return reference to specified item if successful, empty default item otherwise
*/
Item &getItem(const size_t num);
/** get particular item in the sequence
* @param num number of the item to be retrieved (0..num-1)
* @return const reference to specified item if successful, empty default item otherwise
*/
const Item &getItem(const size_t num) const;
/** get particular item in the sequence
* @param num number of the item to be retrieved (0..num-1)
* @return reference to specified item if successful, empty default item otherwise
*/
Item &operator[](const size_t num);
/** get particular item in the sequence
* @param num number of the item to be retrieved (0..num-1)
* @return const reference to specified item if successful, empty default item otherwise
*/
const Item &operator[](const size_t num) const;
/** add new item to the end of this sequence
* @param item reference to new item pointer (result variable)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition addItem(Item *&item);
/** insert new item into the sequence
* @param pos position where the new item is to be inserted (0..num)
* @param item reference to new item pointer (result variable)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition insertItem(const size_t pos, Item *&item);
/** remove particular item from the sequence
* @param pos position of the item to be removed (0..num-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition removeItem(const size_t pos);
// --- input/output methods ---
/** read sequence of items from dataset
* @param dataset reference to DICOM dataset from which the sequence should be read
* @param card cardinality (valid range for number of items)
* @param type value type (valid value: "1", "1C", "2" or something else which is not checked)
* @param moduleName optional module/sequence name to be printed (default: "RT object" if NULL)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition read(DcmItem &dataset,
const OFString &card,
const OFString &type,
const char *moduleName = NULL);
/** write sequence of items to dataset
* @param dataset reference to DICOM dataset to which the sequence should be written
* @param card cardinality (valid range for number of items)
* @param type value type (valid value: "1", "2" or something else which is not checked)
* @param moduleName optional module/sequence name to be printed (default: "RT object" if NULL)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition write(DcmItem &dataset,
const OFString &card,
const OFString &type,
const char *moduleName = NULL);
protected:
/** goto particular item in the sequence
* @param num number of the item to be selected (0..num-1)
* @param iterator list iterator storing the position of the item
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition gotoItem(const size_t num,
OFListIterator(Item *) &iterator);
/** goto particular item in the sequence
* @param num number of the item to be selected (0..num-1)
* @param iterator list iterator storing the position of the item
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition gotoItem(const size_t num,
OFListConstIterator(Item *) &iterator) const;
private:
/// internal flag used to mark the empty default sequence
/*const*/ OFBool EmptyDefaultSequence;
/// list of items in this sequence
OFList<Item *> SequenceOfItems;
/// currently selected item
OFListIterator(Item *) CurrentItem;
/// empty default item
Item EmptyItem;
};
#endif
|