/usr/include/dcmtk/dcmpstat/dviface.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 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 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 | /*
*
* Copyright (C) 1998-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: dcmpstat
*
* Author: Marco Eichelberg, Joerg Riesmeier
*
* Purpose:
* classes: DVInterface
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:16:35 $
* CVS/RCS Revision: $Revision: 1.95 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef DVIFACE_H
#define DVIFACE_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/ofstd/ofstream.h"
#include "dcmtk/dcmpstat/dvpscf.h" /* for class DVConfiguration */
#include "dcmtk/dcmpstat/dvpstat.h" /* for class DVPresentationState */
#include "dcmtk/dcmqrdb/dcmqridx.h" /* for struct IdxRecord */
#include "dcmtk/ofstd/ofstring.h" /* for class OFString */
#include "dcmtk/dcmpstat/dvcache.h" /* for index file caching */
class DicomImage;
class DiDisplayFunction;
class DVPSStoredPrint;
class DVPSPrintMessageHandler;
class DSRDocument;
class DVSignatureHandler;
/** Interface class for the Softcopy Presentation State viewer.
* This class manages the database facilities, allows to start and stop
* network transactions and gives access to images and presentation states.
*/
class DVInterface: public DVConfiguration
{
public:
/** constructor.
* @param config_file filename (path) of the config file to be used
* by the interface object. The caller should make sure that the config file
* really exists because the constructor cannot return an error status.
* If a non-existing filename (or NULL) is passed, an empty configuration file
* is assumed.
* @param useLog (optional) flag specifying whether a general log file should be used
* (config entry GENERAL\APPLICATION\LOGFILE).
*/
DVInterface(const char *config_file = NULL, OFBool useLog = OFFalse);
/** destructor.
*/
virtual ~DVInterface();
/* load images, presentation states and structured reports */
/** loads an image which is contained in the database
* and creates a default presentation state for the image.
* This method acquires a database lock which must be explicitly freed by the user.
* @param studyUID study instance UID of the image
* @param seriesUID series instance UID of the image
* @param instanceUID SOP instance UID of the image
* @param changeStatus if true the image file is marked 'reviewed' (not new)
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition loadImage(const char *studyUID, const char *seriesUID, const char *instanceUID, OFBool changeStatus = OFFalse);
/** loads an image (which need not be contained in the database)
* and creates a default presentation state for the image.
* This method does not acquire a database lock.
* @param filename path and filename of the image to be loaded
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition loadImage(const char *filename);
/** loads an image which referenced by the current presentation
* state and needs to be contained in the database.
* This method acquires a database lock which must be explicitly freed by the user.
* @param idx index of the image to be loaded (< getNumberOfImageReferences())
* @param changeStatus if true the image file is marked 'reviewed' (not new)
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition loadReferencedImage(size_t idx, OFBool changeStatus = OFFalse);
/** loads a presentation state which is contained in the database.
* The first image referenced in presentation state is also looked up in the
* database, loaded, and attached to the presentation state.
* This method acquires a database lock which must be explicitly freed by the user.
* @param studyUID study instance UID of the presentation state
* @param seriesUID series instance UID of the presentation state
* @param instanceUID SOP instance UID of the presentation state
* @param changeStatus if true the pstate and (first) image file is marked 'reviewed' (not new)
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition loadPState(const char *studyUID, const char *seriesUID, const char *instanceUID, OFBool changeStatus = OFFalse);
/** loads a presentation state and an image (which need not be contained in the database)
* and attaches the image to the presentation state (if specified, otherwise the current
* image will be used).
* This method does not acquire a database lock.
* @param pstName path and filename of the presentation state to be loaded
* @param imgName path and filename of the image to be loaded
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition loadPState(const char *pstName, const char *imgName = NULL);
/** loads a structured report which is contained in the database.
* This method acquires a database lock which must be explicitly freed by the user.
* @param studyUID study instance UID of the structured report
* @param seriesUID series instance UID of the structured report
* @param instanceUID SOP instance UID of the structured report
* @param changeStatus if true the structured report file is marked 'reviewed' (not new)
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition loadStructuredReport(const char *studyUID, const char *seriesUID, const char *instanceUID, OFBool changeStatus = OFFalse);
/** loads a structured report (which need not be contained in the database).
* This method does not acquire a database lock.
* @param filename path and filename of the structured report to be loaded
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition loadStructuredReport(const char *filename);
/** loads a structured reporting "template".
* This "template" is just a DICOM Structured Reporting file which resides in a
* special sub-folder and is referenced by the configuration file. This meachanism
* should facilitate the creation of new reports since one does not have to start
* with a completely empty report.
* Please note that the current structured report is replaced by the specified
* "template". New study/series/instance UIDs are generated automatically for the
* new report.
* This method does not acquire a database lock.
* @param reportID report identifier, as returned by getReportID().
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition loadSRTemplate(const char *reportID);
/** saves the current presentation state in the same directory
* in which the database index file resides. The filename is generated automatically.
* A new SOP Instance UID is assigned whenever a presentation state is saved.
* After successfully storing the presentation state, the database index is updated
* to include the new object.
* This method releases under any circumstances the database lock if it exists.
* @param replaceSOPInstanceUID flag indicating whether the
* SOP Instance UID should be replaced by a new UID.
* If true, a new UID is always generated. If false, a new
* UID is generated only if no UID has been assigned before.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition savePState(OFBool replaceSOPInstanceUID);
/** saves the current presentation state in a file with the given path and filename.
* A new SOP Instance UID is assigned whenever a presentation state is saved.
* This method does not acquire a database lock and does not register
* the saved presentation state in the database.
* @param filename path and filename under which the presentation state is to be saved
* @param replaceSOPInstanceUID flag indicating whether the
* SOP Instance UID should be replaced by a new UID.
* If true, a new UID is always generated. If false, a new
* UID is generated only if no UID has been assigned before.
* @param explicitVR selects the transfer syntax to be written. True (the default) selects
* Explicit VR Little Endian, False selects Implicit VR Little Endian.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition savePState(const char *filename, OFBool replaceSOPInstanceUID, OFBool explicitVR=OFTrue);
/** saves the DICOM image that is currently attached to the presentation state
* in a file with the given path and filename.
* This method does not acquire a database lock and does not register
* the saved presentation state in the database.
* @param filename path and filename under which the image is to be saved
* @param explicitVR selects the transfer syntax to be written. True (the default) selects
* Explicit VR Little Endian, False selects Implicit VR Little Endian.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition saveCurrentImage(const char *filename, OFBool explicitVR=OFTrue);
/** saves the current structured report in the same directory in which the database index
* file resides. The filename is generated automatically. A new SOP Instance UID is not
* assigned automatically unless the method getStructuredReport().createRevisedVersion()
* is called (see documentation in file dcmsr/dsrdoc.h). This is not required for the
* first version of a document (i.e. directly after program start or calling the method
* getStructuredReport().createNewDocument()).
* After successfully storing the structured report, the database index is updated
* to include the new object.
* This method releases under any circumstances the database lock if it exists.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition saveStructuredReport();
/** saves the current structured report in a file with the given path and filename.
* A new SOP Instance UID is not assigned automatically unless the method
* getStructuredReport().createRevisedVersion() is called (see documentation in file
* dcmsr/dsrdoc.h). This is not required for the first version of a document (i.e.
* directly after program start or calling the method getStructuredReport().createNewDocument()).
* This method does not acquire a database lock and does not register the saved structured
* report in the database.
* @param filename path and filename under which the structured report is to be saved
* @param explicitVR selects the transfer syntax to be written. True (the default) selects
* Explicit VR Little Endian, False selects Implicit VR Little Endian.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition saveStructuredReport(const char *filename, OFBool explicitVR=OFTrue);
/** adds an image which is contained in the database
* to the list of referenced images of the current presentation state.
* This method acquires a database lock which must be explicitly freed by the user.
* @param studyUID study instance UID of the image
* @param seriesUID series instance UID of the image
* @param instanceUID SOP instance UID of the image
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition addImageReferenceToPState(const char *studyUID, const char *seriesUID, const char *instanceUID);
/** gets the number of image references contained in the current presentation state.
* @return number of image references, 0 if an error occurred.
*/
size_t getNumberOfImageReferences();
/** returns a reference to the current presentation state.
* This reference will become invalid when the DVInterface object is deleted,
* a different image or presentation state is loaded
* (using loadPState or loadImage) or when resetPresentationState() is called.
* @return reference to the current presentation state
*/
DVPresentationState& getCurrentPState()
{
return *pState;
}
/** returns a reference to the current structured report.
* This reference will become invalid when the DVInterface object is deleted or
* a different structured report is loaded (using loadStructuredReport).
* @return reference to the current structured report
*/
DSRDocument& getCurrentReport()
{
return *pReport;
}
/** returns a reference to the print handler.
* This reference remains valid as long as the DVInterface object exists.
* @return reference to the current print handler
*/
DVPSStoredPrint& getPrintHandler()
{
return *pPrint;
}
/** resets the presentation state object to the status it had immediately after the
* last successful operation of "loadImage" or "loadPState". A state can also explicitly
* specified as such a "reset state" by using the method saveCurrentPStateForReset().
* Attention: The last reference returned by getCurrentPState() becomes invalid
* when this method is called.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition resetPresentationState();
/** saves the current state of the presentation state object to be used for
* resetPresentationState(). This is e.g. useful after registration of additional images
* directly after a new images has been loaded.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition saveCurrentPStateForReset();
/** removes any shared or exclusive lock on the database.
* This method should be called when a database transaction
* (i.e. reading all studies, series, instances etc.) is finished.
* As long as a lock exists on the database, no other application
* (i.e. the network receiver) can add new images to the database.
* This method also clears the index cache.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition releaseDatabase();
/** searches in the database for a DICOM instance with the given
* study, series and instance UIDs and returns its pathname if found.
* If the given instance is not found in the database, NULL is returned.
* This method acquires a database lock which must be explicitly freed by the user.
* @param studyUID the DICOM study instance UID
* @param seriesUID the DICOM series instance UID
* @param instanceUID the DICOM SOP instance UID
* @return filename (path) if found, NULL otherwise
*/
const char *getFilename(const char *studyUID, const char *seriesUID, const char *instanceUID);
/** returns the number of studies currently contained in the database.
* This method acquires a database lock which must be explicitly freed by the user.
* The number reported (returned) by this method remains valid as long
* as the database lock remains active and no function modifying the database is called.
* Functions that modify the database are: Storing new presentation states,
* deleting data, modifying the 'reviewed' status flag of IODs.
* @return number of studies in the database.
*/
Uint32 getNumberOfStudies();
/** selects the study with the given index in the database.
* This method acquires a database lock which must be explicitly freed by the user.
* The selection remains valid until the database lock is removed or the database
* is modified (see comments for getNumberOfStudies).
* Implicitly the first series and first instance within this study is selected, too.
* @param idx index to be selected, must be < getNumberOfStudies()
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition selectStudy(Uint32 idx);
/** selects the study with the given UID in the database.
* This method acquires a database lock which must be explicitly freed by the user.
* The selection remains valid until the database lock is removed or the database
* is modified (see comments for getNumberOfStudies).
* Implicitly the first series and first instance within this study is selected, too.
* @param studyUID the DICOM study instance UID
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition selectStudy(const char *studyUID);
/** returns the review status of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* This method acquires a database lock which must be explicitly freed by the user.
* Implicitly the first instance within this series is selected, too.
* @return study review status
*/
DVIFhierarchyStatus getStudyStatus() ;
/** returns the Study Instance UID of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Study Instance UID or NULL if absent or not selected.
*/
const char *getStudyUID();
/** returns the Study Description of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Study Description or NULL if absent or not selected.
*/
const char *getStudyDescription();
/** returns the Study Date of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Study Date or NULL if absent or not selected.
*/
const char *getStudyDate();
/** returns the Study Time of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Study Time or NULL if absent or not selected.
*/
const char *getStudyTime();
/** returns the Referring Physicians Name of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Referring Physicians Name or NULL if absent or not selected.
*/
const char *getReferringPhysiciansName();
/** returns the Accession Number of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Accession Number or NULL if absent or not selected.
*/
const char *getAccessionNumber();
/** returns the Name Of Physicians Reading Study of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Name Of Physicians Reading Study or NULL if absent or not selected.
*/
const char *getNameOfPhysiciansReadingStudy();
/** returns the Patient Name of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* Note: Since the database uses the Study Root model, patient data appears
* on the study level.
* This method acquires a database lock which must be explicitly freed by the user.
* @return Patient Name or NULL if absent or not selected.
*/
const char *getPatientName();
/** returns the Patient ID of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* Note: Since the database uses the Study Root model, patient data appears
* on the study level.
* This method acquires a database lock which must be explicitly freed by the user.
* @return Patient ID or NULL if absent or not selected.
*/
const char *getPatientID();
/** returns the Patient Birth Date of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* Note: Since the database uses the Study Root model, patient data appears
* on the study level.
* This method acquires a database lock which must be explicitly freed by the user.
* @return Patient Birth Date or NULL if absent or not selected.
*/
const char *getPatientBirthDate();
/** returns the Patient Sex of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* Note: Since the database uses the Study Root model, patient data appears
* on the study level.
* This method acquires a database lock which must be explicitly freed by the user.
* @return Patient Sex or NULL if absent or not selected.
*/
const char *getPatientSex();
/** returns the Patient Birth Time of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* Note: Since the database uses the Study Root model, patient data appears
* on the study level.
* This method acquires a database lock which must be explicitly freed by the user.
* @return Patient Birth Time or NULL if absent or not selected.
*/
const char *getPatientBirthTime();
/** returns the Other Patient Names of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* Note: Since the database uses the Study Root model, patient data appears
* on the study level.
* This method acquires a database lock which must be explicitly freed by the user.
* @return Other Patient Names or NULL if absent or not selected.
*/
const char *getOtherPatientNames();
/** returns the Other Patient ID of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* Note: Since the database uses the Study Root model, patient data appears
* on the study level.
* This method acquires a database lock which must be explicitly freed by the user.
* @return Other Patient ID or NULL if absent or not selected.
*/
const char *getOtherPatientID();
/** returns the Patient Ethnic Group of the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* Note: Since the database uses the Study Root model, patient data appears
* on the study level.
* This method acquires a database lock which must be explicitly freed by the user.
* @return Patient Ethnic Group or NULL if absent or not selected.
*/
const char *getEthnicGroup();
/** returns the number of series within the currently selected study.
* May be called only if a valid study selection exists - see selectStudy().
* This method acquires a database lock which must be explicitly freed by the user.
* See the comments for getNumberOfStudies() about the validity period
* of the returned number.
* @return number of series in the current study.
*/
Uint32 getNumberOfSeries();
/** selects the series with the given index within the currently selected study.
* This method acquires a database lock which must be explicitly freed by the user.
* The selection remains valid until the database lock is removed or the database
* is modified (see comments for getNumberOfStudies).
* @param idx index to be selected, must be < getNumberOfSeries()
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition selectSeries(Uint32 idx);
/** selects the series with the given UID within the currently selected study.
* This method acquires a database lock which must be explicitly freed by the user.
* The selection remains valid until the database lock is removed or the database
* is modified (see comments for getNumberOfStudies).
* @param seriesUID series instance UID of the image
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition selectSeries(const char *seriesUID);
/** returns the Series Instance UID of the currently selected series.
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Series Instance UID or NULL if absent or not selected.
*/
const char *getSeriesUID();
/** returns the review status of the currently selected series.
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* @return series review status
*/
DVIFhierarchyStatus getSeriesStatus();
/** returns the type of all instances within the currently selected series.
* DICOM series always contain a single modality only, if not the modality of
* the first examined instance (which is no image) is used (e.g. PresentationState).
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* @return instance type
*/
DVPSInstanceType getSeriesType();
/** returns the type of the currently selected instance.
* May be called only if a valid instance selection exists - see selectInstance().
* This method acquires a database lock which must be explicitly freed by the user.
* @return instance type
*/
DVPSInstanceType getInstanceType();
/** returns the Series Number of the currently selected series.
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Series Number or NULL if absent or not selected.
*/
const char *getSeriesNumber();
/** returns the Series Date of the currently selected series.
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Series Date or NULL if absent or not selected.
*/
const char *getSeriesDate();
/** returns the Series Time of the currently selected series.
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Series Time or NULL if absent or not selected.
*/
const char *getSeriesTime();
/** returns the Series Description of the currently selected series.
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Series Description or NULL if absent or not selected.
*/
const char *getSeriesDescription();
/** returns the Series Performing Physicians Name of the currently selected series.
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Series Performing Physicians Name or NULL if absent or not selected.
*/
const char *getSeriesPerformingPhysiciansName();
/** returns the Series Protocol Name of the currently selected series.
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Series Protocol Name or NULL if absent or not selected.
*/
const char *getSeriesProtocolName();
/** returns the Series Operators Name of the currently selected series.
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Series Operators Name or NULL if absent or not selected.
*/
const char *getSeriesOperatorsName();
/** returns the Modality of the currently selected series.
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Modality or NULL if absent or not selected.
*/
const char *getModality();
/** returns the number of instances (IODs) within the currently selected series.
* May be called only if a valid series selection exists - see selectSeries().
* This method acquires a database lock which must be explicitly freed by the user.
* See the comments for getNumberOfStudies() about the validity period
* of the returned number.
* @return number of instances in the current series.
*/
Uint32 getNumberOfInstances();
/** selects the instance with the given index within the currently selected series.
* This method acquires a database lock which must be explicitly freed by the user.
* The selection remains valid until the database lock is removed or the database
* is modified (see comments for getNumberOfStudies).
* @param idx index to be selected, must be < getNumberOfInstances()
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition selectInstance(Uint32 idx);
/** selects the instance with the given UID within the currently selected series.
* This method acquires a database lock which must be explicitly freed by the user.
* The selection remains valid until the database lock is removed or the database
* is modified (see comments for getNumberOfStudies).
* @param instanceUID SOP instance UID of the instance
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition selectInstance(const char *instanceUID);
/** selects the instance with the given UID and SOP class over all studies and series.
* Please note that in worst case all studies, series and instances are examined.
* This method acquires a database lock which must be explicitly freed by the user.
* The selection remains valid until the database lock is removed or the database
* is modified (see comments for getNumberOfStudies).
* @param instanceUID SOP instance UID of the instance
* @param sopClassUID SOP class UID of the instance (might be NULL to be not compared)
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition selectInstance(const char *instanceUID, const char *sopClassUID);
/** selects the instance with the given UIDs.
* This method acquires a database lock which must be explicitly freed by the user.
* The selection remains valid until the database lock is removed or the database
* is modified (see comments for getNumberOfStudies).
* @param studyUID study instance UID of the instance
* @param seriesUID series instance UID of the instance
* @param instanceUID SOP instance UID of the instance
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition selectInstance(const char *studyUID, const char *seriesUID, const char *instanceUID);
/** returns the SOP class UID of the currently selected instance.
* May be called only if a valid instance selection exists - see selectInstance().
* This method acquires a database lock which must be explicitly freed by the user.
* @return SOP Instance UID or NULL if absent or not selected.
*/
const char *getSOPClassUID();
/** returns the SOP Instance UID of the currently selected instance.
* May be called only if a valid instance selection exists - see selectInstance().
* This method acquires a database lock which must be explicitly freed by the user.
* @return SOP Instance UID or NULL if absent or not selected.
*/
const char *getInstanceUID();
/** returns the Image Number of the currently selected instance.
* May be called only if a valid instance selection exists - see selectInstance().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Image Number or NULL if absent or not selected.
*/
const char *getImageNumber();
/** returns the Filename of the currently selected instance.
* May be called only if a valid instance selection exists - see selectInstance().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Filename or NULL if absent or not selected.
*/
const char *getFilename();
/** returns the review status of the currently selected instance.
* May be called only if a valid instance selection exists - see selectInstance().
* This method acquires a database lock which must be explicitly freed by the user.
* @return instance review status
*/
DVIFhierarchyStatus getInstanceStatus() ;
/** returns the escription of the currently selected instance.
* May be called only if a valid instance selection exists - see selectInstance().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Instance Description or NULL if absent or not selected.
*/
const char *getInstanceDescription();
/** returns the Presentation Label of the currently selected instance.
* May be called only if a valid instance selection exists - see selectInstance().
* This method acquires a database lock which must be explicitly freed by the user.
* @return Presentation Label or NULL if absent or not selected.
*/
const char *getPresentationLabel();
/* methods modifying the database */
/** modifies the review flag for one instance in the database, which is set to
* 'reviewed' state (DVIF_objectIsNotNew). The status of the corresponding series
* and study is updated automatically.
* This method acquires a database lock which must be explicitly freed by the user.
* The database is modified - any study, series or instance selection
* and the number of studies, series and instances reported will become invalid since
* other processes may modify the database before the exclusive lock is granted to this method.
* @param studyUID study instance UID of the reviewed instance
* @param seriesUID series instance UID of the reviewed instance
* @param instanceUID SOP instance UID of the reviewed instance
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition instanceReviewed(const char *studyUID, const char *seriesUID, const char *instanceUID);
/** deletes the given instance from the database. If the corresponding DICOM file
* resides in the same directory as the index file, it is also removed.
* This method acquires a database lock which must be explicitly freed by the user.
* The database is modified - any study, series or instance selection
* and the number of studies, series and instances reported will become invalid since
* other processes may modify the database before the exclusive lock is granted to this method.
* @param studyUID study instance UID of the instance to be deleted
* @param seriesUID series instance UID of the instance to be deleted
* @param instanceUID SOP instance UID of the instance to be deleted
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition deleteInstance(const char *studyUID, const char *seriesUID, const char *instanceUID);
/** deletes the given series from the database. Any of the corresponding DICOM files
* residing in the same directory as the index file are also removed.
* This method acquires a database lock which must be explicitly freed by the user.
* The database is modified - any study, series or instance selection
* and the number of studies, series and instances reported will become invalid since
* other processes may modify the database before the exclusive lock is granted to this method.
* @param studyUID study instance UID of the series to be deleted
* @param seriesUID series instance UID of the series to be deleted
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition deleteSeries(const char *studyUID, const char *seriesUID);
/** deletes the given study from the database. Any of the corresponding DICOM files
* residing in the same directory as the index file are also removed.
* This method acquires a database lock which must be explicitly freed by the user.
* The database is modified - any study, series or instance selection
* and the number of studies, series and instances reported will become invalid since
* other processes may modify the database before the exclusive lock is granted to this method.
* @param studyUID study instance UID of the study to be deleted
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition deleteStudy(const char *studyUID);
/* here follow the Network interface methods */
/** starts the network receiver processes (Storage Service Class SCPs).
* The receiver processes will wait for incoming DICOM associations, receive images
* and presentation states. Data will be stored in file and registered in the
* database index file. Attention: Successful return of this method is no guarantee
* that the network receiver has successfully started, because certain errors
* (i.e. incorrect settings in the config file) will only be noted in the network
* receiver process when running. On Unix platform, successful return of this method
* means that the fork() used to start the receiver was successful.
* On Win32 platforms, it means that the CreateProcess() call was successful.
* @return EC_Normal if the receiver processes could be started, an error code otherwise.
*/
OFCondition startReceiver();
/** terminates the network receiver process (Storage Service Class SCP).
* This method attempts to terminate the network receiver process by
* requesting a DICOM association with it and delivering a special "shutdown" command.
* If for some reason the network receiver cannot be found (i.e. because it has
* terminated abnormally), a TCP/IP timeout (several seconds) may occur before this method returns.
* @return EC_Normal if the receiver process could be terminated, an error code otherwise.
*/
OFCondition terminateReceiver();
/** starts the query/retrieve server process (Query/Retrieve Service Class SCP).
* The query/retrieve process will wait for incoming DICOM associations, serve queries and
* send the requested instances to the specified destination. Data will be taken from the
* same local database used to store received instances and created presentation states,
* stored print objects and hardcopy grayscale images.
* The configuration file which is required for the query/retrieve process will be created
* automatically from the 'global' configuration file each time this method is called, unless
* this automatical creation is disabled (entry: [QUERYRETIUEVE] AutoCreateConfigFile = false).
* Attention: Successful return of this method is no guarantee that the query/retrieve server
* has successfully started, because certain errors (i.e. incorrect settings in the config file)
* will only be noted in the query/retrieve process when running. On Unix platform, successful
* return of this method means that the fork() used to start the receiver was successful.
* On Win32 platforms, it means that the CreateProcess() call was successful.
* @return EC_Normal if the query/retrieve process could be started, an error code otherwise.
*/
OFCondition startQueryRetrieveServer();
/** terminates the query/retrieve server process (Query/Retrieve Service Class SCP).
* This method attempts to terminate the query/retrieve process by requesting a
* DICOM association with it and delivering a special "shutdown" command.
* If for some reason the query/retrieve server cannot be found (i.e. because it has
* terminated abnormally), a TCP/IP timeout (several seconds) may occur before this
* method returns.
* @return EC_Normal if the query/retrieve process could be terminated,
* an error code otherwise.
*/
OFCondition terminateQueryRetrieveServer();
/** tests whether the database has been modified in any way since the last
* call to this method. Any write access to the database (adding, deleting, changing)
* is reported. This method works by modifying and checking the "modification date/time"
* of the database index file. This method is not affected by database locks and can be
* called at any time.
* Always returns OFTrue for the first call after construction of the interface.
* Also returns OFTrue if something goes wrong (i.e. if the method cannot make sure
* that nothing has changed).
* @return OFTrue if the database has been modified since the last call to this method.
*/
OFBool newInstancesReceived();
/** sends a complete study over network to a different DICOM peer.
* A separate application or process is launched to handle the send operation.
* This call returns when the send operation has successfully been launched.
* No information about the status or success of the transfer itself is being made
* available.
* @param targetID symbolic identifier of the send target, must be one of the
* strings returned by getTargetID().
* @param studyUID Study Instance UID of the study to be sent. Must be a study
* contained in the database.
* @return EC_Normal when the send process has successfully been launched,
* an error condition otherwise.
*/
OFCondition sendStudy(const char *targetID, const char *studyUID)
{
return sendIOD(targetID, studyUID, NULL, NULL);
}
/** sends a complete series over network to a different DICOM peer.
* A separate application or process is launched to handle the send operation.
* This call returns when the send operation has successfully been launched.
* No information about the status or success of the transfer itself is being made
* available.
* @param targetID symbolic identifier of the send target, must be one of the
* strings returned by getTargetID().
* @param studyUID Study Instance UID of the series to be sent. Must be a series
* contained in the database.
* @param seriesUID Series Instance UID of the series to be sent. Must be a series
* contained in the database.
* @return EC_Normal when the send process has successfully been launched,
* an error condition otherwise.
*/
OFCondition sendSeries(const char *targetID, const char *studyUID, const char *seriesUID)
{
return sendIOD(targetID, studyUID, seriesUID, NULL);
}
/** sends a single instance (image or presentation state)
* over network to a different DICOM peer.
* A separate application or process is launched to handle the send operation.
* This call returns when the send operation has successfully been launched.
* No information about the status or success of the transfer itself is being made
* available.
* @param targetID symbolic identifier of the send target, must be one of the
* strings returned by getTargetID().
* @param studyUID Study Instance UID of the IOD to be sent. Must be an IOD
* contained in the database.
* @param seriesUID Series Instance UID of the IOD to be sent. Must be an IOD
* contained in the database.
* @param instanceUID SOP Instance UID of the IOD to be sent. Must be an IOD
* contained in the database.
* @return EC_Normal when the send process has successfully been launched,
* an error condition otherwise.
*/
OFCondition sendIOD(const char *targetID, const char *studyUID, const char *seriesUID, const char *instanceUID);
/** creates a dump of the contents of a DICOM file and displays it on-screen.
* A separate application or process is launched to handle the dump and display.
* This call returns when the dump operation has successfully been launched.
* No information about the status or success of the process itself is being made
* available.
* This method does not acquire a database lock.
* @param filename path of file to be displayed.
* @return EC_Normal when the process has successfully been launched,
* an error condition otherwise.
*/
OFCondition dumpIOD(const char *filename);
/** creates a dump of the contents of a DICOM file and displays it on-screen.
* A separate application or process is launched to handle the dump and display.
* This call returns when the dump operation has successfully been launched.
* No information about the status or success of the process itself is being made
* available.
* This method acquires a database lock which must be explicitly freed by the user.
* @param studyUID Study Instance UID of the IOD to be dumped. Must be an IOD
* contained in the database.
* @param seriesUID Series Instance UID of the IOD to be dumped. Must be an IOD
* contained in the database.
* @param instanceUID SOP Instance UID of the IOD to be dumped. Must be an IOD
* contained in the database.
* @return EC_Normal when the process has successfully been launched,
* an error condition otherwise.
*/
OFCondition dumpIOD(const char *studyUID, const char *seriesUID, const char *instanceUID);
/** checks the contents of a DICOM file and displays an evaluation report on the screen.
* A separate application or process is launched to handle the evaluation and display.
* This call returns when the check operation has successfully been launched.
* No information about the status or success of the process itself is being made
* available.
* This method does not acquire a database lock.
* @param filename path of file to be checked.
* @return EC_Normal when the process has successfully been launched,
* an error condition otherwise.
*/
OFCondition checkIOD(const char *filename);
/** checks the contents of a DICOM file and displays an evaluation report on the screen.
* A separate application or process is launched to handle the evaluation and display.
* This call returns when the check operation has successfully been launched.
* No information about the status or success of the process itself is being made
* available.
* This method acquires a database lock which must be explicitly freed by the user.
* @param studyUID Study Instance UID of the IOD to be checked. Must be an IOD
* contained in the database.
* @param seriesUID Series Instance UID of the IOD to be checked. Must be an IOD
* contained in the database.
* @param instanceUID SOP Instance UID of the IOD to be checked. Must be an IOD
* contained in the database.
* @return EC_Normal when the process has successfully been launched,
* an error condition otherwise.
*/
OFCondition checkIOD(const char *studyUID, const char *seriesUID, const char *instanceUID);
/** saves a monochrome bitmap as a DICOM Secondary Capture image.
* The bitmap must use one byte per pixel, left to right, top to bottom
* order of the pixels. 0 is interpreted as black, 255 as white.
* @param filename the file name or path under which the image is saved.
* @param pixelData a pointer to the image data. Must contain at least
* width*height bytes of data.
* @param width the width of the image, must be <= 0xFFFF
* @param height the height of the image, must be <= 0xFFFF
* @param aspectRatio the pixel aspect ratio as width/height. If omitted, a pixel
* aspect ratio of 1/1 is assumed.
* @param explicitVR selects the transfer syntax to be written.
* True selects Explicit VR Little Endian, False selects Implicit VR Little Endian.
* @param instanceUID optional parameter containing the SOP Instance UID to be written.
* This parameter should be omitted unless the SOP Instance UID needs to be controlled
* externally.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition saveDICOMImage(
const char *filename,
const void *pixelData,
unsigned long width,
unsigned long height,
double aspectRatio=1.0,
OFBool explicitVR=OFTrue,
const char *instanceUID=NULL);
/** saves a monochrome bitmap as a DICOM Secondary Capture image
* in the same directory in which the database index file resides.
* The filename is generated automatically.
* When the image is stored successfully, the database index is updated
* to include the new object.
* This method releases under any circumstances the database lock if it exists.
* @param pixelData a pointer to the image data. Must contain at least
* width*height bytes of data.
* @param width the width of the image, must be <= 0xFFFF
* @param height the height of the image, must be <= 0xFFFF
* @param aspectRatio the pixel aspect ratio as width/height. If omitted, a pixel
* aspect ratio of 1/1 is assumed.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition saveDICOMImage(
const void *pixelData,
unsigned long width,
unsigned long height,
double aspectRatio=1.0);
/** saves a monochrome bitmap as a DICOM Hardcopy Grayscale image.
* The bitmap must use 16 bits per pixel, left to right, top to bottom
* order of the pixels. It is assumed that only values 0..4095 are used.
* @param filename the file name or path under which the image is saved.
* @param pixelData a pointer to the image data. Must contain at least
* width*height*2 bytes of data.
* @param width the width of the image, must be <= 0xFFFF
* @param height the height of the image, must be <= 0xFFFF
* @param aspectRatio the pixel aspect ratio as width/height. If omitted, a pixel
* aspect ratio of 1/1 is assumed.
* @param explicitVR selects the transfer syntax to be written.
* True selects Explicit VR Little Endian, False selects Implicit VR Little Endian.
* @param instanceUID optional parameter containing the SOP Instance UID to be written.
* This parameter should be omitted unless the SOP Instance UID needs to be controlled
* externally.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition saveHardcopyGrayscaleImage(
const char *filename,
const void *pixelData,
unsigned long width,
unsigned long height,
double aspectRatio=1.0,
OFBool explicitVR=OFTrue,
const char *instanceUID=NULL);
/** saves a monochrome bitmap as a DICOM Hardcopy Grayscale image
* in the same directory in which the database index file resides.
* The filename is generated automatically.
* When the image is stored successfully, the database index is updated
* to include the new object.
* This method releases under any circumstances the database lock if it exists.
* @param pixelData a pointer to the image data. Must contain at least
* width*height*2 bytes of data.
* @param width the width of the image, must be <= 0xFFFF
* @param height the height of the image, must be <= 0xFFFF
* @param aspectRatio the pixel aspect ratio as width/height. If omitted, a pixel
* aspect ratio of 1/1 is assumed.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition saveHardcopyGrayscaleImage(
const void *pixelData,
unsigned long width,
unsigned long height,
double aspectRatio=1.0);
/** saves a DICOM object into a file in the same directory in which the
* database index file resides. The object must contain a SOP Class
* UID and SOP Instance UID. The filename is generated automatically.
* When the image is stored successfully, the database index is
* updated to include the new object. This method releases under any
* circumstances the database lock if it exists.
* @param fileformat the complete DICOM file object to be written
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition saveFileFormatToDB(DcmFileFormat &fileformat);
/** loads a Stored Print object which is contained in the database into memory.
* Attention: The current print job (Stored Print object) will be deleted by doing this.
* This method acquires a database lock which must be explicitly freed by the user.
* @param studyUID study instance UID of the Stored Print object
* @param seriesUID series instance UID of the Stored Print object
* @param instanceUID SOP instance UID of the Stored Print object
* @param changeStatus if true the stored print object is marked 'reviewed' (not new)
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition loadStoredPrint(const char *studyUID, const char *seriesUID, const char *instanceUID, OFBool changeStatus = OFFalse);
/** loads a Stored Print object (which need not be contained in the database) into memory.
* Attention: The current print job (Stored Print object) will be deleted by doing this.
* This method does not acquire a database lock.
* @param filename path and filename of the Stored Print object to be loaded
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition loadStoredPrint(const char *filename);
/** saves the current print job as a Stored Print object.
* @param filename the file name or path under which the image is saved.
* @param writeRequestedImageSize if false, the Requested Image Size attributes are not written,
* e. g. because they are not supported by the target printer.
* @param explicitVR selects the transfer syntax to be written.
* True selects Explicit VR Little Endian, False selects Implicit VR Little Endian.
* @param instanceUID optional parameter containing the SOP Instance UID to be written.
* This parameter should be omitted unless the SOP Instance UID needs to be controlled
* externally.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition saveStoredPrint(
const char *filename,
OFBool writeRequestedImageSize,
OFBool explicitVR=OFTrue,
const char *instanceUID=NULL);
/** saves the current print job as a Stored Print object
* in the same directory in which the database index file resides.
* The filename is generated automatically.
* When the image is stored successfully, the database index is updated
* to include the new object.
* This method releases under any circumstances the database lock if it exists.
* @param writeRequestedImageSize if false, the Requested Image Size attributes are not written,
* e. g. because they are not supported by the target printer.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition saveStoredPrint(OFBool writeRequestedImageSize);
/** gets the number of Hardcopy Grayscaleimages currently registered by the stored print object.
* @return number of images.
*/
size_t getNumberOfPrintPreviews();
/** loads a Hardcopy Grayscale image registered by the stored print object and creates a preview.
* The preview bitmap is implicitly scaled to fit into the rectangle specified by
* setMaxPrintPreviewWidthHeight().
* @param idx index of the image, must be < getNumberOfPrintPreviews()
* @param printLUT OFTrue if presentation LUT should be interpreted as a print presentation LUT
* (default, in this case there is no implicit scaling of the input width of the LUT and,
* therefore, the VOI transformation - which is absent for print - is used),
* OFFalse otherwise (softcopy interpretation of a presentation LUT)
* @param changeStatus if true the hardcopy grayscale image file is marked 'reviewed' (not new)
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition loadPrintPreview(size_t idx, OFBool printLUT = OFTrue, OFBool changeStatus = OFFalse);
/** removes a currently loaded Hardcopy Grayscale image from memory.
*/
void unloadPrintPreview();
/** gets number of bytes used for the print preview bitmap.
* (depends on width, height and depth)
* @return number of bytes used for the preview bitmap
*/
unsigned long getPrintPreviewSize();
/** sets the maximum print preview bitmap width and height.
* Larger images are scaled down (according to the pixel aspect ratio) to fit into
* the specified rectangle.
* Attention: If the values differ from the the previous ones the currently loaded
* hardcopy grayscale image (preview) is automatically detroyed and has to be re-loaded.
* @param width maximum width of preview bitmap (in pixels)
* @param height maximum height of preview bitmap (in pixels)
*/
void setMaxPrintPreviewWidthHeight(unsigned long width, unsigned long height);
/** gets width and height of print preview bitmap.
* The return values depend on the current maximum preview bitmap width/height values!
* @param width upon success, the bitmap width (in pixels) is returned in this parameter
* @param height upon success, the bitmap height (in pixels) is returned in this parameter
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getPrintPreviewWidthHeight(unsigned long &width, unsigned long &height);
/** writes the bitmap data of the print preview image into the given buffer.
* The storage area must be allocated and deleted from the calling method.
* @param bitmap pointer to storage area where the pixel data is copied to (array of 8 bit values)
* @param size specifies size of the storage area in bytes
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getPrintPreviewBitmap(void *bitmap, unsigned long size);
/** stores the current presentation state in a temporary place
* and creates a new presentation state that corresponds with an
* image displayed "without" presentation state.
* If called twice, an error code is returned.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition disablePState();
/** restores the stored presentation state (see disablePresentationState)
* and deletes the temporary presentation state.
* If no stored presentation state exists, returns an error.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition enablePState();
/** returns number of presentation states referencing the currently selected image.
* If no instance is currently selected or the selected instance is a presentation
* state, returns an error.
* @return number of presentation states, 0 if none available or an error occurred
*/
Uint32 getNumberOfPStates();
/** selects and loads specified presentation state referencing the currently selected
* image.
* @param idx index to be selected, must be < getNumberOfPStates()
* @param changeStatus if true the presentation state is marked 'reviewed' (not new)
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition selectPState(Uint32 idx, OFBool changeStatus = OFFalse);
/** returns description of specified presentation state referencing the currently
* selected image.
* @param idx index to be selected, must be < getNumberOfPStates()
* @return presentation state description or NULL idx is invalid
*/
const char *getPStateDescription(Uint32 idx);
/** returns label of specified presentation state referencing the currently
* selected image.
* @param idx index to be selected, must be < getNumberOfPStates()
* @return presentation state label or NULL idx is invalid
*/
const char *getPStateLabel(Uint32 idx);
/** checks whether display correction is possible (in principle),
* i.e. a valid monitor characteristics description exists
* and current system is a low-cost system (without built-in
* calibration).
* @param transform display transform to be checked (default: GSDF)
* @return OFTrue if display transform is possible, OFFalse otherwise
*/
OFBool isDisplayTransformPossible(DVPSDisplayTransform transform = DVPSD_GSDF);
/** sets ambient light value for the display transformation.
* @param value ambient light value to be set
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition setAmbientLightValue(double value);
/** returns ambient light value for the display transformation.
* @param value returned ambient light value
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition getAmbientLightValue(double &value);
/* print related methods */
/** selects the current printer. Also adjusts the destination AE title and the
* printer name attribute within the Stored Print object.
* @param targetID one of the printer target IDs returned by getTargetID().
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setCurrentPrinter(const char *targetID);
/** gets the current printer's target ID.
* @return printer target ID, can be NULL if no printer is defined
* in the configuration file.
*/
const char *getCurrentPrinter();
/** sets the (optional) print medium type.
* @param value new attribute value, may be NULL.
* The caller is responsible for making sure
* that the value is valid for the selected printer.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setPrinterMediumType(const char *value);
/** gets the (optional) print medium type.
* @return medium type, may be NULL.
*/
const char *getPrinterMediumType();
/** sets the (optional) printer film destination.
* @param value new attribute value, may be NULL.
* The caller is responsible for making sure
* that the value is valid for the selected printer.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setPrinterFilmDestination(const char *value);
/** gets the (optional) printer film destination.
* @return printer film destination, may be NULL or empty string.
*/
const char *getPrinterFilmDestination();
/** sets the (optional) printer film session label.
* @param value new attribute value, may be NULL.
* The caller is responsible for making sure
* that the value is valid for the selected printer.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setPrinterFilmSessionLabel(const char *value);
/** gets the (optional) printer film session label.
* @return printer film session label, may be NULL or empty string.
*/
const char *getPrinterFilmSessionLabel();
/** sets the (optional) print priority.
* @param value new attribute value, may be NULL.
* The caller is responsible for making sure
* that the value is valid for the selected printer.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setPrinterPriority(const char *value);
/** gets the (optional) print priority.
* @return print priority, may be NULL or empty string.
*/
const char *getPrinterPriority();
/** sets the (optional) print session owner ID.
* @param value new attribute value, may be NULL.
* The caller is responsible for making sure
* that the value is valid for the selected printer.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setPrinterOwnerID(const char *value);
/** gets the (optional) print session owner ID.
* @return print session owner ID, may be NULL or empty string.
*/
const char *getPrinterOwnerID();
/** sets the (optional) print number of copies.
* @param value new attribute value, may be 0.
* The caller is responsible for making sure
* that the value is valid for the selected printer.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setPrinterNumberOfCopies(unsigned long value);
/** gets the (optional) print number of copies.
* @return print number of copies, 0 if absent.
*/
unsigned long getPrinterNumberOfCopies();
/** resets the settings for basic film session (everything that
* is not managed by the Stored Print object) to initial state.
* Affects medium type, film destination, film session label,
* priority, owner ID, and number of copies.
*/
void clearFilmSessionSettings();
/** sets the LUT with the given identifier
* in the Presentation State as current Presentation LUT.
* @param lutID LUT identifier, as returned by getLUTID().
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition selectDisplayPresentationLUT(const char *lutID);
/** if the Presentation State contains an active
* Presentation LUT that was set with selectDisplayPresentationLUT(),
* return the corresponding LUT identifier.
* @return lutID if found, NULL or empty string otherwise.
*/
const char *getDisplayPresentationLUTID();
/** sets the LUT with the given identifier in the Stored Print object
* as current Presentation LUT. This LUT overrides the settings made
* for the separate image boxes, it can be deactivated using the method
* DVPSStoredPrint::setDefaultPresentationLUT().
* @param lutID LUT identifier, as returned by getLUTID().
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition selectPrintPresentationLUT(const char *lutID);
/** if the Stored Print object contains an active
* Presentation LUT that was set with selectPrintPresentationLUT(),
* return the corresponding LUT identifier.
* @return lutID if found, NULL or empty string otherwise.
*/
const char *getPrintPresentationLUTID();
/** start spooling of print job with current settings.
* @param deletePrintedImages if true, delete printed images from queue.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition spoolPrintJob(OFBool deletePrintedImages=OFTrue);
/** starts the print spooler process.
* The print spooler will wait for print jobs created with spoolPrintJob()
* and communicate them to the printer using the DICOM Print Management Service Class.
* Attention: Successful return of this method is no guarantee
* that the spooler has successfully started, because certain errors
* (i.e. incorrect settings in the config file) will only be noted in the spooler
* process when running. On Unix platform, successful return of this method
* means that the fork() used to start the spooler was successful.
* On Win32 platforms, it means that the CreateProcess() call was successful.
* @return EC_Normal if the spooler process could be started, an error code otherwise.
*/
OFCondition startPrintSpooler();
/** terminates the print spooler process. This method creates a "dummy"
* print job that request the print spooler to shutdown as soon as all other pending
* print jobs are finished.
* @return EC_Normal if the spooler process dummy print job could be written,
* an error code otherwise.
*/
OFCondition terminatePrintSpooler();
/** starts the print server process (Basic Grayscale Print Management SCP).
* The print server process will wait for incoming DICOM associations, handle the
* DICOM print protcol, store data in file and register stored print and grayscale
* image objects in the database index file.
* Attention: Successful return of this method is no guarantee that the print
* server has successfully started, because certain errors (i.e. incorrect settings
* in the config file) will only be noted in the print server process when running.
* On Unix platform, successful return of this method means that the fork() used to
* start the server was successful.
* On Win32 platforms, it means that the CreateProcess() call was successful.
* @return EC_Normal if the server process could be started, an error code otherwise.
*/
OFCondition startPrintServer();
/** terminates the print server process (Basic Grayscale Print Management SCP).
* This method attempts to terminate the print server process by requesting a DICOM
* association with it and delivering a special "shutdown" command.
* If for some reason the print server cannot be found (i.e. because it has terminated
* abnormally), a TCP/IP timeout (several seconds) may occur before this method returns.
* @return EC_Normal if the server process could be terminated, an error code otherwise.
*/
OFCondition terminatePrintServer();
/** adds an existing DICOM image (should be Hardcopy Grayscale)
* that is already present in the image database to the current print image queue
* without rendering it again.
* The "requested image size" option is not used - the bitmap is treated as if the
* presentation mode was "SCALE TO FIT".
* @param studyUID study instance UID of the image, as reported by getStudyUID()
* @param seriesUID series instance UID of the image, as reported by getSeriesUID()
* @param instanceUID SOP instance UID of the image, as reported by getInstanceUID()
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition addToPrintHardcopyFromDB(const char *studyUID, const char *seriesUID, const char *instanceUID);
/** requests the spooler process to print an old print job that is stored
* in the database as a "stored print" object. The Stored Print that is printed
* does not contain all parameters of a print job. The following parameters are taken from the
* current settings in this object: Target printer, medium type,
* illumination and reflected ambient light.
* @param studyUID study instance UID of the Stored Print, as reported by getStudyUID()
* @param seriesUID series instance UID of the Stored Print, as reported by getSeriesUID()
* @param instanceUID SOP instance UID of the Stored Print, as reported by getInstanceUID()
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition spoolStoredPrintFromDB(const char *studyUID, const char *seriesUID, const char *instanceUID);
/** Initiates the creation of a DICOM Basic Film Session SOP Instance in the printer.
* This method stores all Basic Film Session related attributes that are managed by this object
* in a DICOM dataset and passes the result to the embedded Stored Print object which manages
* the further communication.
* @param printHandler print communication handler, association must be open.
* @param plutInSession true if printer expects referenced presentation LUT sequence, illumination
* and reflected ambient light in basic film session, false if it expects them in basic film box.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition printSCUcreateBasicFilmSession(DVPSPrintMessageHandler& printHandler, OFBool plutInSession);
/* annotation interface */
/** gets the current setting of the annotation activity annotation flag.
* @return OFTrue if annotation is on, OFFalse otherwise.
*/
OFBool isActiveAnnotation() { return activateAnnotation; }
/** gets the current setting of the Prepend Date/Time annotation flag.
* @return OFTrue if Prepend Date/Time is on, OFFalse otherwise.
*/
OFBool getPrependDateTime() { return prependDateTime; }
/** gets the current setting of the Prepend Printer Name annotation flag.
* @return OFTrue if Prepend Printer Name is on, OFFalse otherwise.
*/
OFBool getPrependPrinterName() { return prependPrinterName; }
/** gets the current setting of the Prepend Lighting annotation flag.
* @return OFTrue if Prepend Lighting is on, OFFalse otherwise.
*/
OFBool getPrependLighting() { return prependLighting; }
/** gets the current annotation text.
* @return annotation text, may be NULL or empty string.
*/
const char *getAnnotationText() { return annotationText.c_str(); }
/** switches annotation printing on/off
* @param value OFTrue if annotation is switched on, OFFalse otherwise.
*/
void setActiveAnnotation(OFBool value) { activateAnnotation=value; }
/** sets the Prepend Date/Time annotation flag.
* @param value OFTrue if Prepend Date/Time is switched on, OFFalse otherwise.
*/
void setPrependDateTime(OFBool value) { prependDateTime=value; }
/** sets the Prepend Printer Name annotation flag.
* @param value OFTrue if Prepend Printer Name is switched on, OFFalse otherwise.
*/
void setPrependPrinterName(OFBool value) { prependPrinterName=value; }
/** sets the Prepend Lighting annotation flag.
* @param value OFTrue if Prepend Lighting is switched on, OFFalse otherwise.
*/
void setPrependLighting(OFBool value) { prependLighting=value; }
/** sets the current annotation text.
* @param value new text, may be NULL.
*/
void setAnnotationText(const char *value);
/* user management interface */
/** verifies the given password for the given user ID. This method tries
* to load and decrypt the private key for the given user with the
* given password. If this fails, the password verification fails,
* otherwise the password verification succeeds.
* This method requires that DCMTK be configured and compiled with
* the WITH_OPENSSL flag, otherwise always returns false.
* @param userID symbolic user ID for given user, as returned by
* DVConfiguration::getUserID()
* @param passwd for user as entered in some GUI control
* @return true if password verification succeeds, false otherwise.
*/
OFBool verifyUserPassword(const char *userID, const char *passwd);
/** verifies and digitally signs the current structured report.
* If the user ID is known (i.e. specified in the configuration file) the current
* structured report is verified (a verifying observer is added). If the 'mode'
* parameter is set accordingly and the password is correct (see verifyUserPassword)
* the report is also digitally signed.
* Please note that a document can be verified/signed more than once, but only completed
* documents can be verified. After signing the report no modifications should be performed
* before the object is stored in the database or a file. Otherwise the digital signature
* would be corrupted. Therefore, the SOP instance UID should be generated before calling
* this method.
* To digitally sign the report it is required that DCMTK is configured and compiled
* with the WITH_OPENSSL flag, otherwise only verification is available (returns an
* error code if mode differs from DVPSY_verify).
* @param userID symbolic user ID for given user, as returned by
* DVConfiguration::getUserID()
* @param passwd for user as entered in some GUI control
* @param mode flag specifying whether to verify only, verify and sign or verify and
* sign and finalize the document. The difference between the second and the third mode
* is that "finalize" always signs the entire document whereas the other mode only signs
* the marked items (if any, all items otherwise) and leaves out certain header attributes
* (e.g. the SOP instance UID and the verifying observer sequence).
* @return status, EC_Normal if successful, an error code otherwise.
*/
OFCondition verifyAndSignStructuredReport(const char *userID, const char *passwd, DVPSVerifyAndSignMode mode);
/* digital signatures */
/** returns a string containing a complete HTML page with the
* signature validation results for the last object of the
* given type. Never returns NULL.
* @param objtype object type
* @return pointer to string with HTML page
*/
const char *getCurrentSignatureValidationHTML(DVPSObjectType objtype) const;
/** returns a string containing a complete HTML page with the
* signature validation overview. Never returns NULL.
* @return pointer to string with HTML page
*/
const char *getCurrentSignatureValidationOverview() const;
/** returns the status flag for the current object of given type.
* @param objtype object type
* @return digital signature status for object
*/
DVPSSignatureStatus getCurrentSignatureStatus(DVPSObjectType objtype) const;
/** returns the combined status flag for the current image and presentation state.
* @return digital signature status for image and presentation state
*/
DVPSSignatureStatus getCombinedImagePStateSignatureStatus() const;
/** returns number of correct signatures for given object type.
* @param objtype object type
* @return number of digital signatures
*/
unsigned long getNumberOfCorrectSignatures(DVPSObjectType objtype) const;
/** returns number of untrustworthy signatures for given object type.
* @param objtype object type
* @return number of digital signatures
*/
unsigned long getNumberOfUntrustworthySignatures(DVPSObjectType objtype) const;
/** returns number of corrupt signatures for given object type.
* @param objtype object type
* @return number of digital signatures
*/
unsigned long getNumberOfCorruptSignatures(DVPSObjectType objtype) const;
/** disables internal settings for image and presentation state.
* Called when a new SR object is loaded and the current
* image/presentation state are hidden consequently.
*/
void disableImageAndPState();
private:
/** private undefined copy constructor
*/
DVInterface(const DVInterface&);
/** private undefined assignment operator
*/
DVInterface& operator=(const DVInterface&);
/** helper function that exchanges the current presentation state and image
* by the pointers passed and frees the old ones.
* @param newState new presentation state, must not be NULL
* @param image image file
* @param state presentation state if newState was not created from image.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition exchangeImageAndPState(DVPresentationState *newState, DcmFileFormat *image, DcmFileFormat *state=NULL);
/** creates a database handle if none exists yet (this method may
* be called multiple times without interference) and puts a shared lock
* on the database.
* The lock will remain until explicitly released with releaseDatabase();
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition lockDatabase();
/** creates an exlusive lock on the database if none exists.
* The lock will remain until explicitly released with releaseDatabase()
* or unlockExclusive().
* This method also clears the index cache.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition lockExclusive();
/** removes an exlusive lock on the database if any.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition unlockExclusive();
/** creates a new pair of filenames for print job creation.
* @param printer printer identifier
* @param tempname temporary name is returned here
* @param jobname print job name is returned here
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition createPrintJobFilenames(const char *printer, OFString& tempname, OFString& jobname);
/** creates the query/retrieve server configuration file.
* @param filename path to the configuration file (incl. filename)
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition createQueryRetrieveServerConfigFile(const char *filename);
/** starts an external application and passes a filename.
* @param application pathname of the application to be started
* @param filename filename to be passed as single parameter.
* @return EC_Normal if fork or CreateProcess succeeds, an error
* condition otherwise.
*/
OFCondition startExternalApplication(const char *application, const char *filename);
/* member variables */
/** pointer to the current print handler object
*/
DVPSStoredPrint *pPrint;
/** pointer to the current presentation state object
*/
DVPresentationState *pState;
/** pointer to the current structured reporting object (should never be NULL)
*/
DSRDocument *pReport;
/** pointer to the handler object for digital signatures
*/
DVSignatureHandler *pSignatureHandler;
/** pointer to the stored presentation state object (if any)
*/
DVPresentationState *pStoredPState;
/** pointer to the current DICOM image attached to the presentation state
*/
DcmFileFormat *pDicomImage;
/** pointer to the current DICOM dataset containing the loaded presentation state.
* Is NULL when the presentation state has been created "on the fly" from image.
*/
DcmFileFormat *pDicomPState;
/** pointer to the current hardcopy grayscale image (bitmap information only)
*/
DicomImage *pHardcopyImage;
/** a unique string generated for each instance of this class.
* Used to identify print jobs generated from this instance.
*/
OFString printJobIdentifier;
/** a counter used for generating print job names.
*/
unsigned long printJobCounter;
/** string containing the path name of the config file as passed to the ctor.
*/
OFString configPath;
/** string containing the path name of the database index file
* after a database lock has been acquired for the first time
*/
OFString databaseIndexFile;
/** initialized with construction time of the interface object
* minus one day. Used to check modifications of the database index file.
*/
unsigned long referenceTime;
/** list of display function object
*/
DiDisplayFunction *displayFunction[DVPSD_max];
/** handle to access database/index file
*/
DcmQueryRetrieveIndexDatabaseHandle *pHandle;
/** locking mode (OFFalse => shared, OFTrue => exclusive)
*/
OFBool lockingMode;
/** hierarchical cache structure to optimize index file access
*/
DVStudyCache idxCache;
/** record structure of index items (last read entry)
*/
IdxRecord idxRec;
/** position of last read index record (for optimization purposes)
*/
int idxRecPos;
/** OFTrue if current image is already stored in database, OFFalse otherwise
*/
OFBool imageInDatabase;
/* private methods for database */
/** creates index cache to optimize reading of index file
*/
OFBool createIndexCache();
/** creates cache of referencing pstates for the current image
*/
OFBool createPStateCache();
/** clears index cache (includes pstate cache)
*/
void clearIndexCache();
/** clears specified index record (and makes pos invalid)
*/
void clearIndexRecord(IdxRecord &record,
int &recpos);
/** reads specified index record (comparing pos with oldpos to avoid redundant
* loading)
*/
OFBool readIndexRecord(const int pos,
IdxRecord &record,
int *oldpos = NULL);
/** updates (hierarchical) status cache (propagates status information from instances
* to series and from series to studies)
*/
void updateStatusCache();
/** returns pointer to study struct specified by given UIDs or to current study
*/
DVStudyCache::ItemStruct *getStudyStruct(const char *studyUID = NULL,
const char *seriesUID = NULL);
/** returns pointer to series struct specified by given UIDs or to current series
*/
DVSeriesCache::ItemStruct *getSeriesStruct(const char *studyUID = NULL,
const char *seriesUID = NULL,
const char *instanceUID = NULL);
/** returns pointer to instance struct specified by given UIDs or to current instance
*/
DVInstanceCache::ItemStruct *getInstanceStruct(const char *studyUID = NULL,
const char *seriesUID = NULL,
const char *instanceUID = NULL);
/** returns index of specified study within study description record
*/
int findStudyIdx(StudyDescRecord *study,
const char *uid);
/** conditionally deletes given image file (only if file resides in index.dat directory)
*/
int deleteImageFile(const char *filename);
/** resets index file modification time to reference time (yesterday)
*/
void resetDatabaseReferenceTime();
/** modifies the review flag for one instance in the database (see method with three UID
* parameters)
*/
OFCondition instanceReviewed(int pos);
/** minimum width of print bitmap (used for implicit scaling)
*/
unsigned long minimumPrintBitmapWidth;
/** minimum height of print bitmap (used for implicit scaling)
*/
unsigned long minimumPrintBitmapHeight;
/** maximum width of print bitmap (used for implicit scaling)
*/
unsigned long maximumPrintBitmapWidth;
/** maximum height of print bitmap (used for implicit scaling)
*/
unsigned long maximumPrintBitmapHeight;
/** maximum width of print preview bitmap
*/
unsigned long maximumPrintPreviewWidth;
/** maximum height of print preview bitmap
*/
unsigned long maximumPrintPreviewHeight;
/** maximum width of (optional) preview image
*/
unsigned long maximumPreviewImageWidth;
/** maximum height of (optional) preview image
*/
unsigned long maximumPreviewImageHeight;
/** target ID of current printer, empty if no printer exists in config file
*/
OFString currentPrinter;
/** config file identifier of LUT currently selected as Display Presentation LUT
*/
OFString displayCurrentLUTID;
/** config file identifier of LUT currently selected as Print Presentation LUT
*/
OFString printCurrentLUTID;
/** printer medium type identifier, may be empty. VR=CS, VM=1
*/
OFString printerMediumType;
/** printer film destination identifier, may be empty. VR=CS, VM=1
*/
OFString printerFilmDestination;
/** printer film session label, may be empty. VR=LO, VM=1
*/
OFString printerFilmSessionLabel;
/** printer number of copies
*/
unsigned long printerNumberOfCopies;
/** printer print priority, may be empty. VR=CS, VM=1,
* enumerated values: HIGH, MED, LOW
*/
OFString printerPriority;
/** printer film session owner ID, may be empty. VR=SH, VM=1
*/
OFString printerOwnerID;
/** true if annotation should be created when spooling print job
*/
OFBool activateAnnotation;
/** true if date and time should be prepended to annotation text
*/
OFBool prependDateTime;
/** true if printer name should be prepended to annotation text
*/
OFBool prependPrinterName;
/** true if reflected ambient light and illumination should be prepended to annotation text
*/
OFBool prependLighting;
/** annotation text (if any)
*/
OFString annotationText;
};
#endif
/*
* CVS/RCS Log:
* $Log: dviface.h,v $
* Revision 1.95 2010-10-14 13:16:35 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.94 2009-11-24 14:12:57 uli
* Switched to logging mechanism provided by the "new" oflog module.
*
* Revision 1.93 2009-09-30 10:42:37 uli
* Make dcmpstat's include headers self-sufficient by including all
* needed headers directly and stop using dctk.h
*
* Revision 1.92 2009-05-28 10:55:38 joergr
* Fixed various Doxygen API documentation issues.
*
* Revision 1.91 2005/12/08 16:03:31 meichel
* Changed include path schema for all DCMTK header files
*
* Revision 1.90 2005/04/04 10:11:57 meichel
* Module dcmpstat now uses the dcmqrdb API instead of imagectn for maintaining
* the index database
*
* Revision 1.89 2004/02/04 15:48:23 joergr
* Removed acknowledgements with e-mail addresses from CVS log.
*
* Revision 1.88 2003/04/29 10:13:56 meichel
* Moved configuration file parser from module dcmpstat to ofstd and renamed
* class to OFConfigFile. Cleaned up implementation (no more friend declarations).
*
* Revision 1.87 2002/04/16 14:02:02 joergr
* Added configurable support for C++ ANSI standard includes (e.g. streams).
*
* Revision 1.86 2001/09/26 15:36:06 meichel
* Adapted dcmpstat to class OFCondition
*
* Revision 1.85 2001/02/23 13:31:46 joergr
* Changed behaviour of method verifyAndSignStructuredReport() with 'finalize'.
* Now the entire document is always signed independently from the tree items
* marked.
*
* Revision 1.84 2001/01/29 17:32:30 joergr
* Added method to verify and digitally sign structured reports.
*
* Revision 1.83 2001/01/29 14:55:41 meichel
* Added new methods for creating signatures and checking the signature
* status in module dcmpstat.
*
* Revision 1.82 2001/01/25 15:18:04 meichel
* Added initial support for verification of digital signatures
* in presentation states, images and structured reports to module dcmpstat.
*
* Revision 1.81 2000/11/14 16:35:16 joergr
* Added creation of new UIDs and setting of content date/time when starting
* a new SR document from a "template".
*
* Revision 1.80 2000/11/13 15:50:42 meichel
* Added dcmpstat support methods for creating image references
* in SR documents.
*
* Revision 1.79 2000/11/13 11:52:40 meichel
* Added support for user logins and certificates.
*
* Revision 1.78 2000/11/13 10:42:38 joergr
* Added support for Structured Reporting "templates".
*
* Revision 1.77 2000/10/16 11:39:43 joergr
* Added support for new structured reports.
* Added method allowing to select an instance by instance UID and SOP class
* UID (without series and study UID). Required for composite references in
* DICOM SR.
*
* Revision 1.76 2000/10/10 12:23:39 meichel
* Added extensions for TLS encrypted communication
*
* Revision 1.75 2000/07/18 16:02:35 joergr
* Moved method convertODtoLum/PValue from class DVInterface to DVPSStoredPrint
* and corrected implementation.
*
* Revision 1.74 2000/07/17 12:05:09 joergr
* Added methods to select objects from the database directly.
*
* Revision 1.73 2000/07/14 17:09:47 joergr
* Added changeStatus parameter to all methods loading instances from the
* database.
*
* Revision 1.72 2000/07/06 09:41:00 joergr
* Added flag to loadPrintPreview() method allowing to choose how to interpret
* the presentation LUT (hardcopy or softcopy definition).
*
* Revision 1.71 2000/07/04 15:58:00 joergr
* Added support for overriding the presentation LUT settings made for the
* image boxes.
*
* Revision 1.70 2000/06/21 15:40:57 meichel
* Added DICOMscope support for calling the Presentation State Checker.
*
* Revision 1.69 2000/06/09 10:13:54 joergr
* Added method to get number of presentation states referencing an image
* (specified by the three UIDs).
*
* Revision 1.68 2000/06/08 17:36:23 joergr
* Added method convertODtoLum().
*
* Revision 1.67 2000/06/07 14:15:52 joergr
* Added configuration file entry "LogLevel" to filter log messages.
* Added flag to constructor specifying whether the general log file should be
* used (default: off).
*
* Revision 1.66 2000/06/05 16:21:30 joergr
* Implemented log message methods.
* Added method allowing to specify the current presentation state to be used
* for resetting the pstate.
*
* Revision 1.65 2000/06/02 16:00:41 meichel
* Adapted all dcmpstat classes to use OFConsole for log and error output
*
* Revision 1.64 2000/06/02 13:53:53 joergr
* Implemented start/terminatePrintServer methods.
*
* Revision 1.63 2000/06/02 12:41:50 joergr
* Corrected wrong interface descriptions.
*
* Revision 1.62 2000/05/31 12:56:37 meichel
* Added initial Print SCP support
*
* Revision 1.61 2000/05/31 07:54:23 joergr
* Added support for Stored Print attributes Originator and Destination
* application entity title.
*
* Revision 1.60 2000/05/30 13:36:45 joergr
* Added new private SOP class (UID definition) to allow external shutdown
* of console applications via negotiation of this special SOP class
* (currently used for imagectn and dcmpsrcv).
* Renamed GrayscaleHardcopy to HardcopyGrayscale (which is the correct term
* according to the DICOM standard).
* Added support for multi-frame images and multiple references from a single
* presentation to a number of images.
* Removed methods which were already marked as "retired".
* Added interface methods to support the following new features:
* - start/terminate query/retrieve server
* - load stored print objects
* - create print preview from hardcopy grayscale images
* - check DICOM IODs for correctness (not yet implemented)
* - set presentation LUT for film session (not yet implemented)
* - start/terminate print server (not yet implemented)
* - write/filter log messages (not yet implemented)
*
* Revision 1.59 2000/03/08 16:28:47 meichel
* Updated copyright header.
*
* Revision 1.58 2000/03/03 14:13:54 meichel
* Implemented library support for redirecting error messages into memory
* instead of printing them to stdout/stderr for GUI applications.
*
* Revision 1.57 1999/11/03 13:05:31 meichel
* Added support for transmitting annotations in the film session label.
* Added support for dump tool launched from DVInterface.
*
* Revision 1.56 1999/10/20 10:47:13 joergr
* Added support for a down-scaled preview image of the current DICOM image
* (e.g. useful for online-windowing or print preview).
*
* Revision 1.55 1999/10/19 14:46:01 meichel
* added support for the Basic Annotation Box SOP Class
* as well as access methods for Max Density and Min Density.
*
* Revision 1.54 1999/10/07 17:21:45 meichel
* Reworked management of Presentation LUTs in order to create tighter
* coupling between Softcopy and Print.
*
* Revision 1.53 1999/09/27 10:41:52 meichel
* Print interface now copies current printer name, avoids JNI problems.
*
* Revision 1.52 1999/09/24 15:24:28 meichel
* Added support for CP 173 (Presentation LUT clarifications)
*
* Revision 1.51 1999/09/23 17:37:12 meichel
* Added support for Basic Film Session options to dcmpstat print code.
*
* Revision 1.50 1999/09/17 14:33:55 meichel
* Completed print spool functionality including Supplement 22 support
*
* Revision 1.49 1999/09/15 17:43:25 meichel
* Implemented print job dispatcher code for dcmpstat, adapted dcmprtsv
* and dcmpsprt applications.
*
* Revision 1.48 1999/09/13 15:19:08 meichel
* Added implementations for a number of further print API methods.
*
* Revision 1.47 1999/09/10 12:46:44 meichel
* Added implementations for a number of print API methods.
*
* Revision 1.46 1999/09/10 09:37:29 joergr
* Re-added automatically removed method declarations (maybe a problem with
* CVS's merge algorithm).
*
* Revision 1.43 1999/09/08 17:03:01 joergr
* Added support for new instance types in database (grayscale hardcopy and
* stored print).
*
* Revision 1.42 1999/09/08 16:42:01 meichel
* Moved configuration file evaluation to separate class.
*
* Revision 1.41 1999/09/01 16:14:39 meichel
* Added support for requested image size to print routines
*
* Revision 1.40 1999/08/31 16:54:44 meichel
* Added new sample application that allows to create simple print jobs.
*
* Revision 1.39 1999/08/31 14:02:05 meichel
* Added print related config file methods
*
* Revision 1.38 1999/08/27 15:57:55 meichel
* Added methods for saving hardcopy images and stored print objects
* either in file or in the local database.
*
* Revision 1.37 1999/08/25 16:47:20 joergr
* Moved method 'saveFileFormat()' to public part of the interface class.
*
* Revision 1.36 1999/05/05 14:25:26 joergr
* Added optional parameter to method loadPState (from database) to change
* instance reviewed flag for pstate and image.
*
* Revision 1.35 1999/04/29 15:25:37 joergr
* Added PresentationLabel to index file.
*
* Revision 1.34 1999/04/27 11:23:16 joergr
* Enhanced savePState() method: now image file is also added to index file
* and stored in image directory (if not already there).
* Added new entry to index file: Presentation Description.
*
* Revision 1.33 1999/03/03 13:24:32 joergr
* Added methods to get and set ambient light value (re: Barten transformation).
* Moved method 'isBartenTransformPossible()' from presentation state class to
* interface class.
*
* Revision 1.32 1999/03/02 12:52:51 joergr
* Added parameter to selectPState() specifying whether to change the review
* status of the loaded presentation state.
*
* Revision 1.31 1999/02/25 18:38:58 joergr
* Added some comments.
* Renamed methods enable/disablePState().
*
* Revision 1.30 1999/02/24 20:17:48 joergr
* Added methods to get a list of presentation states referencing the
* currently selected image.
* Added support for exchanging current presentation state (load from file)
* without deleting the current image.
*
* Revision 1.29 1999/02/22 14:20:20 joergr
* Added deletion of image files (depending on directory where the file is
* stored).
* Modified comments for getGUIConfig... methods to indicate that the
* specified key must be upper case.
* Reset reference time for file modification checking after the index file
* has been changed internally (delete and change status methods).
*
* Revision 1.28 1999/02/19 18:58:11 joergr
* Added methods to disable and (re-)enable PresentationStates.
* Added (private) helper methods to reduce redundant lines of code.
*
* Revision 1.27 1999/02/19 09:44:17 joergr
* Added comments to new database routines and related member variables.
*
* Revision 1.26 1999/02/18 18:46:19 joergr
* Re-implemented methods to access index file (delete methods are still
* missing).
* Removed parameter 'deletefile' from delete methods. This parameter is
* not necessary because the decision whether a images file is deleted only
* depends on the directory where the file is stored (see comments).
*
* Revision 1.25 1999/02/18 11:07:26 meichel
* Added new parameter explicitVR to interface methods savePState,
* saveDICOMImage. Allows to choose between explicit VR and implicit VR
* little endian format. Added new method saveCurrentImage that allows to
* save the current image to file.
*
* Revision 1.24 1999/02/17 10:05:30 meichel
* Moved creation of Display Function object from DVPresentationState to
* DVInterface to avoid unnecessary re-reads.
*
* Revision 1.23 1999/02/16 16:36:10 meichel
* Added method newInstancesReceived() to DVInterface class.
*
* Revision 1.22 1999/02/12 10:02:46 vorwerk
* added cache , changed deletemethods.
*
* Revision 1.21 1999/02/09 15:58:07 meichel
* Implemented methods that save images and presentation states in the DB.
*
* Revision 1.20 1999/02/08 10:52:33 meichel
* Updated documentation of dviface.h in Doc++ style.
* Removed dummy parameter from constructor.
*
* Revision 1.19 1999/02/05 17:45:35 meichel
* Added config file entry for monitor characteristics file. Monitor charac-
* teristics are passed to dcmimage if present to activate Barten transform.
*
* Revision 1.18 1999/02/05 11:38:01 vorwerk
* parameter in stripidxarray added.
*
* Revision 1.17 1999/01/29 16:01:05 meichel
* Reworked index file handle acquisition and locking code.
*
* Revision 1.16 1999/01/28 15:30:53 vorwerk
* New database lock method added.
*
* Revision 1.15 1999/01/27 15:28:34 vorwerk
* new method idxfiletest added to handle with indexfiles of length zero.
*
* Revision 1.14 1999/01/27 14:59:28 meichel
* Implemented DICOM network receive application "dcmpsrcv" which receives
* images and presentation states and stores them in the local database.
*
* Revision 1.13 1999/01/25 18:18:23 meichel
* Defined private SOP class UID for network receiver
* shutdown function. Cleanup up some code.
*
* Revision 1.12 1999/01/25 16:55:17 vorwerk
* function stripidxarray added.
*
* Revision 1.11 1999/01/25 13:05:55 meichel
* Implemented DVInterface::startReceiver()
* and several config file related methods.
*
* Revision 1.10 1999/01/20 19:25:25 meichel
* Implemented sendIOD method which creates a separate process for trans-
* mitting images from the local database to a remote communication peer.
*
* Revision 1.9 1999/01/19 15:14:48 vorwerk
* Methods for acesseing additional attributes added.
*
* Revision 1.8 1999/01/15 17:27:14 meichel
* added DVInterface method resetPresentationState() which allows to reset a
* presentation state to the initial state (after loading).
*
* Revision 1.7 1999/01/14 17:50:30 meichel
* added new method saveDICOMImage() to class DVInterface.
* Allows to store a bitmap as a DICOM image.
*
* Revision 1.6 1999/01/04 13:27:16 vorwerk
* line inserted
*
* Revision 1.5 1999/01/04 13:02:26 vorwerk
* getSeriesPerformingPhysicainsName() changed in getSeriesPerformingPhysiciansName()
*
* Revision 1.4 1998/12/22 17:57:03 meichel
* Implemented Presentation State interface for overlays,
* VOI LUTs, VOI windows, curves. Added test program that
* allows to add curve data to DICOM images.
*
* Revision 1.3 1998/12/22 15:50:06 vorwerk
* - constructor now with parameter for directory of index.dat
* - changed const methods in non-const-methods
* - added methods for attributes of DICOM-documents
* - added private method for operations on index.dat
*
* Revision 1.2 1998/11/30 11:26:59 joergr
* Added CVS/RCS log at end of file.
*
*
*/
|