Mercurial > hg > orthanc-java
annotate JavaSDK/be/uclouvain/orthanc/WorklistQuery.java @ 20:1c407ba1d311
update year to 2024
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 05 Jan 2024 16:36:44 +0100 |
parents | 15dc698243ac |
children |
rev | line source |
---|---|
0 | 1 package be.uclouvain.orthanc; |
2 | |
3 /** | |
18 | 4 * SPDX-FileCopyrightText: 2023-2024 Sebastien Jodogne, UCLouvain, Belgium |
0 | 5 * SPDX-License-Identifier: GPL-3.0-or-later |
6 */ | |
7 | |
8 /** | |
9 * Java plugin for Orthanc | |
18 | 10 * Copyright (C) 2023-2024 Sebastien Jodogne, UCLouvain, Belgium |
0 | 11 * |
12 * This program is free software: you can redistribute it and/or | |
13 * modify it under the terms of the GNU General Public License as | |
14 * published by the Free Software Foundation, either version 3 of the | |
15 * License, or (at your option) any later version. | |
16 * | |
17 * This program is distributed in the hope that it will be useful, but | |
18 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
20 * General Public License for more details. | |
21 * | |
22 * You should have received a copy of the GNU General Public License | |
23 * along with this program. If not, see http://www.gnu.org/licenses/. | |
24 **/ | |
25 | |
26 | |
8
26c08ff926a3
added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
27 // WARNING: Auto-generated file. Do not modify it by hand. |
26c08ff926a3
added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
28 |
0 | 29 /** |
30 * DICOM C-FIND worklist query | |
31 **/ | |
32 public class WorklistQuery { | |
33 private long self; | |
34 | |
35 /** | |
36 * Construct a Java object wrapping a C object that is managed by Orthanc. | |
37 * @param self Pointer to the C object. | |
38 **/ | |
39 protected WorklistQuery(long self) { | |
40 if (self == 0) { | |
41 throw new IllegalArgumentException("Null pointer"); | |
42 } else { | |
43 this.self = self; | |
44 } | |
45 } | |
46 | |
47 /** | |
48 * Return the C object that is associated with this Java wrapper. | |
49 * @return Pointer to the C object. | |
50 **/ | |
51 protected long getSelf() { | |
52 return self; | |
53 } | |
54 | |
55 | |
56 | |
57 /** | |
58 * Test whether a worklist matches the query. | |
59 * | |
60 * This function checks whether one worklist (encoded as a DICOM file) matches the | |
61 * C-Find SCP query against modality worklists. This function must be called before | |
62 * adding the worklist as an answer through OrthancPluginWorklistAddAnswer(). | |
63 * | |
64 * @param dicom The worklist to answer, encoded as a DICOM file. | |
65 * @return 1 if the worklist matches the query, 0 otherwise. | |
66 **/ | |
67 public int worklistIsMatch( | |
68 byte[] dicom) { | |
69 return NativeSDK.OrthancPluginWorklistIsMatch(self, dicom); | |
70 } | |
71 | |
72 /** | |
73 * Retrieve the worklist query as a DICOM file. | |
74 * | |
75 * This function retrieves the DICOM file that underlies a C-Find SCP query against | |
76 * modality worklists. | |
77 * | |
78 * @return The resulting memory buffer. | |
79 **/ | |
80 public byte[] worklistGetDicomQuery() { | |
81 return NativeSDK.OrthancPluginWorklistGetDicomQuery(self); | |
82 } | |
83 | |
84 } |