/usr/include/dcmtk/dcmrt/seq/drtibs.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 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 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 | /*
*
* 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 DRTIonBeamSequence
*
* Generated automatically from DICOM PS 3.3-2017a
* File created on 2017-03-13 11:22:36
*
*/
#ifndef DRTIBS_H
#define DRTIBS_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/drtas6.h" // for ApplicatorSequence
#include "dcmtk/dcmrt/seq/drtddps.h" // for DepthDoseParametersSequence
#include "dcmtk/dcmrt/seq/drtgas.h" // for GeneralAccessorySequence
#include "dcmtk/dcmrt/seq/drtiblds.h" // for IonBeamLimitingDeviceSequence
#include "dcmtk/dcmrt/seq/drtibls.h" // for IonBlockSequence
#include "dcmtk/dcmrt/seq/drticps.h" // for IonControlPointSequence
#include "dcmtk/dcmrt/seq/drtircs.h" // for IonRangeCompensatorSequence
#include "dcmtk/dcmrt/seq/drtiws.h" // for IonWedgeSequence
#include "dcmtk/dcmrt/seq/drtlsds.h" // for LateralSpreadingDeviceSequence
#include "dcmtk/dcmrt/seq/drtrms.h" // for RangeModulatorSequence
#include "dcmtk/dcmrt/seq/drtrshs.h" // for RangeShifterSequence
#include "dcmtk/dcmrt/seq/drtrbos6.h" // for ReferencedBolusSequence
#include "dcmtk/dcmrt/seq/drtrds.h" // for ReferencedDoseSequence
#include "dcmtk/dcmrt/seq/drtrris6.h" // for ReferencedReferenceImageSequence
#include "dcmtk/dcmrt/seq/drtsns.h" // for SnoutSequence
/** Interface class for IonBeamSequence (300a,03a2) in RTIonBeamsModule
*/
class DCMTK_DCMRT_EXPORT DRTIonBeamSequence
: 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 BeamDescription (300a,00c3)
* @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 getBeamDescription(OFString &value, const signed long pos = 0) const;
/** get BeamName (300a,00c2)
* @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 getBeamName(OFString &value, const signed long pos = 0) const;
/** get BeamNumber (300a,00c0)
* @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 getBeamNumber(OFString &value, const signed long pos = 0) const;
/** get BeamNumber (300a,00c0)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getBeamNumber(Sint32 &value, const unsigned long pos = 0) const;
/** get BeamType (300a,00c4)
* @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 getBeamType(OFString &value, const signed long pos = 0) const;
/** get DeviceSerialNumber (0018,1000)
* @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 getDeviceSerialNumber(OFString &value, const signed long pos = 0) const;
/** get FinalCumulativeMetersetWeight (300a,010e)
* @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 getFinalCumulativeMetersetWeight(OFString &value, const signed long pos = 0) const;
/** get FinalCumulativeMetersetWeight (300a,010e)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getFinalCumulativeMetersetWeight(Float64 &value, const unsigned long pos = 0) const;
/** get FixationEye (300a,0150)
* @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 getFixationEye(OFString &value, const signed long pos = 0) const;
/** get FixationLightAzimuthalAngle (300a,0356)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getFixationLightAzimuthalAngle(Float32 &value, const unsigned long pos = 0) const;
/** get FixationLightPolarAngle (300a,0358)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getFixationLightPolarAngle(Float32 &value, const unsigned long pos = 0) const;
/** get InstitutionAddress (0008,0081)
* @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 getInstitutionAddress(OFString &value, const signed long pos = 0) const;
/** get InstitutionName (0008,0080)
* @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 getInstitutionName(OFString &value, const signed long pos = 0) const;
/** get InstitutionalDepartmentName (0008,1040)
* @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 getInstitutionalDepartmentName(OFString &value, const signed long pos = 0) const;
/** get Manufacturer (0008,0070)
* @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 getManufacturer(OFString &value, const signed long pos = 0) const;
/** get ManufacturerModelName (0008,1090)
* @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 getManufacturerModelName(OFString &value, const signed long pos = 0) const;
/** get ModulatedScanModeType (300a,0309)
* @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 getModulatedScanModeType(OFString &value, const signed long pos = 0) const;
/** get NumberOfBlocks (300a,00f0)
* @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 getNumberOfBlocks(OFString &value, const signed long pos = 0) const;
/** get NumberOfBlocks (300a,00f0)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getNumberOfBlocks(Sint32 &value, const unsigned long pos = 0) const;
/** get NumberOfBoli (300a,00ed)
* @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 getNumberOfBoli(OFString &value, const signed long pos = 0) const;
/** get NumberOfBoli (300a,00ed)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getNumberOfBoli(Sint32 &value, const unsigned long pos = 0) const;
/** get NumberOfCompensators (300a,00e0)
* @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 getNumberOfCompensators(OFString &value, const signed long pos = 0) const;
/** get NumberOfCompensators (300a,00e0)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getNumberOfCompensators(Sint32 &value, const unsigned long pos = 0) const;
/** get NumberOfControlPoints (300a,0110)
* @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 getNumberOfControlPoints(OFString &value, const signed long pos = 0) const;
/** get NumberOfControlPoints (300a,0110)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getNumberOfControlPoints(Sint32 &value, const unsigned long pos = 0) const;
/** get NumberOfLateralSpreadingDevices (300a,0330)
* @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 getNumberOfLateralSpreadingDevices(OFString &value, const signed long pos = 0) const;
/** get NumberOfLateralSpreadingDevices (300a,0330)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getNumberOfLateralSpreadingDevices(Sint32 &value, const unsigned long pos = 0) const;
/** get NumberOfRangeModulators (300a,0340)
* @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 getNumberOfRangeModulators(OFString &value, const signed long pos = 0) const;
/** get NumberOfRangeModulators (300a,0340)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getNumberOfRangeModulators(Sint32 &value, const unsigned long pos = 0) const;
/** get NumberOfRangeShifters (300a,0312)
* @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 getNumberOfRangeShifters(OFString &value, const signed long pos = 0) const;
/** get NumberOfRangeShifters (300a,0312)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getNumberOfRangeShifters(Sint32 &value, const unsigned long pos = 0) const;
/** get NumberOfWedges (300a,00d0)
* @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 getNumberOfWedges(OFString &value, const signed long pos = 0) const;
/** get NumberOfWedges (300a,00d0)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getNumberOfWedges(Sint32 &value, const unsigned long pos = 0) const;
/** get PatientSupportAccessoryCode (300a,0354)
* @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 getPatientSupportAccessoryCode(OFString &value, const signed long pos = 0) const;
/** get PatientSupportID (300a,0352)
* @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 getPatientSupportID(OFString &value, const signed long pos = 0) const;
/** get PatientSupportType (300a,0350)
* @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 getPatientSupportType(OFString &value, const signed long pos = 0) const;
/** get PrimaryDosimeterUnit (300a,00b3)
* @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 getPrimaryDosimeterUnit(OFString &value, const signed long pos = 0) const;
/** get RadiationAtomicNumber (300a,0304)
* @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 getRadiationAtomicNumber(OFString &value, const signed long pos = 0) const;
/** get RadiationAtomicNumber (300a,0304)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getRadiationAtomicNumber(Sint32 &value, const unsigned long pos = 0) const;
/** get RadiationChargeState (300a,0306)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getRadiationChargeState(Sint16 &value, const unsigned long pos = 0) const;
/** get RadiationMassNumber (300a,0302)
* @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 getRadiationMassNumber(OFString &value, const signed long pos = 0) const;
/** get RadiationMassNumber (300a,0302)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getRadiationMassNumber(Sint32 &value, const unsigned long pos = 0) const;
/** get RadiationType (300a,00c6)
* @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 getRadiationType(OFString &value, const signed long pos = 0) const;
/** get ReferencedPatientSetupNumber (300c,006a)
* @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 getReferencedPatientSetupNumber(OFString &value, const signed long pos = 0) const;
/** get ReferencedPatientSetupNumber (300c,006a)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getReferencedPatientSetupNumber(Sint32 &value, const unsigned long pos = 0) const;
/** get ReferencedToleranceTableNumber (300c,00a0)
* @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 getReferencedToleranceTableNumber(OFString &value, const signed long pos = 0) const;
/** get ReferencedToleranceTableNumber (300c,00a0)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getReferencedToleranceTableNumber(Sint32 &value, const unsigned long pos = 0) const;
/** get ScanMode (300a,0308)
* @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 getScanMode(OFString &value, const signed long pos = 0) const;
/** get TotalBlockTrayWaterEquivalentThickness (300a,00f3)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getTotalBlockTrayWaterEquivalentThickness(Float32 &value, const unsigned long pos = 0) const;
/** get TotalCompensatorTrayWaterEquivalentThickness (300a,02e3)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getTotalCompensatorTrayWaterEquivalentThickness(Float32 &value, const unsigned long pos = 0) const;
/** get TotalWedgeTrayWaterEquivalentThickness (300a,00d7)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getTotalWedgeTrayWaterEquivalentThickness(Float32 &value, const unsigned long pos = 0) const;
/** get TreatmentDeliveryType (300a,00ce)
* @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 getTreatmentDeliveryType(OFString &value, const signed long pos = 0) const;
/** get TreatmentMachineName (300a,00b2)
* @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 getTreatmentMachineName(OFString &value, const signed long pos = 0) const;
/** get VirtualSourceAxisDistances (300a,030a)
* @param value reference to variable in which the value should be stored
* @param pos index of the value to get (0..vm-1)
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getVirtualSourceAxisDistances(Float32 &value, const unsigned long pos = 0) const;
// --- get DICOM sequence attributes ---
/** get ApplicatorSequence (300a,0107)
* @return reference to sequence element
*/
DRTApplicatorSequenceInRTIonBeamsModule &getApplicatorSequence()
{ return ApplicatorSequence; }
/** get ApplicatorSequence (300a,0107)
* @return const reference to sequence element
*/
const DRTApplicatorSequenceInRTIonBeamsModule &getApplicatorSequence() const
{ return ApplicatorSequence; }
/** get DepthDoseParametersSequence (300a,0505)
* @return reference to sequence element
*/
DRTDepthDoseParametersSequence &getDepthDoseParametersSequence()
{ return DepthDoseParametersSequence; }
/** get DepthDoseParametersSequence (300a,0505)
* @return const reference to sequence element
*/
const DRTDepthDoseParametersSequence &getDepthDoseParametersSequence() const
{ return DepthDoseParametersSequence; }
/** get GeneralAccessorySequence (300a,0420)
* @return reference to sequence element
*/
DRTGeneralAccessorySequence &getGeneralAccessorySequence()
{ return GeneralAccessorySequence; }
/** get GeneralAccessorySequence (300a,0420)
* @return const reference to sequence element
*/
const DRTGeneralAccessorySequence &getGeneralAccessorySequence() const
{ return GeneralAccessorySequence; }
/** get IonBeamLimitingDeviceSequence (300a,03a4)
* @return reference to sequence element
*/
DRTIonBeamLimitingDeviceSequence &getIonBeamLimitingDeviceSequence()
{ return IonBeamLimitingDeviceSequence; }
/** get IonBeamLimitingDeviceSequence (300a,03a4)
* @return const reference to sequence element
*/
const DRTIonBeamLimitingDeviceSequence &getIonBeamLimitingDeviceSequence() const
{ return IonBeamLimitingDeviceSequence; }
/** get IonBlockSequence (300a,03a6)
* @return reference to sequence element
*/
DRTIonBlockSequence &getIonBlockSequence()
{ return IonBlockSequence; }
/** get IonBlockSequence (300a,03a6)
* @return const reference to sequence element
*/
const DRTIonBlockSequence &getIonBlockSequence() const
{ return IonBlockSequence; }
/** get IonControlPointSequence (300a,03a8)
* @return reference to sequence element
*/
DRTIonControlPointSequence &getIonControlPointSequence()
{ return IonControlPointSequence; }
/** get IonControlPointSequence (300a,03a8)
* @return const reference to sequence element
*/
const DRTIonControlPointSequence &getIonControlPointSequence() const
{ return IonControlPointSequence; }
/** get IonRangeCompensatorSequence (300a,02ea)
* @return reference to sequence element
*/
DRTIonRangeCompensatorSequence &getIonRangeCompensatorSequence()
{ return IonRangeCompensatorSequence; }
/** get IonRangeCompensatorSequence (300a,02ea)
* @return const reference to sequence element
*/
const DRTIonRangeCompensatorSequence &getIonRangeCompensatorSequence() const
{ return IonRangeCompensatorSequence; }
/** get IonWedgeSequence (300a,03aa)
* @return reference to sequence element
*/
DRTIonWedgeSequence &getIonWedgeSequence()
{ return IonWedgeSequence; }
/** get IonWedgeSequence (300a,03aa)
* @return const reference to sequence element
*/
const DRTIonWedgeSequence &getIonWedgeSequence() const
{ return IonWedgeSequence; }
/** get LateralSpreadingDeviceSequence (300a,0332)
* @return reference to sequence element
*/
DRTLateralSpreadingDeviceSequence &getLateralSpreadingDeviceSequence()
{ return LateralSpreadingDeviceSequence; }
/** get LateralSpreadingDeviceSequence (300a,0332)
* @return const reference to sequence element
*/
const DRTLateralSpreadingDeviceSequence &getLateralSpreadingDeviceSequence() const
{ return LateralSpreadingDeviceSequence; }
/** get RangeModulatorSequence (300a,0342)
* @return reference to sequence element
*/
DRTRangeModulatorSequence &getRangeModulatorSequence()
{ return RangeModulatorSequence; }
/** get RangeModulatorSequence (300a,0342)
* @return const reference to sequence element
*/
const DRTRangeModulatorSequence &getRangeModulatorSequence() const
{ return RangeModulatorSequence; }
/** get RangeShifterSequence (300a,0314)
* @return reference to sequence element
*/
DRTRangeShifterSequence &getRangeShifterSequence()
{ return RangeShifterSequence; }
/** get RangeShifterSequence (300a,0314)
* @return const reference to sequence element
*/
const DRTRangeShifterSequence &getRangeShifterSequence() const
{ return RangeShifterSequence; }
/** get ReferencedBolusSequence (300c,00b0)
* @return reference to sequence element
*/
DRTReferencedBolusSequenceInRTIonBeamsModule &getReferencedBolusSequence()
{ return ReferencedBolusSequence; }
/** get ReferencedBolusSequence (300c,00b0)
* @return const reference to sequence element
*/
const DRTReferencedBolusSequenceInRTIonBeamsModule &getReferencedBolusSequence() const
{ return ReferencedBolusSequence; }
/** get ReferencedDoseSequence (300c,0080)
* @return reference to sequence element
*/
DRTReferencedDoseSequence &getReferencedDoseSequence()
{ return ReferencedDoseSequence; }
/** get ReferencedDoseSequence (300c,0080)
* @return const reference to sequence element
*/
const DRTReferencedDoseSequence &getReferencedDoseSequence() const
{ return ReferencedDoseSequence; }
/** get ReferencedReferenceImageSequence (300c,0042)
* @return reference to sequence element
*/
DRTReferencedReferenceImageSequenceInRTIonBeamsModule &getReferencedReferenceImageSequence()
{ return ReferencedReferenceImageSequence; }
/** get ReferencedReferenceImageSequence (300c,0042)
* @return const reference to sequence element
*/
const DRTReferencedReferenceImageSequenceInRTIonBeamsModule &getReferencedReferenceImageSequence() const
{ return ReferencedReferenceImageSequence; }
/** get SnoutSequence (300a,030c)
* @return reference to sequence element
*/
DRTSnoutSequence &getSnoutSequence()
{ return SnoutSequence; }
/** get SnoutSequence (300a,030c)
* @return const reference to sequence element
*/
const DRTSnoutSequence &getSnoutSequence() const
{ return SnoutSequence; }
// --- set DICOM attribute values ---
/** set BeamDescription (300a,00c3)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (ST) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setBeamDescription(const OFString &value, const OFBool check = OFTrue);
/** set BeamName (300a,00c2)
* @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 setBeamName(const OFString &value, const OFBool check = OFTrue);
/** set BeamNumber (300a,00c0)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setBeamNumber(const OFString &value, const OFBool check = OFTrue);
/** set BeamType (300a,00c4)
* @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 setBeamType(const OFString &value, const OFBool check = OFTrue);
/** set DeviceSerialNumber (0018,1000)
* @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 setDeviceSerialNumber(const OFString &value, const OFBool check = OFTrue);
/** set FinalCumulativeMetersetWeight (300a,010e)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (DS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setFinalCumulativeMetersetWeight(const OFString &value, const OFBool check = OFTrue);
/** set FixationEye (300a,0150)
* @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 setFixationEye(const OFString &value, const OFBool check = OFTrue);
/** set FixationLightAzimuthalAngle (300a,0356)
* @param value value to be set (should be valid for this VR)
* @param pos index of the value to be set (0..vm-1), vm=1
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setFixationLightAzimuthalAngle(const Float32 value, const unsigned long pos = 0);
/** set FixationLightPolarAngle (300a,0358)
* @param value value to be set (should be valid for this VR)
* @param pos index of the value to be set (0..vm-1), vm=1
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setFixationLightPolarAngle(const Float32 value, const unsigned long pos = 0);
/** set InstitutionAddress (0008,0081)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (ST) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setInstitutionAddress(const OFString &value, const OFBool check = OFTrue);
/** set InstitutionName (0008,0080)
* @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 setInstitutionName(const OFString &value, const OFBool check = OFTrue);
/** set InstitutionalDepartmentName (0008,1040)
* @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 setInstitutionalDepartmentName(const OFString &value, const OFBool check = OFTrue);
/** set Manufacturer (0008,0070)
* @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 setManufacturer(const OFString &value, const OFBool check = OFTrue);
/** set ManufacturerModelName (0008,1090)
* @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 setManufacturerModelName(const OFString &value, const OFBool check = OFTrue);
/** set ModulatedScanModeType (300a,0309)
* @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 setModulatedScanModeType(const OFString &value, const OFBool check = OFTrue);
/** set NumberOfBlocks (300a,00f0)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setNumberOfBlocks(const OFString &value, const OFBool check = OFTrue);
/** set NumberOfBoli (300a,00ed)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setNumberOfBoli(const OFString &value, const OFBool check = OFTrue);
/** set NumberOfCompensators (300a,00e0)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setNumberOfCompensators(const OFString &value, const OFBool check = OFTrue);
/** set NumberOfControlPoints (300a,0110)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setNumberOfControlPoints(const OFString &value, const OFBool check = OFTrue);
/** set NumberOfLateralSpreadingDevices (300a,0330)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setNumberOfLateralSpreadingDevices(const OFString &value, const OFBool check = OFTrue);
/** set NumberOfRangeModulators (300a,0340)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setNumberOfRangeModulators(const OFString &value, const OFBool check = OFTrue);
/** set NumberOfRangeShifters (300a,0312)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setNumberOfRangeShifters(const OFString &value, const OFBool check = OFTrue);
/** set NumberOfWedges (300a,00d0)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setNumberOfWedges(const OFString &value, const OFBool check = OFTrue);
/** set PatientSupportAccessoryCode (300a,0354)
* @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 setPatientSupportAccessoryCode(const OFString &value, const OFBool check = OFTrue);
/** set PatientSupportID (300a,0352)
* @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 setPatientSupportID(const OFString &value, const OFBool check = OFTrue);
/** set PatientSupportType (300a,0350)
* @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 setPatientSupportType(const OFString &value, const OFBool check = OFTrue);
/** set PrimaryDosimeterUnit (300a,00b3)
* @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 setPrimaryDosimeterUnit(const OFString &value, const OFBool check = OFTrue);
/** set RadiationAtomicNumber (300a,0304)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setRadiationAtomicNumber(const OFString &value, const OFBool check = OFTrue);
/** set RadiationChargeState (300a,0306)
* @param value value to be set (should be valid for this VR)
* @param pos index of the value to be set (0..vm-1), vm=1
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setRadiationChargeState(const Sint16 value, const unsigned long pos = 0);
/** set RadiationMassNumber (300a,0302)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setRadiationMassNumber(const OFString &value, const OFBool check = OFTrue);
/** set RadiationType (300a,00c6)
* @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 setRadiationType(const OFString &value, const OFBool check = OFTrue);
/** set ReferencedPatientSetupNumber (300c,006a)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setReferencedPatientSetupNumber(const OFString &value, const OFBool check = OFTrue);
/** set ReferencedToleranceTableNumber (300c,00a0)
* @param value value to be set (single value only) or "" for no value
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setReferencedToleranceTableNumber(const OFString &value, const OFBool check = OFTrue);
/** set ScanMode (300a,0308)
* @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 setScanMode(const OFString &value, const OFBool check = OFTrue);
/** set TotalBlockTrayWaterEquivalentThickness (300a,00f3)
* @param value value to be set (should be valid for this VR)
* @param pos index of the value to be set (0..vm-1), vm=1
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setTotalBlockTrayWaterEquivalentThickness(const Float32 value, const unsigned long pos = 0);
/** set TotalCompensatorTrayWaterEquivalentThickness (300a,02e3)
* @param value value to be set (should be valid for this VR)
* @param pos index of the value to be set (0..vm-1), vm=1
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setTotalCompensatorTrayWaterEquivalentThickness(const Float32 value, const unsigned long pos = 0);
/** set TotalWedgeTrayWaterEquivalentThickness (300a,00d7)
* @param value value to be set (should be valid for this VR)
* @param pos index of the value to be set (0..vm-1), vm=1
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setTotalWedgeTrayWaterEquivalentThickness(const Float32 value, const unsigned long pos = 0);
/** set TreatmentDeliveryType (300a,00ce)
* @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 setTreatmentDeliveryType(const OFString &value, const OFBool check = OFTrue);
/** set TreatmentMachineName (300a,00b2)
* @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 setTreatmentMachineName(const OFString &value, const OFBool check = OFTrue);
/** set VirtualSourceAxisDistances (300a,030a)
* @param value value to be set (should be valid for this VR)
* @param pos index of the value to be set (0..vm-1), vm=2
* @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setVirtualSourceAxisDistances(const Float32 value, const unsigned long pos = 0);
private:
/// internal flag used to mark the empty default item
/*const*/ OFBool EmptyDefaultItem;
/// ApplicatorSequence (300a,0107) vr=SQ, vm=1, type=3
DRTApplicatorSequenceInRTIonBeamsModule ApplicatorSequence;
/// BeamDescription (300a,00c3) vr=ST, vm=1, type=3
DcmShortText BeamDescription;
/// BeamName (300a,00c2) vr=LO, vm=1, type=1
DcmLongString BeamName;
/// BeamNumber (300a,00c0) vr=IS, vm=1, type=1
DcmIntegerString BeamNumber;
/// BeamType (300a,00c4) vr=CS, vm=1, type=1
DcmCodeString BeamType;
/// DepthDoseParametersSequence (300a,0505) vr=SQ, vm=1, type=3
DRTDepthDoseParametersSequence DepthDoseParametersSequence;
/// DeviceSerialNumber (0018,1000) vr=LO, vm=1, type=3
DcmLongString DeviceSerialNumber;
/// FinalCumulativeMetersetWeight (300a,010e) vr=DS, vm=1, type=1C
DcmDecimalString FinalCumulativeMetersetWeight;
/// FixationEye (300a,0150) vr=CS, vm=1, type=3
DcmCodeString FixationEye;
/// FixationLightAzimuthalAngle (300a,0356) vr=FL, vm=1, type=3
DcmFloatingPointSingle FixationLightAzimuthalAngle;
/// FixationLightPolarAngle (300a,0358) vr=FL, vm=1, type=3
DcmFloatingPointSingle FixationLightPolarAngle;
/// GeneralAccessorySequence (300a,0420) vr=SQ, vm=1, type=3
DRTGeneralAccessorySequence GeneralAccessorySequence;
/// InstitutionAddress (0008,0081) vr=ST, vm=1, type=3
DcmShortText InstitutionAddress;
/// InstitutionName (0008,0080) vr=LO, vm=1, type=3
DcmLongString InstitutionName;
/// InstitutionalDepartmentName (0008,1040) vr=LO, vm=1, type=3
DcmLongString InstitutionalDepartmentName;
/// IonBeamLimitingDeviceSequence (300a,03a4) vr=SQ, vm=1, type=3
DRTIonBeamLimitingDeviceSequence IonBeamLimitingDeviceSequence;
/// IonBlockSequence (300a,03a6) vr=SQ, vm=1, type=1C
DRTIonBlockSequence IonBlockSequence;
/// IonControlPointSequence (300a,03a8) vr=SQ, vm=1, type=1
DRTIonControlPointSequence IonControlPointSequence;
/// IonRangeCompensatorSequence (300a,02ea) vr=SQ, vm=1, type=1C
DRTIonRangeCompensatorSequence IonRangeCompensatorSequence;
/// IonWedgeSequence (300a,03aa) vr=SQ, vm=1, type=1C
DRTIonWedgeSequence IonWedgeSequence;
/// LateralSpreadingDeviceSequence (300a,0332) vr=SQ, vm=1, type=1C
DRTLateralSpreadingDeviceSequence LateralSpreadingDeviceSequence;
/// Manufacturer (0008,0070) vr=LO, vm=1, type=3
DcmLongString Manufacturer;
/// ManufacturerModelName (0008,1090) vr=LO, vm=1, type=3
DcmLongString ManufacturerModelName;
/// ModulatedScanModeType (300a,0309) vr=CS, vm=1, type=1C
DcmCodeString ModulatedScanModeType;
/// NumberOfBlocks (300a,00f0) vr=IS, vm=1, type=1
DcmIntegerString NumberOfBlocks;
/// NumberOfBoli (300a,00ed) vr=IS, vm=1, type=1
DcmIntegerString NumberOfBoli;
/// NumberOfCompensators (300a,00e0) vr=IS, vm=1, type=1
DcmIntegerString NumberOfCompensators;
/// NumberOfControlPoints (300a,0110) vr=IS, vm=1, type=1
DcmIntegerString NumberOfControlPoints;
/// NumberOfLateralSpreadingDevices (300a,0330) vr=IS, vm=1, type=1
DcmIntegerString NumberOfLateralSpreadingDevices;
/// NumberOfRangeModulators (300a,0340) vr=IS, vm=1, type=1
DcmIntegerString NumberOfRangeModulators;
/// NumberOfRangeShifters (300a,0312) vr=IS, vm=1, type=1
DcmIntegerString NumberOfRangeShifters;
/// NumberOfWedges (300a,00d0) vr=IS, vm=1, type=1
DcmIntegerString NumberOfWedges;
/// PatientSupportAccessoryCode (300a,0354) vr=LO, vm=1, type=3
DcmLongString PatientSupportAccessoryCode;
/// PatientSupportID (300a,0352) vr=SH, vm=1, type=3
DcmShortString PatientSupportID;
/// PatientSupportType (300a,0350) vr=CS, vm=1, type=1
DcmCodeString PatientSupportType;
/// PrimaryDosimeterUnit (300a,00b3) vr=CS, vm=1, type=1
DcmCodeString PrimaryDosimeterUnit;
/// RadiationAtomicNumber (300a,0304) vr=IS, vm=1, type=1C
DcmIntegerString RadiationAtomicNumber;
/// RadiationChargeState (300a,0306) vr=SS, vm=1, type=1C
DcmSignedShort RadiationChargeState;
/// RadiationMassNumber (300a,0302) vr=IS, vm=1, type=1C
DcmIntegerString RadiationMassNumber;
/// RadiationType (300a,00c6) vr=CS, vm=1, type=1
DcmCodeString RadiationType;
/// RangeModulatorSequence (300a,0342) vr=SQ, vm=1, type=1C
DRTRangeModulatorSequence RangeModulatorSequence;
/// RangeShifterSequence (300a,0314) vr=SQ, vm=1, type=1C
DRTRangeShifterSequence RangeShifterSequence;
/// ReferencedBolusSequence (300c,00b0) vr=SQ, vm=1, type=1C
DRTReferencedBolusSequenceInRTIonBeamsModule ReferencedBolusSequence;
/// ReferencedDoseSequence (300c,0080) vr=SQ, vm=1, type=3
DRTReferencedDoseSequence ReferencedDoseSequence;
/// ReferencedPatientSetupNumber (300c,006a) vr=IS, vm=1, type=3
DcmIntegerString ReferencedPatientSetupNumber;
/// ReferencedReferenceImageSequence (300c,0042) vr=SQ, vm=1, type=3
DRTReferencedReferenceImageSequenceInRTIonBeamsModule ReferencedReferenceImageSequence;
/// ReferencedToleranceTableNumber (300c,00a0) vr=IS, vm=1, type=3
DcmIntegerString ReferencedToleranceTableNumber;
/// ScanMode (300a,0308) vr=CS, vm=1, type=1
DcmCodeString ScanMode;
/// SnoutSequence (300a,030c) vr=SQ, vm=1, type=3
DRTSnoutSequence SnoutSequence;
/// TotalBlockTrayWaterEquivalentThickness (300a,00f3) vr=FL, vm=1, type=3
DcmFloatingPointSingle TotalBlockTrayWaterEquivalentThickness;
/// TotalCompensatorTrayWaterEquivalentThickness (300a,02e3) vr=FL, vm=1, type=3
DcmFloatingPointSingle TotalCompensatorTrayWaterEquivalentThickness;
/// TotalWedgeTrayWaterEquivalentThickness (300a,00d7) vr=FL, vm=1, type=3
DcmFloatingPointSingle TotalWedgeTrayWaterEquivalentThickness;
/// TreatmentDeliveryType (300a,00ce) vr=CS, vm=1, type=1
DcmCodeString TreatmentDeliveryType;
/// TreatmentMachineName (300a,00b2) vr=SH, vm=1, type=2
DcmShortString TreatmentMachineName;
/// VirtualSourceAxisDistances (300a,030a) vr=FL, vm=2, type=1
DcmFloatingPointSingle VirtualSourceAxisDistances;
};
// --- constructors, destructor and operators ---
/** (default) constructor
* @param emptyDefaultSequence internal flag used to mark the empty default sequence
*/
DRTIonBeamSequence(const OFBool emptyDefaultSequence = OFFalse);
/** copy constructor
* @param copy sequence object to be copied
*/
DRTIonBeamSequence(const DRTIonBeamSequence ©);
/** destructor
*/
virtual ~DRTIonBeamSequence();
/** assigment operator
* @param copy sequence object to be copied
* @return reference to this object
*/
DRTIonBeamSequence &operator=(const DRTIonBeamSequence ©);
// --- 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
|