Mercurial > hg > orthanc-python

comparison Resources/OrthancCPlugin-1.10.0.patch @ 143:d63c58d650ff

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix documentation in Orthanc SDK
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sat, 14 Oct 2023 17:12:55 +0200
parents 6288b8132659
children
comparison
equal deleted inserted replaced
142:6288b8132659 143:d63c58d650ff
1 --- OrthancCPlugin.h.orig 2023-09-21 18:02:41.830746493 +0200 1 --- OrthancCPlugin.h.orig 2023-10-14 17:06:44.406226125 +0200
2 +++ OrthancCPlugin.h 2023-09-21 18:04:07.977591228 +0200 2 +++ OrthancCPlugin.h 2023-10-14 17:09:26.978745058 +0200
3 @@ -1829,15 +1829,16 @@ 3 @@ -837,7 +837,7 @@
4 **/
5 typedef enum
6 {
7 - OrthancPluginDicomToJsonFlags_None = 0,
8 + OrthancPluginDicomToJsonFlags_None = 0, /*!< Default formatting */
9 OrthancPluginDicomToJsonFlags_IncludeBinary = (1 << 0), /*!< Include the binary tags */
10 OrthancPluginDicomToJsonFlags_IncludePrivateTags = (1 << 1), /*!< Include the private tags */
11 OrthancPluginDicomToJsonFlags_IncludeUnknownTags = (1 << 2), /*!< Include the tags unknown by the dictionary */
12 @@ -858,7 +858,7 @@
13 **/
14 typedef enum
15 {
16 - OrthancPluginCreateDicomFlags_None = 0,
17 + OrthancPluginCreateDicomFlags_None = 0, /*!< Default mode */
18 OrthancPluginCreateDicomFlags_DecodeDataUriScheme = (1 << 0), /*!< Decode fields encoded using data URI scheme */
19 OrthancPluginCreateDicomFlags_GenerateIdentifiers = (1 << 1), /*!< Automatically generate DICOM identifiers */
20
21 @@ -975,32 +975,46 @@
22 **/
23 typedef enum
24 {
25 + /**
26 + * Success: The DICOM instance is properly stored in the SCP
27 + **/
28 OrthancPluginStorageCommitmentFailureReason_Success = 0,
29 - /*!< Success: The DICOM instance is properly stored in the SCP */
30
31 + /**
32 + * 0110H: A general failure in processing the operation was encountered
33 + **/
34 OrthancPluginStorageCommitmentFailureReason_ProcessingFailure = 1,
35 - /*!< 0110H: A general failure in processing the operation was encountered */
36
37 + /**
38 + * 0112H: One or more of the elements in the Referenced SOP
39 + * Instance Sequence was not available
40 + **/
41 OrthancPluginStorageCommitmentFailureReason_NoSuchObjectInstance = 2,
42 - /*!< 0112H: One or more of the elements in the Referenced SOP
43 - Instance Sequence was not available */
44
45 + /**
46 + * 0213H: The SCP does not currently have enough resources to
47 + * store the requested SOP Instance(s)
48 + **/
49 OrthancPluginStorageCommitmentFailureReason_ResourceLimitation = 3,
50 - /*!< 0213H: The SCP does not currently have enough resources to
51 - store the requested SOP Instance(s) */
52
53 + /**
54 + * 0122H: Storage Commitment has been requested for a SOP Instance
55 + * with a SOP Class that is not supported by the SCP
56 + **/
57 OrthancPluginStorageCommitmentFailureReason_ReferencedSOPClassNotSupported = 4,
58 - /*!< 0122H: Storage Commitment has been requested for a SOP
59 - Instance with a SOP Class that is not supported by the SCP */
60
61 + /**
62 + * 0119H: The SOP Class of an element in the Referenced SOP
63 + * Instance Sequence did not correspond to the SOP class
64 + * registered for this SOP Instance at the SCP
65 + **/
66 OrthancPluginStorageCommitmentFailureReason_ClassInstanceConflict = 5,
67 - /*!< 0119H: The SOP Class of an element in the Referenced SOP
68 - Instance Sequence did not correspond to the SOP class registered
69 - for this SOP Instance at the SCP */
70
71 + /**
72 + * 0131H: The Transaction UID of the Storage Commitment Request is
73 + * already in use
74 + **/
75 OrthancPluginStorageCommitmentFailureReason_DuplicateTransactionUID = 6
76 - /*!< 0131H: The Transaction UID of the Storage Commitment Request
77 - is already in use */
78 } OrthancPluginStorageCommitmentFailureReason;
79
80
81 @@ -1829,15 +1843,16 @@
4 * @see OrthancPluginCheckVersion 82 * @see OrthancPluginCheckVersion
5 * @ingroup Callbacks 83 * @ingroup Callbacks
6 **/ 84 **/
7 - ORTHANC_PLUGIN_INLINE int OrthancPluginCheckVersionAdvanced( 85 - ORTHANC_PLUGIN_INLINE int OrthancPluginCheckVersionAdvanced(
8 + ORTHANC_PLUGIN_INLINE int32_t OrthancPluginCheckVersionAdvanced( 86 + ORTHANC_PLUGIN_INLINE int32_t OrthancPluginCheckVersionAdvanced(
21 + if (sizeof(int) != sizeof(int32_t) || /* Ensure binary compatibility with Orthanc SDK <= 1.12.1 */ 99 + if (sizeof(int) != sizeof(int32_t) || /* Ensure binary compatibility with Orthanc SDK <= 1.12.1 */
22 + sizeof(int32_t) != sizeof(OrthancPluginErrorCode) || 100 + sizeof(int32_t) != sizeof(OrthancPluginErrorCode) ||
23 sizeof(int32_t) != sizeof(OrthancPluginHttpMethod) || 101 sizeof(int32_t) != sizeof(OrthancPluginHttpMethod) ||
24 sizeof(int32_t) != sizeof(_OrthancPluginService) || 102 sizeof(int32_t) != sizeof(_OrthancPluginService) ||
25 sizeof(int32_t) != sizeof(_OrthancPluginProperty) || 103 sizeof(int32_t) != sizeof(_OrthancPluginProperty) ||
26 @@ -1935,7 +1936,7 @@ 104 @@ -1935,7 +1950,7 @@
27 * @see OrthancPluginCheckVersionAdvanced 105 * @see OrthancPluginCheckVersionAdvanced
28 * @ingroup Callbacks 106 * @ingroup Callbacks
29 **/ 107 **/
30 - ORTHANC_PLUGIN_INLINE int OrthancPluginCheckVersion( 108 - ORTHANC_PLUGIN_INLINE int OrthancPluginCheckVersion(
31 + ORTHANC_PLUGIN_INLINE int32_t OrthancPluginCheckVersion( 109 + ORTHANC_PLUGIN_INLINE int32_t OrthancPluginCheckVersion(
32 OrthancPluginContext* context) 110 OrthancPluginContext* context)
33 { 111 {
34 return OrthancPluginCheckVersionAdvanced( 112 return OrthancPluginCheckVersionAdvanced(
35 @@ -3077,7 +3078,7 @@ 113 @@ -3077,7 +3092,7 @@
36 * @return 1 if the metadata is present, 0 if it is absent, -1 in case of error. 114 * @return 1 if the metadata is present, 0 if it is absent, -1 in case of error.
37 * @ingroup DicomInstance 115 * @ingroup DicomInstance
38 **/ 116 **/
39 - ORTHANC_PLUGIN_INLINE int OrthancPluginHasInstanceMetadata( 117 - ORTHANC_PLUGIN_INLINE int OrthancPluginHasInstanceMetadata(
40 + ORTHANC_PLUGIN_INLINE int32_t OrthancPluginHasInstanceMetadata( 118 + ORTHANC_PLUGIN_INLINE int32_t OrthancPluginHasInstanceMetadata(
41 OrthancPluginContext* context, 119 OrthancPluginContext* context,
42 const OrthancPluginDicomInstance* instance, 120 const OrthancPluginDicomInstance* instance,
43 const char* metadata) 121 const char* metadata)
44 @@ -3856,13 +3857,13 @@ 122 @@ -3856,13 +3871,13 @@
45 OrthancPluginContext* context, 123 OrthancPluginContext* context,
46 OrthancPluginRestOutput* output, 124 OrthancPluginRestOutput* output,
47 uint16_t status, 125 uint16_t status,
48 - const char* body, 126 - const char* body,
49 + const void* body, 127 + const void* body,
55 - params.body = body; 133 - params.body = body;
56 + params.body = reinterpret_cast<const char*>(body); 134 + params.body = reinterpret_cast<const char*>(body);
57 params.bodySize = bodySize; 135 params.bodySize = bodySize;
58 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, &params); 136 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, &params);
59 } 137 }
60 @@ -6760,7 +6761,7 @@ 138 @@ -6760,7 +6775,7 @@
61 { 139 {
62 char** resultId; 140 char** resultId;
63 OrthancPluginJob *job; 141 OrthancPluginJob *job;
64 - int priority; 142 - int priority;
65 + int32_t priority; 143 + int32_t priority;
66 } _OrthancPluginSubmitJob; 144 } _OrthancPluginSubmitJob;
67 145
68 /** 146 /**
69 @@ -6779,7 +6780,7 @@ 147 @@ -6779,7 +6794,7 @@
70 ORTHANC_PLUGIN_INLINE char *OrthancPluginSubmitJob( 148 ORTHANC_PLUGIN_INLINE char *OrthancPluginSubmitJob(
71 OrthancPluginContext *context, 149 OrthancPluginContext *context,
72 OrthancPluginJob *job, 150 OrthancPluginJob *job,
73 - int priority) 151 - int priority)
74 + int32_t priority) 152 + int32_t priority)