orthanc-python: Resources/Orthanc/Sdk-1.10.0/CodeModel.json annotate

annotate Resources/Orthanc/Sdk-1.10.0/CodeModel.json @ 194:0c5da632f34d java-code-model

added description of classes

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Tue, 02 Jul 2024 18:47:12 +0200
parents	8382c7dea471
children

rev	line source
172 8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2 "classes": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4 "destructor": "OrthancPluginFreeDicomInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	5 "methods": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	6 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	7 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	8 "c_function": "OrthancPluginGetInstanceRemoteAet",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	9 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	10 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	11 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	12 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	13 "This function returns the Application Entity Title (AET) of the DICOM modality from which a DICOM instance originates."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	14 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	15 "return": "The AET if success, NULL if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	16 "summary": "Get the AET of a DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	17 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	18 "return_sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	19 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	20 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	21 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	22 "c_function": "OrthancPluginGetInstanceSize",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	23 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	24 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	25 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	26 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	27 "This function returns the number of bytes of the given DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	28 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	29 "return": "The size of the file, -1 in case of error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	30 "summary": "Get the size of a DICOM file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	31 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	32 "return_sdk_type": "int64_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	33 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	34 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	35 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	36 "c_function": "OrthancPluginGetInstanceJson",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	37 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	38 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	39 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	40 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	41 "This function returns a pointer to a newly created string containing a JSON file. This JSON file encodes the tag hierarchy of the given DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	42 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	43 "return": "The NULL value in case of error, or a string containing the JSON file. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	44 "summary": "Get the DICOM tag hierarchy as a JSON file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	45 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	46 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	47 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	48 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	49 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	50 "c_function": "OrthancPluginGetInstanceSimplifiedJson",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	51 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	52 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	53 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	54 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	55 "This function returns a pointer to a newly created string containing a JSON file. This JSON file encodes the tag hierarchy of the given DICOM instance. In contrast with ::OrthancPluginGetInstanceJson(), the returned JSON file is in its simplified version."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	56 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	57 "return": "The NULL value in case of error, or a string containing the JSON file. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	58 "summary": "Get the DICOM tag hierarchy as a JSON file (with simplification)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	59 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	60 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	61 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	62 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	63 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	64 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	65 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	66 "sdk_name": "metadata",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	67 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	68 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	69 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	70 "c_function": "OrthancPluginHasInstanceMetadata",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	71 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	72 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	73 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	74 "metadata": "The metadata of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	75 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	76 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	77 "This function checks whether the DICOM instance of interest is associated with some metadata. As of Orthanc 0.8.1, in the callbacks registered by ::OrthancPluginRegisterOnStoredInstanceCallback(), the only possibly available metadata are \"ReceptionDate\", \"RemoteAET\" and \"IndexInSeries\"."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	78 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	79 "return": "1 if the metadata is present, 0 if it is absent, -1 in case of error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	80 "summary": "Check whether a DICOM instance is associated with some metadata."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	81 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	82 "return_sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	83 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	84 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	85 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	86 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	87 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	88 "sdk_name": "metadata",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	89 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	90 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	91 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	92 "c_function": "OrthancPluginGetInstanceMetadata",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	93 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	94 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	95 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	96 "metadata": "The metadata of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	97 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	98 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	99 "This functions returns the value of some metadata that is associated with the DICOM instance of interest. Before calling this function, the existence of the metadata must have been checked with ::OrthancPluginHasInstanceMetadata()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	100 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	101 "return": "The metadata value if success, NULL if error. Please note that the returned string belongs to the instance object and must NOT be deallocated. Please make a copy of the string if you wish to access it later.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	102 "summary": "Get the value of some metadata associated with a given DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	103 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	104 "return_sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	105 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	106 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	107 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	108 "c_function": "OrthancPluginGetInstanceOrigin",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	109 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	110 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	111 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	112 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	113 "This function returns the origin of a DICOM instance that has been received by Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	114 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	115 "return": "The origin of the instance.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	116 "summary": "Get the origin of a DICOM file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	117 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	118 "return_sdk_enumeration": "OrthancPluginInstanceOrigin",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	119 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	120 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	121 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	122 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	123 "c_function": "OrthancPluginGetInstanceTransferSyntaxUid",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	124 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	125 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	126 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	127 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	128 "This function returns a pointer to a newly created string that contains the transfer syntax UID of the DICOM instance. The empty string might be returned if this information is unknown."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	129 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	130 "return": "The NULL value in case of error, or a string containing the transfer syntax UID. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	131 "summary": "Get the transfer syntax of a DICOM file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	132 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	133 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	134 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	135 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	136 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	137 "c_function": "OrthancPluginHasInstancePixelData",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	138 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	139 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	140 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	141 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	142 "This function returns a Boolean value indicating whether the DICOM instance contains the pixel data (7FE0,0010) tag."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	143 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	144 "return": "\"1\" if the DICOM instance contains pixel data, or \"0\" if the tag is missing, or \"-1\" in the case of an error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	145 "summary": "Check whether the DICOM file has pixel data."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	146 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	147 "return_sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	148 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	149 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	150 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	151 "c_function": "OrthancPluginGetInstanceFramesCount",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	152 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	153 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	154 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	155 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	156 "This function returns the number of frames that are part of a DICOM image managed by the Orthanc core."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	157 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	158 "return": "The number of frames (will be zero in the case of an error).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	159 "summary": "Get the number of frames in a DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	160 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	161 "return_sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	162 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	163 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	164 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	165 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	166 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	167 "sdk_name": "frameIndex",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	168 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	169 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	170 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	171 "c_function": "OrthancPluginGetInstanceRawFrame",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	172 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	173 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	174 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	175 "frameIndex": "The index of the frame of interest.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	176 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	177 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	178 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	179 "This function returns a memory buffer containing the raw content of a frame in a DICOM instance that is managed by the Orthanc core. This is notably useful for compressed transfer syntaxes, as it gives access to the embedded files (such as JPEG, JPEG-LS or JPEG2k). The Orthanc core transparently reassembles the fragments to extract the raw frame."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	180 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	181 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	182 "summary": "Get the raw content of a frame in a DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	183 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	184 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	185 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	186 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	187 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	188 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	189 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	190 "sdk_name": "frameIndex",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	191 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	192 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	193 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	194 "c_function": "OrthancPluginGetInstanceDecodedFrame",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	195 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	196 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	197 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	198 "frameIndex": "The index of the frame of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	199 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	200 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	201 "This function decodes one frame of a DICOM image that is managed by the Orthanc core."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	202 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	203 "return": "The uncompressed image. It must be freed with OrthancPluginFreeImage().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	204 "summary": "Decode one frame from a DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	205 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	206 "return_sdk_class": "OrthancPluginImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	207 "return_sdk_type": "object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	208 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	209 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	210 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	211 "c_function": "OrthancPluginSerializeDicomInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	212 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	213 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	214 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	215 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	216 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	217 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	218 "This function returns a memory buffer containing the serialization of a DICOM instance that is managed by the Orthanc core."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	219 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	220 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	221 "summary": "Writes a DICOM instance to a memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	222 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	223 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	224 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	225 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	226 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	227 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	228 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	229 "sdk_enumeration": "OrthancPluginDicomToJsonFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	230 "sdk_name": "format",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	231 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	232 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	233 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	234 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	235 "sdk_enumeration": "OrthancPluginDicomToJsonFlags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	236 "sdk_name": "flags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	237 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	238 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	239 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	240 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	241 "sdk_name": "maxStringLength",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	242 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	243 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	244 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	245 "c_function": "OrthancPluginGetInstanceAdvancedJson",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	246 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	247 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	248 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	249 "flags": "Flags governing the output.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	250 "format": "The output format.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	251 "maxStringLength": "The maximum length of a field. Too long fields will be output as \"null\". The 0 value means no maximum length."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	252 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	253 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	254 "This function takes as DICOM instance managed by the Orthanc core, and outputs a JSON string representing the tags of this DICOM file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	255 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	256 "return": "The NULL value if the case of an error, or the JSON string. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	257 "summary": "Format a DICOM memory buffer as a JSON string."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	258 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	259 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	260 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	261 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	262 "name": "OrthancPluginDicomInstance"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	263 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	264 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	265 "methods": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	266 "name": "OrthancPluginDicomWebNode"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	267 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	268 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	269 "methods": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	270 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	271 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	272 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	273 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	274 "sdk_name": "dicom",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	275 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	276 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	277 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	278 "c_function": "OrthancPluginFindAddAnswer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	279 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	280 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	281 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	282 "dicom": "The answer to be added, encoded as a DICOM file.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	283 "size": "The size of the DICOM file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	284 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	285 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	286 "This function adds one answer (encoded as a DICOM file) to the set of answers corresponding to some C-Find SCP request that is not related to modality worklists."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	287 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	288 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	289 "summary": "Add one answer to some C-Find request."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	290 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	291 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	292 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	293 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	294 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	295 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	296 "c_function": "OrthancPluginFindMarkIncomplete",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	297 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	298 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	299 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	300 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	301 "This function marks as incomplete the set of answers corresponding to some C-Find SCP request that is not related to modality worklists. This must be used if canceling the handling of a request when too many answers are to be returned."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	302 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	303 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	304 "summary": "Mark the set of C-Find answers as incomplete."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	305 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	306 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	307 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	308 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	309 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	310 "name": "OrthancPluginFindAnswers"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	311 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	312 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	313 "destructor": "OrthancPluginFreeFindMatcher",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	314 "methods": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	315 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	316 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	317 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	318 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	319 "sdk_name": "dicom",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	320 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	321 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	322 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	323 "c_function": "OrthancPluginFindMatcherIsMatch",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	324 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	325 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	326 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	327 "dicom": "The DICOM instance to be matched.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	328 "size": "The size of the DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	329 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	330 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	331 "This function checks whether one DICOM instance matches C-Find matcher that was previously allocated using OrthancPluginCreateFindMatcher()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	332 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	333 "return": "1 if the DICOM instance matches the query, 0 otherwise.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	334 "summary": "Test whether a DICOM instance matches a C-Find query."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	335 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	336 "return_sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	337 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	338 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	339 "name": "OrthancPluginFindMatcher"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	340 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	341 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	342 "methods": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	343 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	344 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	345 "c_function": "OrthancPluginGetFindQuerySize",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	346 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	347 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	348 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	349 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	350 "This function returns the number of tags that are contained in the given C-Find query."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	351 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	352 "return": "The number of tags.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	353 "summary": "Get the number of tags in a C-Find query."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	354 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	355 "return_sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	356 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	357 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	358 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	359 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	360 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	361 "sdk_name": "index",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	362 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	363 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	364 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	365 "c_function": "OrthancPluginGetFindQueryTagName",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	366 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	367 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	368 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	369 "index": "The index of the tag of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	370 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	371 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	372 "This function returns the symbolic name of one DICOM tag in the given C-Find query."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	373 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	374 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	375 "summary": "Get the symbolic name of one tag in a C-Find query."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	376 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	377 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	378 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	379 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	380 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	381 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	382 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	383 "sdk_name": "index",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	384 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	385 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	386 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	387 "c_function": "OrthancPluginGetFindQueryValue",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	388 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	389 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	390 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	391 "index": "The index of the tag of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	392 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	393 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	394 "This function returns the value associated with one tag in the given C-Find query."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	395 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	396 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	397 "summary": "Get the value associated with one tag in a C-Find query."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	398 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	399 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	400 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	401 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	402 "name": "OrthancPluginFindQuery"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	403 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	404 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	405 "destructor": "OrthancPluginFreeImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	406 "methods": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	407 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	408 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	409 "c_function": "OrthancPluginGetImagePixelFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	410 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	411 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	412 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	413 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	414 "This function returns the type of memory layout for the pixels of the given image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	415 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	416 "return": "The pixel format.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	417 "summary": "Return the pixel format of an image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	418 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	419 "return_sdk_enumeration": "OrthancPluginPixelFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	420 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	421 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	422 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	423 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	424 "c_function": "OrthancPluginGetImageWidth",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	425 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	426 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	427 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	428 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	429 "This function returns the width of the given image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	430 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	431 "return": "The width.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	432 "summary": "Return the width of an image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	433 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	434 "return_sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	435 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	436 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	437 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	438 "c_function": "OrthancPluginGetImageHeight",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	439 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	440 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	441 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	442 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	443 "This function returns the height of the given image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	444 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	445 "return": "The height.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	446 "summary": "Return the height of an image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	447 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	448 "return_sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	449 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	450 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	451 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	452 "c_function": "OrthancPluginGetImagePitch",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	453 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	454 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	455 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	456 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	457 "This function returns the pitch of the given image. The pitch is defined as the number of bytes between 2 successive lines of the image in the memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	458 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	459 "return": "The pitch.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	460 "summary": "Return the pitch of an image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	461 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	462 "return_sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	463 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	464 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	465 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	466 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	467 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	468 "sdk_enumeration": "OrthancPluginPixelFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	469 "sdk_name": "targetFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	470 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	471 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	472 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	473 "c_function": "OrthancPluginConvertPixelFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	474 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	475 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	476 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	477 "targetFormat": "The target pixel format."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	478 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	479 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	480 "This function creates a new image, changing the memory layout of the pixels."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	481 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	482 "return": "The resulting image. It must be freed with OrthancPluginFreeImage().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	483 "summary": "Change the pixel format of an image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	484 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	485 "return_sdk_class": "OrthancPluginImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	486 "return_sdk_type": "object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	487 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	488 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	489 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	490 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	491 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	492 "sdk_name": "fontIndex",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	493 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	494 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	495 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	496 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	497 "sdk_name": "utf8Text",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	498 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	499 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	500 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	501 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	502 "sdk_name": "x",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	503 "sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	504 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	505 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	506 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	507 "sdk_name": "y",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	508 "sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	509 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	510 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	511 "name": "arg4",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	512 "sdk_name": "r",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	513 "sdk_type": "uint8_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	514 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	515 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	516 "name": "arg5",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	517 "sdk_name": "g",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	518 "sdk_type": "uint8_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	519 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	520 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	521 "name": "arg6",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	522 "sdk_name": "b",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	523 "sdk_type": "uint8_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	524 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	525 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	526 "c_function": "OrthancPluginDrawText",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	527 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	528 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	529 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	530 "b": "The value of the blue color channel of the text.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	531 "fontIndex": "The index of the font. This value must be less than OrthancPluginGetFontsCount().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	532 "g": "The value of the green color channel of the text.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	533 "r": "The value of the red color channel of the text.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	534 "utf8Text": "The text to be drawn, encoded as an UTF-8 zero-terminated string.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	535 "x": "The X position of the text over the image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	536 "y": "The Y position of the text over the image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	537 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	538 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	539 "This function draws some text on some image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	540 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	541 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	542 "summary": "Draw text on an image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	543 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	544 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	545 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	546 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	547 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	548 "name": "OrthancPluginImage"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	549 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	550 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	551 "destructor": "OrthancPluginFreeJob",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	552 "methods": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	553 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	554 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	555 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	556 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	557 "sdk_name": "priority",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	558 "sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	559 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	560 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	561 "c_function": "OrthancPluginSubmitJob",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	562 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	563 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	564 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	565 "priority": "The priority of the job."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	566 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	567 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	568 "This function adds the given job to the pending jobs of Orthanc. Orthanc will take take of freeing it by invoking the finalization callback provided to OrthancPluginCreateJob()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	569 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	570 "return": "ID of the newly-submitted job. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	571 "summary": "Submit a new job to the jobs engine of Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	572 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	573 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	574 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	575 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	576 "name": "OrthancPluginJob"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	577 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	578 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	579 "destructor": "OrthancPluginFreePeers",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	580 "methods": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	581 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	582 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	583 "c_function": "OrthancPluginGetPeersCount",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	584 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	585 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	586 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	587 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	588 "This function returns the number of Orthanc peers.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	589 "This function is thread-safe: Several threads sharing the same OrthancPluginPeers object can simultaneously call this function."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	590 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	591 "return": "The number of peers.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	592 "summary": "Get the number of Orthanc peers."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	593 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	594 "return_sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	595 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	596 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	597 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	598 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	599 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	600 "sdk_name": "peerIndex",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	601 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	602 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	603 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	604 "c_function": "OrthancPluginGetPeerName",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	605 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	606 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	607 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	608 "peerIndex": "The index of the peer of interest. This value must be lower than OrthancPluginGetPeersCount()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	609 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	610 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	611 "This function returns the symbolic name of the Orthanc peer, which corresponds to the key of the \"OrthancPeers\" configuration option of Orthanc.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	612 "This function is thread-safe: Several threads sharing the same OrthancPluginPeers object can simultaneously call this function."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	613 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	614 "return": "The symbolic name, or NULL in the case of an error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	615 "summary": "Get the symbolic name of an Orthanc peer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	616 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	617 "return_sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	618 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	619 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	620 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	621 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	622 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	623 "sdk_name": "peerIndex",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	624 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	625 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	626 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	627 "c_function": "OrthancPluginGetPeerUrl",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	628 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	629 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	630 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	631 "peerIndex": "The index of the peer of interest. This value must be lower than OrthancPluginGetPeersCount()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	632 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	633 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	634 "This function returns the base URL to the REST API of some Orthanc peer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	635 "This function is thread-safe: Several threads sharing the same OrthancPluginPeers object can simultaneously call this function."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	636 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	637 "return": "The URL, or NULL in the case of an error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	638 "summary": "Get the base URL of an Orthanc peer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	639 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	640 "return_sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	641 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	642 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	643 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	644 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	645 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	646 "sdk_name": "peerIndex",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	647 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	648 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	649 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	650 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	651 "sdk_name": "userProperty",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	652 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	653 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	654 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	655 "c_function": "OrthancPluginGetPeerUserProperty",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	656 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	657 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	658 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	659 "peerIndex": "The index of the peer of interest. This value must be lower than OrthancPluginGetPeersCount().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	660 "userProperty": "The user property of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	661 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	662 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	663 "This function returns some user-defined property of some Orthanc peer. An user-defined property is a property that is associated with the peer in the Orthanc configuration file, but that is not recognized by the Orthanc core.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	664 "This function is thread-safe: Several threads sharing the same OrthancPluginPeers object can simultaneously call this function."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	665 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	666 "return": "The value of the user property, or NULL if it is not defined.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	667 "summary": "Get some user-defined property of an Orthanc peer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	668 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	669 "return_sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	670 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	671 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	672 "name": "OrthancPluginPeers"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	673 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	674 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	675 "methods": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	676 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	677 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	678 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	679 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	680 "sdk_name": "answer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	681 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	682 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	683 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	684 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	685 "sdk_name": "mimeType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	686 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	687 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	688 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	689 "c_function": "OrthancPluginAnswerBuffer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	690 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	691 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	692 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	693 "answer": "Pointer to the memory buffer containing the answer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	694 "answerSize": "Number of bytes of the answer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	695 "mimeType": "The MIME type of the answer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	696 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	697 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	698 "This function answers to a REST request with the content of a memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	699 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	700 "summary": "Answer to a REST request."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	701 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	702 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	703 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	704 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	705 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	706 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	707 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	708 "sdk_enumeration": "OrthancPluginPixelFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	709 "sdk_name": "format",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	710 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	711 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	712 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	713 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	714 "sdk_name": "width",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	715 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	716 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	717 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	718 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	719 "sdk_name": "height",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	720 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	721 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	722 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	723 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	724 "sdk_name": "pitch",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	725 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	726 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	727 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	728 "name": "arg4",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	729 "sdk_name": "buffer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	730 "sdk_type": "const void *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	731 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	732 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	733 "c_function": "OrthancPluginCompressAndAnswerPngImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	734 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	735 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	736 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	737 "buffer": "The memory buffer containing the uncompressed image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	738 "format": "The memory layout of the uncompressed image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	739 "height": "The height of the image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	740 "pitch": "The pitch of the image (i.e. the number of bytes between 2 successive lines of the image in the memory buffer).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	741 "width": "The width of the image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	742 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	743 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	744 "This function answers to a REST request with a PNG image. The parameters of this function describe a memory buffer that contains an uncompressed image. The image will be automatically compressed as a PNG image by the core system of Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	745 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	746 "summary": "Answer to a REST request with a PNG image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	747 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	748 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	749 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	750 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	751 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	752 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	753 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	754 "sdk_name": "redirection",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	755 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	756 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	757 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	758 "c_function": "OrthancPluginRedirect",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	759 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	760 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	761 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	762 "redirection": "Where to redirect."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	763 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	764 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	765 "This function answers to a REST request by redirecting the user to another URI using HTTP status 301."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	766 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	767 "summary": "Redirect a REST request."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	768 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	769 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	770 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	771 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	772 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	773 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	774 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	775 "sdk_name": "status",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	776 "sdk_type": "uint16_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	777 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	778 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	779 "c_function": "OrthancPluginSendHttpStatusCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	780 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	781 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	782 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	783 "status": "The HTTP status code to be sent."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	784 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	785 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	786 "This function answers to a REST request by sending a HTTP status code (such as \"400 - Bad Request\"). Note that: - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer(). - Redirections (status 301) must use ::OrthancPluginRedirect(). - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized(). - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	787 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	788 "summary": "Send a HTTP status code."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	789 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	790 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	791 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	792 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	793 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	794 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	795 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	796 "sdk_name": "realm",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	797 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	798 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	799 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	800 "c_function": "OrthancPluginSendUnauthorized",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	801 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	802 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	803 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	804 "realm": "The realm for the authorization process."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	805 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	806 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	807 "This function answers to a REST request by signaling that it is not authorized."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	808 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	809 "summary": "Signal that a REST request is not authorized."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	810 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	811 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	812 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	813 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	814 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	815 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	816 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	817 "sdk_name": "allowedMethods",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	818 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	819 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	820 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	821 "c_function": "OrthancPluginSendMethodNotAllowed",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	822 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	823 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	824 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	825 "allowedMethods": "The allowed methods for this URI (e.g. \"GET,POST\" after a PUT or a POST request)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	826 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	827 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	828 "This function answers to a REST request by signaling that the queried URI does not support this method."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	829 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	830 "summary": "Signal that this URI does not support this HTTP method."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	831 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	832 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	833 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	834 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	835 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	836 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	837 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	838 "sdk_name": "cookie",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	839 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	840 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	841 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	842 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	843 "sdk_name": "value",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	844 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	845 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	846 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	847 "c_function": "OrthancPluginSetCookie",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	848 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	849 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	850 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	851 "cookie": "The cookie to be set.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	852 "value": "The value of the cookie."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	853 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	854 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	855 "This function sets a cookie in the HTTP client."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	856 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	857 "summary": "Set a cookie."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	858 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	859 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	860 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	861 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	862 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	863 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	864 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	865 "sdk_name": "key",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	866 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	867 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	868 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	869 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	870 "sdk_name": "value",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	871 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	872 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	873 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	874 "c_function": "OrthancPluginSetHttpHeader",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	875 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	876 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	877 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	878 "key": "The HTTP header to be set.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	879 "value": "The value of the HTTP header."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	880 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	881 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	882 "This function sets a HTTP header in the HTTP answer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	883 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	884 "summary": "Set some HTTP header."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	885 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	886 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	887 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	888 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	889 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	890 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	891 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	892 "sdk_name": "subType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	893 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	894 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	895 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	896 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	897 "sdk_name": "contentType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	898 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	899 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	900 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	901 "c_function": "OrthancPluginStartMultipartAnswer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	902 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	903 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	904 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	905 "contentType": "The MIME type of the items in the multipart answer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	906 "subType": "The sub-type of the multipart answer (\"mixed\" or \"related\")."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	907 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	908 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	909 "Initiates a HTTP multipart answer, as the result of a REST request."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	910 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	911 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	912 "summary": "Start an HTTP multipart answer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	913 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	914 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	915 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	916 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	917 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	918 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	919 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	920 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	921 "sdk_name": "answer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	922 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	923 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	924 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	925 "c_function": "OrthancPluginSendMultipartItem",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	926 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	927 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	928 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	929 "answer": "Pointer to the memory buffer containing the item.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	930 "answerSize": "Number of bytes of the item."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	931 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	932 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	933 "This function sends an item as a part of some HTTP multipart answer that was initiated by OrthancPluginStartMultipartAnswer()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	934 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	935 "return": "0 if success, or the error code if failure (this notably happens if the connection is closed by the client).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	936 "summary": "Send an item as a part of some HTTP multipart answer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	937 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	938 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	939 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	940 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	941 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	942 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	943 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	944 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	945 "sdk_name": "status",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	946 "sdk_type": "uint16_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	947 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	948 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	949 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	950 "sdk_name": "body",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	951 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	952 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	953 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	954 "c_function": "OrthancPluginSendHttpStatus",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	955 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	956 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	957 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	958 "body": "The body of the answer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	959 "bodySize": "The size of the body.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	960 "status": "The HTTP status code to be sent."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	961 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	962 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	963 "This function answers to a HTTP request by sending a HTTP status code (such as \"400 - Bad Request\"), together with a body describing the error. The body will only be returned if the configuration option \"HttpDescribeErrors\" of Orthanc is set to \"true\".",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	964 "Note that: - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer(). - Redirections (status 301) must use ::OrthancPluginRedirect(). - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized(). - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	965 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	966 "summary": "Send a HTTP status, with a custom body."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	967 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	968 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	969 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	970 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	971 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	972 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	973 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	974 "sdk_enumeration": "OrthancPluginPixelFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	975 "sdk_name": "format",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	976 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	977 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	978 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	979 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	980 "sdk_name": "width",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	981 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	982 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	983 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	984 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	985 "sdk_name": "height",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	986 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	987 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	988 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	989 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	990 "sdk_name": "pitch",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	991 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	992 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	993 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	994 "name": "arg4",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	995 "sdk_name": "buffer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	996 "sdk_type": "const void *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	997 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	998 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	999 "name": "arg5",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1000 "sdk_name": "quality",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1001 "sdk_type": "uint8_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1002 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1003 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1004 "c_function": "OrthancPluginCompressAndAnswerJpegImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1005 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1006 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1007 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1008 "buffer": "The memory buffer containing the uncompressed image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1009 "format": "The memory layout of the uncompressed image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1010 "height": "The height of the image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1011 "pitch": "The pitch of the image (i.e. the number of bytes between 2 successive lines of the image in the memory buffer).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1012 "quality": "The quality of the JPEG encoding, between 1 (worst quality, best compression) and 100 (best quality, worst compression).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1013 "width": "The width of the image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1014 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1015 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1016 "This function answers to a REST request with a JPEG image. The parameters of this function describe a memory buffer that contains an uncompressed image. The image will be automatically compressed as a JPEG image by the core system of Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1017 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1018 "summary": "Answer to a REST request with a JPEG image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1019 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1020 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1021 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1022 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1023 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1024 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1025 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1026 "sdk_name": "details",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1027 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1028 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1029 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1030 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1031 "sdk_name": "log",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1032 "sdk_type": "uint8_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1033 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1034 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1035 "c_function": "OrthancPluginSetHttpErrorDetails",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1036 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1037 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1038 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1039 "details": "The details of the error message.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1040 "log": "Whether to also write the detailed error to the Orthanc logs."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1041 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1042 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1043 "This function sets the detailed description associated with an HTTP error. This description will be displayed in the \"Details\" field of the JSON body of the HTTP answer. It is only taken into consideration if the REST callback returns an error code that is different from \"OrthancPluginErrorCode_Success\", and if the \"HttpDescribeErrors\" configuration option of Orthanc is set to \"true\"."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1044 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1045 "summary": "Provide a detailed description for an HTTP error."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1046 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1047 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1048 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1049 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1050 "name": "OrthancPluginRestOutput"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1051 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1052 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1053 "methods": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1054 "name": "OrthancPluginServerChunkedRequestReader"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1055 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1056 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1057 "methods": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1058 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1059 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1060 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1061 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1062 "sdk_name": "uuid",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1063 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1064 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1065 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1066 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1067 "sdk_name": "content",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1068 "sdk_type": "const void *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1069 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1070 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1071 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1072 "sdk_name": "size",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1073 "sdk_type": "uint64_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1074 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1075 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1076 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1077 "sdk_enumeration": "OrthancPluginContentType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1078 "sdk_name": "type",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1079 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1080 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1081 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1082 "c_function": "OrthancPluginStorageAreaCreate",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1083 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1084 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1085 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1086 "content": "The content to store in the newly created file.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1087 "size": "The size of the content.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1088 "type": "The type of the file content.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1089 "uuid": "The identifier of the file to be created."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1090 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1091 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1092 "This function creates a new file inside the storage area that is currently used by Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1093 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1094 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1095 "summary": "Create a file inside the storage area."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1096 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1097 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1098 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1099 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1100 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1101 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1102 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1103 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1104 "sdk_name": "uuid",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1105 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1106 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1107 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1108 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1109 "sdk_enumeration": "OrthancPluginContentType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1110 "sdk_name": "type",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1111 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1112 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1113 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1114 "c_function": "OrthancPluginStorageAreaRead",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1115 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1116 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1117 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1118 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1119 "type": "The type of the file content.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1120 "uuid": "The identifier of the file to be read."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1121 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1122 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1123 "This function reads the content of a given file from the storage area that is currently used by Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1124 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1125 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1126 "summary": "Read a file from the storage area."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1127 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1128 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1129 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1130 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1131 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1132 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1133 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1134 "sdk_name": "uuid",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1135 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1136 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1137 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1138 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1139 "sdk_enumeration": "OrthancPluginContentType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1140 "sdk_name": "type",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1141 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1142 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1143 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1144 "c_function": "OrthancPluginStorageAreaRemove",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1145 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1146 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1147 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1148 "type": "The type of the file content.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1149 "uuid": "The identifier of the file to be removed."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1150 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1151 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1152 "This function removes a given file from the storage area that is currently used by Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1153 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1154 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1155 "summary": "Remove a file from the storage area."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1156 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1157 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1158 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1159 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1160 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1161 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1162 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1163 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1164 "sdk_enumeration": "OrthancPluginResourceType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1165 "sdk_name": "level",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1166 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1167 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1168 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1169 "c_function": "OrthancPluginReconstructMainDicomTags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1170 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1171 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1172 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1173 "level": "The type of the resources of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1174 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1175 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1176 "This function requests the Orthanc core to reconstruct the main DICOM tags of all the resources of the given type. This function can only be used as a part of the upgrade of a custom database back-end. A database transaction will be automatically setup."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1177 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1178 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1179 "summary": "Reconstruct the main DICOM tags."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1180 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1181 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1182 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1183 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1184 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1185 "name": "OrthancPluginStorageArea"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1186 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1187 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1188 "methods": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1189 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1190 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1191 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1192 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1193 "sdk_class": "OrthancPluginWorklistQuery",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1194 "sdk_name": "query",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1195 "sdk_type": "const_object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1196 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1197 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1198 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1199 "sdk_name": "dicom",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1200 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1201 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1202 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1203 "c_function": "OrthancPluginWorklistAddAnswer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1204 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1205 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1206 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1207 "dicom": "The worklist to answer, encoded as a DICOM file.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1208 "query": "The worklist query, as received by the callback.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1209 "size": "The size of the DICOM file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1210 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1211 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1212 "This function adds one worklist (encoded as a DICOM file) to the set of answers corresponding to some C-Find SCP request against modality worklists."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1213 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1214 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1215 "summary": "Add one answer to some modality worklist request."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1216 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1217 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1218 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1219 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1220 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1221 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1222 "c_function": "OrthancPluginWorklistMarkIncomplete",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1223 "const": false,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1224 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1225 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1226 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1227 "This function marks as incomplete the set of answers corresponding to some C-Find SCP request against modality worklists. This must be used if canceling the handling of a request when too many answers are to be returned."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1228 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1229 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1230 "summary": "Mark the set of worklist answers as incomplete."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1231 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1232 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1233 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1234 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1235 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1236 "name": "OrthancPluginWorklistAnswers"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1237 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1238 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1239 "methods": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1240 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1241 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1242 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1243 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1244 "sdk_name": "dicom",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1245 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1246 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1247 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1248 "c_function": "OrthancPluginWorklistIsMatch",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1249 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1250 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1251 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1252 "dicom": "The worklist to answer, encoded as a DICOM file.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1253 "size": "The size of the DICOM file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1254 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1255 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1256 "This function checks whether one worklist (encoded as a DICOM file) matches the C-Find SCP query against modality worklists. This function must be called before adding the worklist as an answer through OrthancPluginWorklistAddAnswer()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1257 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1258 "return": "1 if the worklist matches the query, 0 otherwise.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1259 "summary": "Test whether a worklist matches the query."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1260 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1261 "return_sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1262 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1263 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1264 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1265 "c_function": "OrthancPluginWorklistGetDicomQuery",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1266 "const": true,
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1267 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1268 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1269 "target": "Memory buffer where to store the DICOM file. It must be freed with OrthancPluginFreeMemoryBuffer()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1270 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1271 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1272 "This function retrieves the DICOM file that underlies a C-Find SCP query against modality worklists."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1273 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1274 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1275 "summary": "Retrieve the worklist query as a DICOM file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1276 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1277 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1278 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1279 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1280 "name": "OrthancPluginWorklistQuery"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1281 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1282 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1283 "enumerations": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1284 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1285 "documentation": "The supported types of changes that can be signaled to the change callback.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1286 "name": "OrthancPluginChangeType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1287 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1288 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1289 "documentation": "Series is now complete",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1290 "key": "CompletedSeries",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1291 "value": 0
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1292 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1293 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1294 "documentation": "Deleted resource",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1295 "key": "Deleted",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1296 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1297 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1298 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1299 "documentation": "A new instance was added to this resource",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1300 "key": "NewChildInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1301 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1302 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1303 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1304 "documentation": "New instance received",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1305 "key": "NewInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1306 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1307 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1308 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1309 "documentation": "New patient created",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1310 "key": "NewPatient",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1311 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1312 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1313 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1314 "documentation": "New series created",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1315 "key": "NewSeries",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1316 "value": 5
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1317 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1318 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1319 "documentation": "New study created",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1320 "key": "NewStudy",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1321 "value": 6
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1322 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1323 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1324 "documentation": "Timeout: No new instance in this patient",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1325 "key": "StablePatient",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1326 "value": 7
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1327 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1328 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1329 "documentation": "Timeout: No new instance in this series",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1330 "key": "StableSeries",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1331 "value": 8
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1332 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1333 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1334 "documentation": "Timeout: No new instance in this study",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1335 "key": "StableStudy",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1336 "value": 9
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1337 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1338 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1339 "documentation": "Orthanc has started",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1340 "key": "OrthancStarted",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1341 "value": 10
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1342 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1343 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1344 "documentation": "Orthanc is stopping",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1345 "key": "OrthancStopped",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1346 "value": 11
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1347 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1348 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1349 "documentation": "Some user-defined attachment has changed for this resource",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1350 "key": "UpdatedAttachment",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1351 "value": 12
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1352 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1353 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1354 "documentation": "Some user-defined metadata has changed for this resource",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1355 "key": "UpdatedMetadata",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1356 "value": 13
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1357 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1358 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1359 "documentation": "The list of Orthanc peers has changed",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1360 "key": "UpdatedPeers",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1361 "value": 14
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1362 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1363 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1364 "documentation": "The list of DICOM modalities has changed",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1365 "key": "UpdatedModalities",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1366 "value": 15
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1367 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1368 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1369 "documentation": "New Job submitted",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1370 "key": "JobSubmitted",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1371 "value": 16
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1372 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1373 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1374 "documentation": "A Job has completed successfully",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1375 "key": "JobSuccess",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1376 "value": 17
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1377 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1378 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1379 "documentation": "A Job has failed",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1380 "key": "JobFailure",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1381 "value": 18
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1382 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1383 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1384 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1385 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1386 "documentation": "The compression algorithms that are supported by the Orthanc core.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1387 "name": "OrthancPluginCompressionType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1388 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1389 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1390 "documentation": "Standard zlib compression",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1391 "key": "Zlib",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1392 "value": 0
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1393 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1394 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1395 "documentation": "zlib, prefixed with uncompressed size (uint64_t)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1396 "key": "ZlibWithSize",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1397 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1398 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1399 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1400 "documentation": "Standard gzip compression",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1401 "key": "Gzip",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1402 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1403 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1404 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1405 "documentation": "gzip, prefixed with uncompressed size (uint64_t)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1406 "key": "GzipWithSize",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1407 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1408 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1409 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1410 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1411 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1412 "documentation": "The constraints on the tags (main DICOM tags and identifier tags) that must be supported by the database plugins.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1413 "name": "OrthancPluginConstraintType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1414 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1415 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1416 "documentation": "Equal",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1417 "key": "Equal",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1418 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1419 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1420 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1421 "documentation": "Less or equal",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1422 "key": "SmallerOrEqual",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1423 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1424 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1425 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1426 "documentation": "More or equal",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1427 "key": "GreaterOrEqual",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1428 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1429 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1430 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1431 "documentation": "Wildcard matching",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1432 "key": "Wildcard",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1433 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1434 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1435 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1436 "documentation": "List of values",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1437 "key": "List",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1438 "value": 5
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1439 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1440 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1441 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1442 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1443 "documentation": "The content types that are supported by Orthanc plugins.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1444 "name": "OrthancPluginContentType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1445 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1446 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1447 "documentation": "Unknown content type",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1448 "key": "Unknown",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1449 "value": 0
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1450 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1451 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1452 "documentation": "DICOM",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1453 "key": "Dicom",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1454 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1455 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1456 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1457 "documentation": "JSON summary of a DICOM file",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1458 "key": "DicomAsJson",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1459 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1460 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1461 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1462 "documentation": "DICOM Header till pixel data",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1463 "key": "DicomUntilPixelData",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1464 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1465 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1466 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1467 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1468 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1469 "documentation": "Flags to the creation of a DICOM file.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1470 "name": "OrthancPluginCreateDicomFlags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1471 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1472 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1473 "documentation": "Default mode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1474 "key": "None",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1475 "value": 0
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1476 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1477 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1478 "documentation": "Decode fields encoded using data URI scheme",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1479 "key": "DecodeDataUriScheme",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1480 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1481 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1482 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1483 "documentation": "Automatically generate DICOM identifiers",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1484 "key": "GenerateIdentifiers",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1485 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1486 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1487 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1488 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1489 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1490 "documentation": "Flags to customize a DICOM-to-JSON conversion. By default, binary tags are formatted using Data URI scheme.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1491 "name": "OrthancPluginDicomToJsonFlags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1492 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1493 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1494 "documentation": "Default formatting",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1495 "key": "None",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1496 "value": 0
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1497 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1498 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1499 "documentation": "Include the binary tags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1500 "key": "IncludeBinary",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1501 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1502 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1503 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1504 "documentation": "Include the private tags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1505 "key": "IncludePrivateTags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1506 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1507 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1508 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1509 "documentation": "Include the tags unknown by the dictionary",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1510 "key": "IncludeUnknownTags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1511 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1512 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1513 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1514 "documentation": "Include the pixel data",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1515 "key": "IncludePixelData",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1516 "value": 8
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1517 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1518 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1519 "documentation": "Output binary tags as-is, dropping non-ASCII",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1520 "key": "ConvertBinaryToAscii",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1521 "value": 16
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1522 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1523 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1524 "documentation": "Signal binary tags as null values",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1525 "key": "ConvertBinaryToNull",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1526 "value": 32
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1527 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1528 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1529 "documentation": "Stop processing after pixel data (new in 1.9.1)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1530 "key": "StopAfterPixelData",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1531 "value": 64
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1532 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1533 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1534 "documentation": "Skip tags whose element is zero (new in 1.9.1)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1535 "key": "SkipGroupLengths",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1536 "value": 128
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1537 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1538 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1539 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1540 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1541 "documentation": "The possible output formats for a DICOM-to-JSON conversion.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1542 "name": "OrthancPluginDicomToJsonFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1543 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1544 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1545 "documentation": "Full output, with most details",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1546 "key": "Full",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1547 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1548 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1549 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1550 "documentation": "Tags output as hexadecimal numbers",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1551 "key": "Short",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1552 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1553 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1554 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1555 "documentation": "Human-readable JSON",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1556 "key": "Human",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1557 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1558 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1559 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1560 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1561 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1562 "documentation": "The available modes to export a binary DICOM tag into a DICOMweb JSON or XML document.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1563 "name": "OrthancPluginDicomWebBinaryMode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1564 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1565 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1566 "documentation": "Don't include binary tags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1567 "key": "Ignore",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1568 "value": 0
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1569 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1570 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1571 "documentation": "Inline encoding using Base64",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1572 "key": "InlineBinary",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1573 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1574 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1575 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1576 "documentation": "Use a bulk data URI field",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1577 "key": "BulkDataUri",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1578 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1579 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1580 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1581 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1582 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1583 "documentation": "The various error codes that can be returned by the Orthanc core.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1584 "name": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1585 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1586 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1587 "documentation": "Internal error",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1588 "key": "InternalError",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1589 "value": -1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1590 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1591 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1592 "documentation": "Success",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1593 "key": "Success",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1594 "value": 0
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1595 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1596 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1597 "documentation": "Error encountered within the plugin engine",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1598 "key": "Plugin",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1599 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1600 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1601 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1602 "documentation": "Not implemented yet",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1603 "key": "NotImplemented",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1604 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1605 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1606 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1607 "documentation": "Parameter out of range",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1608 "key": "ParameterOutOfRange",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1609 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1610 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1611 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1612 "documentation": "The server hosting Orthanc is running out of memory",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1613 "key": "NotEnoughMemory",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1614 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1615 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1616 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1617 "documentation": "Bad type for a parameter",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1618 "key": "BadParameterType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1619 "value": 5
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1620 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1621 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1622 "documentation": "Bad sequence of calls",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1623 "key": "BadSequenceOfCalls",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1624 "value": 6
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1625 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1626 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1627 "documentation": "Accessing an inexistent item",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1628 "key": "InexistentItem",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1629 "value": 7
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1630 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1631 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1632 "documentation": "Bad request",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1633 "key": "BadRequest",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1634 "value": 8
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1635 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1636 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1637 "documentation": "Error in the network protocol",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1638 "key": "NetworkProtocol",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1639 "value": 9
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1640 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1641 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1642 "documentation": "Error while calling a system command",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1643 "key": "SystemCommand",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1644 "value": 10
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1645 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1646 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1647 "documentation": "Error with the database engine",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1648 "key": "Database",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1649 "value": 11
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1650 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1651 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1652 "documentation": "Badly formatted URI",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1653 "key": "UriSyntax",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1654 "value": 12
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1655 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1656 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1657 "documentation": "Inexistent file",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1658 "key": "InexistentFile",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1659 "value": 13
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1660 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1661 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1662 "documentation": "Cannot write to file",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1663 "key": "CannotWriteFile",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1664 "value": 14
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1665 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1666 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1667 "documentation": "Bad file format",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1668 "key": "BadFileFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1669 "value": 15
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1670 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1671 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1672 "documentation": "Timeout",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1673 "key": "Timeout",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1674 "value": 16
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1675 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1676 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1677 "documentation": "Unknown resource",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1678 "key": "UnknownResource",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1679 "value": 17
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1680 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1681 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1682 "documentation": "Incompatible version of the database",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1683 "key": "IncompatibleDatabaseVersion",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1684 "value": 18
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1685 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1686 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1687 "documentation": "The file storage is full",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1688 "key": "FullStorage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1689 "value": 19
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1690 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1691 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1692 "documentation": "Corrupted file (e.g. inconsistent MD5 hash)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1693 "key": "CorruptedFile",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1694 "value": 20
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1695 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1696 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1697 "documentation": "Inexistent tag",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1698 "key": "InexistentTag",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1699 "value": 21
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1700 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1701 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1702 "documentation": "Cannot modify a read-only data structure",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1703 "key": "ReadOnly",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1704 "value": 22
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1705 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1706 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1707 "documentation": "Incompatible format of the images",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1708 "key": "IncompatibleImageFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1709 "value": 23
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1710 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1711 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1712 "documentation": "Incompatible size of the images",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1713 "key": "IncompatibleImageSize",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1714 "value": 24
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1715 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1716 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1717 "documentation": "Error while using a shared library (plugin)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1718 "key": "SharedLibrary",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1719 "value": 25
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1720 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1721 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1722 "documentation": "Plugin invoking an unknown service",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1723 "key": "UnknownPluginService",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1724 "value": 26
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1725 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1726 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1727 "documentation": "Unknown DICOM tag",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1728 "key": "UnknownDicomTag",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1729 "value": 27
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1730 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1731 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1732 "documentation": "Cannot parse a JSON document",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1733 "key": "BadJson",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1734 "value": 28
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1735 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1736 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1737 "documentation": "Bad credentials were provided to an HTTP request",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1738 "key": "Unauthorized",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1739 "value": 29
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1740 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1741 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1742 "documentation": "Badly formatted font file",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1743 "key": "BadFont",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1744 "value": 30
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1745 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1746 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1747 "documentation": "The plugin implementing a custom database back-end does not fulfill the proper interface",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1748 "key": "DatabasePlugin",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1749 "value": 31
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1750 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1751 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1752 "documentation": "Error in the plugin implementing a custom storage area",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1753 "key": "StorageAreaPlugin",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1754 "value": 32
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1755 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1756 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1757 "documentation": "The request is empty",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1758 "key": "EmptyRequest",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1759 "value": 33
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1760 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1761 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1762 "documentation": "Cannot send a response which is acceptable according to the Accept HTTP header",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1763 "key": "NotAcceptable",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1764 "value": 34
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1765 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1766 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1767 "documentation": "Cannot handle a NULL pointer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1768 "key": "NullPointer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1769 "value": 35
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1770 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1771 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1772 "documentation": "The database is currently not available (probably a transient situation)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1773 "key": "DatabaseUnavailable",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1774 "value": 36
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1775 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1776 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1777 "documentation": "This job was canceled",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1778 "key": "CanceledJob",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1779 "value": 37
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1780 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1781 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1782 "documentation": "Geometry error encountered in Stone",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1783 "key": "BadGeometry",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1784 "value": 38
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1785 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1786 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1787 "documentation": "Cannot initialize SSL encryption, check out your certificates",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1788 "key": "SslInitialization",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1789 "value": 39
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1790 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1791 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1792 "documentation": "Calling a function that has been removed from the Orthanc Framework",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1793 "key": "DiscontinuedAbi",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1794 "value": 40
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1795 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1796 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1797 "documentation": "Incorrect range request",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1798 "key": "BadRange",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1799 "value": 41
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1800 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1801 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1802 "documentation": "Database could not serialize access due to concurrent update, the transaction should be retried",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1803 "key": "DatabaseCannotSerialize",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1804 "value": 42
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1805 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1806 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1807 "documentation": "A bad revision number was provided, which might indicate conflict between multiple writers",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1808 "key": "Revision",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1809 "value": 43
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1810 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1811 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1812 "documentation": "SQLite: The database is not opened",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1813 "key": "SQLiteNotOpened",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1814 "value": 1000
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1815 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1816 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1817 "documentation": "SQLite: Connection is already open",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1818 "key": "SQLiteAlreadyOpened",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1819 "value": 1001
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1820 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1821 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1822 "documentation": "SQLite: Unable to open the database",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1823 "key": "SQLiteCannotOpen",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1824 "value": 1002
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1825 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1826 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1827 "documentation": "SQLite: This cached statement is already being referred to",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1828 "key": "SQLiteStatementAlreadyUsed",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1829 "value": 1003
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1830 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1831 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1832 "documentation": "SQLite: Cannot execute a command",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1833 "key": "SQLiteExecute",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1834 "value": 1004
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1835 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1836 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1837 "documentation": "SQLite: Rolling back a nonexistent transaction (have you called Begin()?)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1838 "key": "SQLiteRollbackWithoutTransaction",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1839 "value": 1005
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1840 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1841 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1842 "documentation": "SQLite: Committing a nonexistent transaction",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1843 "key": "SQLiteCommitWithoutTransaction",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1844 "value": 1006
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1845 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1846 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1847 "documentation": "SQLite: Unable to register a function",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1848 "key": "SQLiteRegisterFunction",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1849 "value": 1007
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1850 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1851 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1852 "documentation": "SQLite: Unable to flush the database",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1853 "key": "SQLiteFlush",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1854 "value": 1008
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1855 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1856 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1857 "documentation": "SQLite: Cannot run a cached statement",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1858 "key": "SQLiteCannotRun",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1859 "value": 1009
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1860 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1861 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1862 "documentation": "SQLite: Cannot step over a cached statement",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1863 "key": "SQLiteCannotStep",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1864 "value": 1010
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1865 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1866 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1867 "documentation": "SQLite: Bing a value while out of range (serious error)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1868 "key": "SQLiteBindOutOfRange",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1869 "value": 1011
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1870 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1871 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1872 "documentation": "SQLite: Cannot prepare a cached statement",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1873 "key": "SQLitePrepareStatement",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1874 "value": 1012
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1875 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1876 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1877 "documentation": "SQLite: Beginning the same transaction twice",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1878 "key": "SQLiteTransactionAlreadyStarted",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1879 "value": 1013
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1880 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1881 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1882 "documentation": "SQLite: Failure when committing the transaction",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1883 "key": "SQLiteTransactionCommit",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1884 "value": 1014
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1885 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1886 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1887 "documentation": "SQLite: Cannot start a transaction",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1888 "key": "SQLiteTransactionBegin",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1889 "value": 1015
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1890 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1891 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1892 "documentation": "The directory to be created is already occupied by a regular file",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1893 "key": "DirectoryOverFile",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1894 "value": 2000
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1895 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1896 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1897 "documentation": "Unable to create a subdirectory or a file in the file storage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1898 "key": "FileStorageCannotWrite",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1899 "value": 2001
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1900 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1901 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1902 "documentation": "The specified path does not point to a directory",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1903 "key": "DirectoryExpected",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1904 "value": 2002
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1905 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1906 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1907 "documentation": "The TCP port of the HTTP server is privileged or already in use",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1908 "key": "HttpPortInUse",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1909 "value": 2003
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1910 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1911 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1912 "documentation": "The TCP port of the DICOM server is privileged or already in use",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1913 "key": "DicomPortInUse",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1914 "value": 2004
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1915 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1916 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1917 "documentation": "This HTTP status is not allowed in a REST API",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1918 "key": "BadHttpStatusInRest",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1919 "value": 2005
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1920 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1921 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1922 "documentation": "The specified path does not point to a regular file",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1923 "key": "RegularFileExpected",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1924 "value": 2006
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1925 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1926 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1927 "documentation": "Unable to get the path to the executable",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1928 "key": "PathToExecutable",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1929 "value": 2007
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1930 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1931 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1932 "documentation": "Cannot create a directory",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1933 "key": "MakeDirectory",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1934 "value": 2008
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1935 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1936 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1937 "documentation": "An application entity title (AET) cannot be empty or be longer than 16 characters",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1938 "key": "BadApplicationEntityTitle",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1939 "value": 2009
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1940 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1941 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1942 "documentation": "No request handler factory for DICOM C-FIND SCP",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1943 "key": "NoCFindHandler",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1944 "value": 2010
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1945 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1946 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1947 "documentation": "No request handler factory for DICOM C-MOVE SCP",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1948 "key": "NoCMoveHandler",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1949 "value": 2011
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1950 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1951 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1952 "documentation": "No request handler factory for DICOM C-STORE SCP",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1953 "key": "NoCStoreHandler",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1954 "value": 2012
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1955 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1956 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1957 "documentation": "No application entity filter",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1958 "key": "NoApplicationEntityFilter",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1959 "value": 2013
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1960 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1961 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1962 "documentation": "DicomUserConnection: Unable to find the SOP class and instance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1963 "key": "NoSopClassOrInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1964 "value": 2014
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1965 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1966 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1967 "documentation": "DicomUserConnection: No acceptable presentation context for modality",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1968 "key": "NoPresentationContext",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1969 "value": 2015
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1970 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1971 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1972 "documentation": "DicomUserConnection: The C-FIND command is not supported by the remote SCP",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1973 "key": "DicomFindUnavailable",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1974 "value": 2016
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1975 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1976 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1977 "documentation": "DicomUserConnection: The C-MOVE command is not supported by the remote SCP",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1978 "key": "DicomMoveUnavailable",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1979 "value": 2017
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1980 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1981 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1982 "documentation": "Cannot store an instance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1983 "key": "CannotStoreInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1984 "value": 2018
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1985 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1986 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1987 "documentation": "Only string values are supported when creating DICOM instances",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1988 "key": "CreateDicomNotString",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1989 "value": 2019
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1990 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1991 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1992 "documentation": "Trying to override a value inherited from a parent module",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1993 "key": "CreateDicomOverrideTag",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1994 "value": 2020
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1995 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1996 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1997 "documentation": "Use \\\"Content\\\" to inject an image into a new DICOM instance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1998 "key": "CreateDicomUseContent",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1999 "value": 2021
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2000 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2001 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2002 "documentation": "No payload is present for one instance in the series",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2003 "key": "CreateDicomNoPayload",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2004 "value": 2022
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2005 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2006 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2007 "documentation": "The payload of the DICOM instance must be specified according to Data URI scheme",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2008 "key": "CreateDicomUseDataUriScheme",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2009 "value": 2023
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2010 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2011 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2012 "documentation": "Trying to attach a new DICOM instance to an inexistent resource",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2013 "key": "CreateDicomBadParent",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2014 "value": 2024
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2015 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2016 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2017 "documentation": "Trying to attach a new DICOM instance to an instance (must be a series, study or patient)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2018 "key": "CreateDicomParentIsInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2019 "value": 2025
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2020 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2021 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2022 "documentation": "Unable to get the encoding of the parent resource",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2023 "key": "CreateDicomParentEncoding",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2024 "value": 2026
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2025 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2026 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2027 "documentation": "Unknown modality",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2028 "key": "UnknownModality",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2029 "value": 2027
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2030 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2031 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2032 "documentation": "Bad ordering of filters in a job",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2033 "key": "BadJobOrdering",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2034 "value": 2028
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2035 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2036 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2037 "documentation": "Cannot convert the given JSON object to a Lua table",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2038 "key": "JsonToLuaTable",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2039 "value": 2029
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2040 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2041 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2042 "documentation": "Cannot create the Lua context",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2043 "key": "CannotCreateLua",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2044 "value": 2030
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2045 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2046 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2047 "documentation": "Cannot execute a Lua command",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2048 "key": "CannotExecuteLua",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2049 "value": 2031
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2050 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2051 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2052 "documentation": "Arguments cannot be pushed after the Lua function is executed",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2053 "key": "LuaAlreadyExecuted",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2054 "value": 2032
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2055 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2056 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2057 "documentation": "The Lua function does not give the expected number of outputs",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2058 "key": "LuaBadOutput",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2059 "value": 2033
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2060 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2061 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2062 "documentation": "The Lua function is not a predicate (only true/false outputs allowed)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2063 "key": "NotLuaPredicate",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2064 "value": 2034
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2065 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2066 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2067 "documentation": "The Lua function does not return a string",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2068 "key": "LuaReturnsNoString",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2069 "value": 2035
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2070 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2071 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2072 "documentation": "Another plugin has already registered a custom storage area",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2073 "key": "StorageAreaAlreadyRegistered",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2074 "value": 2036
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2075 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2076 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2077 "documentation": "Another plugin has already registered a custom database back-end",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2078 "key": "DatabaseBackendAlreadyRegistered",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2079 "value": 2037
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2080 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2081 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2082 "documentation": "Plugin trying to call the database during its initialization",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2083 "key": "DatabaseNotInitialized",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2084 "value": 2038
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2085 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2086 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2087 "documentation": "Orthanc has been built without SSL support",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2088 "key": "SslDisabled",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2089 "value": 2039
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2090 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2091 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2092 "documentation": "Unable to order the slices of the series",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2093 "key": "CannotOrderSlices",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2094 "value": 2040
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2095 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2096 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2097 "documentation": "No request handler factory for DICOM C-Find Modality SCP",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2098 "key": "NoWorklistHandler",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2099 "value": 2041
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2100 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2101 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2102 "documentation": "Cannot override the value of a tag that already exists",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2103 "key": "AlreadyExistingTag",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2104 "value": 2042
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2105 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2106 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2107 "documentation": "No request handler factory for DICOM N-ACTION SCP (storage commitment)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2108 "key": "NoStorageCommitmentHandler",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2109 "value": 2043
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2110 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2111 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2112 "documentation": "No request handler factory for DICOM C-GET SCP",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2113 "key": "NoCGetHandler",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2114 "value": 2044
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2115 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2116 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2117 "documentation": "Unsupported media type",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2118 "key": "UnsupportedMediaType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2119 "value": 3000
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2120 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2121 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2122 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2123 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2124 "documentation": "The various HTTP methods for a REST call.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2125 "name": "OrthancPluginHttpMethod",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2126 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2127 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2128 "documentation": "GET request",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2129 "key": "Get",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2130 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2131 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2132 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2133 "documentation": "POST request",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2134 "key": "Post",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2135 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2136 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2137 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2138 "documentation": "PUT request",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2139 "key": "Put",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2140 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2141 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2142 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2143 "documentation": "DELETE request",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2144 "key": "Delete",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2145 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2146 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2147 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2148 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2149 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2150 "documentation": "The constraints on the DICOM identifiers that must be supported by the database plugins.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2151 "name": "OrthancPluginIdentifierConstraint",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2152 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2153 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2154 "documentation": "Equal",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2155 "key": "Equal",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2156 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2157 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2158 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2159 "documentation": "Less or equal",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2160 "key": "SmallerOrEqual",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2161 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2162 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2163 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2164 "documentation": "More or equal",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2165 "key": "GreaterOrEqual",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2166 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2167 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2168 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2169 "documentation": "Case-sensitive wildcard matching (with * and ?)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2170 "key": "Wildcard",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2171 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2172 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2173 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2174 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2175 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2176 "documentation": "The image formats that are supported by the Orthanc core.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2177 "name": "OrthancPluginImageFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2178 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2179 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2180 "documentation": "Image compressed using PNG",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2181 "key": "Png",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2182 "value": 0
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2183 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2184 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2185 "documentation": "Image compressed using JPEG",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2186 "key": "Jpeg",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2187 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2188 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2189 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2190 "documentation": "Image compressed using DICOM",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2191 "key": "Dicom",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2192 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2193 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2194 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2195 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2196 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2197 "documentation": "The origin of a DICOM instance that has been received by Orthanc.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2198 "name": "OrthancPluginInstanceOrigin",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2199 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2200 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2201 "documentation": "Unknown origin",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2202 "key": "Unknown",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2203 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2204 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2205 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2206 "documentation": "Instance received through DICOM protocol",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2207 "key": "DicomProtocol",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2208 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2209 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2210 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2211 "documentation": "Instance received through REST API of Orthanc",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2212 "key": "RestApi",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2213 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2214 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2215 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2216 "documentation": "Instance added to Orthanc by a plugin",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2217 "key": "Plugin",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2218 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2219 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2220 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2221 "documentation": "Instance added to Orthanc by a Lua script",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2222 "key": "Lua",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2223 "value": 5
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2224 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2225 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2226 "documentation": "Instance received through WebDAV (new in 1.8.0)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2227 "key": "WebDav",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2228 "value": 6
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2229 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2230 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2231 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2232 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2233 "documentation": "The possible status for one single step of a job.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2234 "name": "OrthancPluginJobStepStatus",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2235 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2236 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2237 "documentation": "The job has successfully executed all its steps",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2238 "key": "Success",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2239 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2240 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2241 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2242 "documentation": "The job has failed while executing this step",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2243 "key": "Failure",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2244 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2245 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2246 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2247 "documentation": "The job has still data to process after this step",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2248 "key": "Continue",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2249 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2250 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2251 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2252 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2253 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2254 "documentation": "Explains why the job should stop and release the resources it has allocated. This is especially important to disambiguate between the \"paused\" condition and the \"final\" conditions (success, failure, or canceled).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2255 "name": "OrthancPluginJobStopReason",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2256 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2257 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2258 "documentation": "The job has succeeded",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2259 "key": "Success",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2260 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2261 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2262 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2263 "documentation": "The job was paused, and will be resumed later",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2264 "key": "Paused",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2265 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2266 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2267 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2268 "documentation": "The job has failed, and might be resubmitted later",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2269 "key": "Failure",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2270 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2271 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2272 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2273 "documentation": "The job was canceled, and might be resubmitted later",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2274 "key": "Canceled",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2275 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2276 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2277 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2278 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2279 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2280 "documentation": "The available types of metrics.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2281 "name": "OrthancPluginMetricsType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2282 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2283 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2284 "documentation": "Default metrics",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2285 "key": "Default",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2286 "value": 0
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2287 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2288 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2289 "documentation": "This metrics represents a time duration. Orthanc will keep the maximum value of the metrics over a sliding window of ten seconds, which is useful if the metrics is sampled frequently.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2290 "key": "Timer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2291 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2292 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2293 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2294 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2295 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2296 "documentation": "The memory layout of the pixels of an image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2297 "name": "OrthancPluginPixelFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2298 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2299 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2300 "documentation": "Graylevel 8bpp image. The image is graylevel. Each pixel is unsigned and stored in one byte.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2301 "key": "Grayscale8",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2302 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2303 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2304 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2305 "documentation": "Graylevel, unsigned 16bpp image. The image is graylevel. Each pixel is unsigned and stored in two bytes.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2306 "key": "Grayscale16",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2307 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2308 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2309 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2310 "documentation": "Graylevel, signed 16bpp image. The image is graylevel. Each pixel is signed and stored in two bytes.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2311 "key": "SignedGrayscale16",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2312 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2313 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2314 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2315 "documentation": "Color image in RGB24 format. This format describes a color image. The pixels are stored in 3 consecutive bytes. The memory layout is RGB.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2316 "key": "RGB24",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2317 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2318 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2319 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2320 "documentation": "Color image in RGBA32 format. This format describes a color image. The pixels are stored in 4 consecutive bytes. The memory layout is RGBA.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2321 "key": "RGBA32",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2322 "value": 5
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2323 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2324 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2325 "documentation": "Unknown pixel format",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2326 "key": "Unknown",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2327 "value": 6
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2328 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2329 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2330 "documentation": "Color image in RGB48 format. This format describes a color image. The pixels are stored in 6 consecutive bytes. The memory layout is RRGGBB.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2331 "key": "RGB48",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2332 "value": 7
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2333 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2334 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2335 "documentation": "Graylevel, unsigned 32bpp image. The image is graylevel. Each pixel is unsigned and stored in four bytes.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2336 "key": "Grayscale32",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2337 "value": 8
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2338 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2339 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2340 "documentation": "Graylevel, floating-point 32bpp image. The image is graylevel. Each pixel is floating-point and stored in four bytes.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2341 "key": "Float32",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2342 "value": 9
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2343 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2344 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2345 "documentation": "Color image in BGRA32 format. This format describes a color image. The pixels are stored in 4 consecutive bytes. The memory layout is BGRA.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2346 "key": "BGRA32",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2347 "value": 10
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2348 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2349 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2350 "documentation": "Graylevel, unsigned 64bpp image. The image is graylevel. Each pixel is unsigned and stored in eight bytes.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2351 "key": "Grayscale64",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2352 "value": 11
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2353 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2354 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2355 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2356 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2357 "documentation": "The action to be taken after ReceivedInstanceCallback is triggered",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2358 "name": "OrthancPluginReceivedInstanceAction",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2359 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2360 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2361 "documentation": "Keep the instance as is",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2362 "key": "KeepAsIs",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2363 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2364 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2365 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2366 "documentation": "Modify the instance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2367 "key": "Modify",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2368 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2369 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2370 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2371 "documentation": "Discard the instance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2372 "key": "Discard",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2373 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2374 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2375 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2376 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2377 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2378 "documentation": "The supported types of DICOM resources.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2379 "name": "OrthancPluginResourceType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2380 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2381 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2382 "documentation": "Patient",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2383 "key": "Patient",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2384 "value": 0
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2385 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2386 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2387 "documentation": "Study",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2388 "key": "Study",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2389 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2390 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2391 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2392 "documentation": "Series",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2393 "key": "Series",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2394 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2395 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2396 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2397 "documentation": "Instance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2398 "key": "Instance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2399 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2400 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2401 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2402 "documentation": "Unavailable resource type",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2403 "key": "None",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2404 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2405 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2406 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2407 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2408 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2409 "documentation": "The available values for the Failure Reason (0008,1197) during storage commitment. http://dicom.nema.org/medical/dicom/2019e/output/chtml/part03/sect_C.14.html#sect_C.14.1.1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2410 "name": "OrthancPluginStorageCommitmentFailureReason",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2411 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2412 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2413 "documentation": "Success: The DICOM instance is properly stored in the SCP",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2414 "key": "Success",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2415 "value": 0
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2416 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2417 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2418 "documentation": "0110H: A general failure in processing the operation was encountered",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2419 "key": "ProcessingFailure",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2420 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2421 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2422 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2423 "documentation": "0112H: One or more of the elements in the Referenced SOP Instance Sequence was not available",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2424 "key": "NoSuchObjectInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2425 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2426 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2427 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2428 "documentation": "0213H: The SCP does not currently have enough resources to store the requested SOP Instance(s)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2429 "key": "ResourceLimitation",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2430 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2431 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2432 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2433 "documentation": "0122H: Storage Commitment has been requested for a SOP Instance with a SOP Class that is not supported by the SCP",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2434 "key": "ReferencedSOPClassNotSupported",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2435 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2436 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2437 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2438 "documentation": "0119H: The SOP Class of an element in the Referenced SOP Instance Sequence did not correspond to the SOP class registered for this SOP Instance at the SCP",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2439 "key": "ClassInstanceConflict",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2440 "value": 5
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2441 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2442 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2443 "documentation": "0131H: The Transaction UID of the Storage Commitment Request is already in use",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2444 "key": "DuplicateTransactionUID",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2445 "value": 6
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2446 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2447 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2448 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2449 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2450 "documentation": "The value representations present in the DICOM standard (version 2013).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2451 "name": "OrthancPluginValueRepresentation",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2452 "values": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2453 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2454 "documentation": "Application Entity",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2455 "key": "AE",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2456 "value": 1
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2457 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2458 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2459 "documentation": "Age String",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2460 "key": "AS",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2461 "value": 2
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2462 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2463 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2464 "documentation": "Attribute Tag",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2465 "key": "AT",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2466 "value": 3
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2467 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2468 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2469 "documentation": "Code String",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2470 "key": "CS",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2471 "value": 4
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2472 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2473 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2474 "documentation": "Date",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2475 "key": "DA",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2476 "value": 5
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2477 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2478 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2479 "documentation": "Decimal String",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2480 "key": "DS",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2481 "value": 6
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2482 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2483 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2484 "documentation": "Date Time",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2485 "key": "DT",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2486 "value": 7
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2487 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2488 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2489 "documentation": "Floating Point Double",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2490 "key": "FD",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2491 "value": 8
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2492 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2493 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2494 "documentation": "Floating Point Single",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2495 "key": "FL",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2496 "value": 9
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2497 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2498 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2499 "documentation": "Integer String",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2500 "key": "IS",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2501 "value": 10
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2502 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2503 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2504 "documentation": "Long String",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2505 "key": "LO",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2506 "value": 11
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2507 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2508 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2509 "documentation": "Long Text",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2510 "key": "LT",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2511 "value": 12
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2512 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2513 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2514 "documentation": "Other Byte String",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2515 "key": "OB",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2516 "value": 13
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2517 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2518 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2519 "documentation": "Other Float String",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2520 "key": "OF",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2521 "value": 14
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2522 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2523 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2524 "documentation": "Other Word String",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2525 "key": "OW",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2526 "value": 15
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2527 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2528 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2529 "documentation": "Person Name",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2530 "key": "PN",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2531 "value": 16
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2532 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2533 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2534 "documentation": "Short String",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2535 "key": "SH",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2536 "value": 17
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2537 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2538 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2539 "documentation": "Signed Long",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2540 "key": "SL",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2541 "value": 18
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2542 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2543 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2544 "documentation": "Sequence of Items",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2545 "key": "SQ",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2546 "value": 19
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2547 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2548 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2549 "documentation": "Signed Short",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2550 "key": "SS",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2551 "value": 20
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2552 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2553 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2554 "documentation": "Short Text",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2555 "key": "ST",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2556 "value": 21
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2557 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2558 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2559 "documentation": "Time",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2560 "key": "TM",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2561 "value": 22
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2562 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2563 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2564 "documentation": "Unique Identifier (UID)",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2565 "key": "UI",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2566 "value": 23
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2567 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2568 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2569 "documentation": "Unsigned Long",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2570 "key": "UL",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2571 "value": 24
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2572 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2573 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2574 "documentation": "Unknown",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2575 "key": "UN",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2576 "value": 25
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2577 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2578 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2579 "documentation": "Unsigned Short",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2580 "key": "US",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2581 "value": 26
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2582 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2583 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2584 "documentation": "Unlimited Text",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2585 "key": "UT",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2586 "value": 27
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2587 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2588 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2589 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2590 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2591 "global_functions": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2592 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2593 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2594 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2595 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2596 "sdk_name": "expectedMajor",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2597 "sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2598 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2599 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2600 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2601 "sdk_name": "expectedMinor",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2602 "sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2603 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2604 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2605 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2606 "sdk_name": "expectedRevision",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2607 "sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2608 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2609 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2610 "c_function": "OrthancPluginCheckVersionAdvanced",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2611 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2612 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2613 "expectedMajor": "Expected major version.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2614 "expectedMinor": "Expected minor version.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2615 "expectedRevision": "Expected revision."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2616 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2617 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2618 "This function checks whether the version of the Orthanc server running this plugin, is above the given version. Contrarily to OrthancPluginCheckVersion(), it is up to the developer of the plugin to make sure that all the Orthanc SDK services called by the plugin are actually implemented in the given version of Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2619 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2620 "return": "1 if and only if the versions are compatible. If the result is 0, the initialization of the plugin should fail.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2621 "summary": "Check that the version of the hosting Orthanc is above a given version."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2622 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2623 "return_sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2624 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2625 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2626 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2627 "c_function": "OrthancPluginCheckVersion",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2628 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2629 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2630 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2631 "This function checks whether the version of the Orthanc server running this plugin, is above the version of the current Orthanc SDK header. This guarantees that the plugin is compatible with the hosting Orthanc (i.e. it will not call unavailable services). The result of this function should always be checked in the OrthancPluginInitialize() entry point of the plugin."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2632 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2633 "return": "1 if and only if the versions are compatible. If the result is 0, the initialization of the plugin should fail.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2634 "summary": "Check the compatibility of the plugin wrt. the version of its hosting Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2635 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2636 "return_sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2637 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2638 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2639 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2640 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2641 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2642 "sdk_name": "message",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2643 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2644 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2645 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2646 "c_function": "OrthancPluginLogError",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2647 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2648 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2649 "message": "The message to be logged."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2650 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2651 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2652 "Log an error message using the Orthanc logging system."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2653 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2654 "summary": "Log an error."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2655 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2656 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2657 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2658 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2659 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2660 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2661 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2662 "sdk_name": "message",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2663 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2664 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2665 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2666 "c_function": "OrthancPluginLogWarning",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2667 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2668 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2669 "message": "The message to be logged."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2670 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2671 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2672 "Log a warning message using the Orthanc logging system."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2673 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2674 "summary": "Log a warning."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2675 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2676 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2677 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2678 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2679 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2680 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2681 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2682 "sdk_name": "message",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2683 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2684 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2685 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2686 "c_function": "OrthancPluginLogInfo",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2687 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2688 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2689 "message": "The message to be logged."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2690 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2691 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2692 "Log an information message using the Orthanc logging system."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2693 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2694 "summary": "Log an information."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2695 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2696 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2697 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2698 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2699 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2700 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2701 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2702 "sdk_name": "instanceId",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2703 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2704 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2705 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2706 "c_function": "OrthancPluginGetDicomForInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2707 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2708 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2709 "instanceId": "The Orthanc identifier of the DICOM instance of interest.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2710 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2711 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2712 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2713 "Retrieve a DICOM instance using its Orthanc identifier. The DICOM file is stored into a newly allocated memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2714 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2715 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2716 "summary": "Retrieve a DICOM instance using its Orthanc identifier."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2717 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2718 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2719 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2720 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2721 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2722 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2723 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2724 "sdk_name": "uri",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2725 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2726 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2727 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2728 "c_function": "OrthancPluginRestApiGet",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2729 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2730 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2731 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2732 "uri": "The URI in the built-in Orthanc API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2733 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2734 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2735 "Make a GET call to the built-in Orthanc REST API. The result to the query is stored into a newly allocated memory buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2736 "Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2737 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2738 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2739 "summary": "Make a GET call to the built-in Orthanc REST API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2740 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2741 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2742 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2743 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2744 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2745 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2746 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2747 "sdk_name": "uri",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2748 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2749 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2750 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2751 "c_function": "OrthancPluginRestApiGetAfterPlugins",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2752 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2753 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2754 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2755 "uri": "The URI in the built-in Orthanc API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2756 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2757 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2758 "Make a GET call to the Orthanc REST API, after all the plugins are applied. In other words, if some plugin overrides or adds the called URI to the built-in Orthanc REST API, this call will return the result provided by this plugin. The result to the query is stored into a newly allocated memory buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2759 "Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2760 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2761 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2762 "summary": "Make a GET call to the REST API, as tainted by the plugins."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2763 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2764 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2765 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2766 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2767 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2768 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2769 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2770 "sdk_name": "uri",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2771 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2772 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2773 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2774 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2775 "sdk_name": "body",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2776 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2777 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2778 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2779 "c_function": "OrthancPluginRestApiPost",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2780 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2781 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2782 "body": "The body of the POST request.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2783 "bodySize": "The size of the body.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2784 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2785 "uri": "The URI in the built-in Orthanc API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2786 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2787 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2788 "Make a POST call to the built-in Orthanc REST API. The result to the query is stored into a newly allocated memory buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2789 "Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2790 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2791 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2792 "summary": "Make a POST call to the built-in Orthanc REST API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2793 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2794 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2795 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2796 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2797 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2798 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2799 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2800 "sdk_name": "uri",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2801 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2802 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2803 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2804 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2805 "sdk_name": "body",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2806 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2807 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2808 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2809 "c_function": "OrthancPluginRestApiPostAfterPlugins",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2810 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2811 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2812 "body": "The body of the POST request.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2813 "bodySize": "The size of the body.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2814 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2815 "uri": "The URI in the built-in Orthanc API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2816 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2817 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2818 "Make a POST call to the Orthanc REST API, after all the plugins are applied. In other words, if some plugin overrides or adds the called URI to the built-in Orthanc REST API, this call will return the result provided by this plugin. The result to the query is stored into a newly allocated memory buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2819 "Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2820 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2821 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2822 "summary": "Make a POST call to the REST API, as tainted by the plugins."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2823 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2824 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2825 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2826 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2827 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2828 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2829 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2830 "sdk_name": "uri",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2831 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2832 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2833 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2834 "c_function": "OrthancPluginRestApiDelete",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2835 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2836 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2837 "uri": "The URI to delete in the built-in Orthanc API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2838 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2839 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2840 "Make a DELETE call to the built-in Orthanc REST API.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2841 "Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2842 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2843 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2844 "summary": "Make a DELETE call to the built-in Orthanc REST API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2845 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2846 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2847 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2848 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2849 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2850 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2851 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2852 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2853 "sdk_name": "uri",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2854 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2855 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2856 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2857 "c_function": "OrthancPluginRestApiDeleteAfterPlugins",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2858 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2859 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2860 "uri": "The URI to delete in the built-in Orthanc API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2861 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2862 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2863 "Make a DELETE call to the Orthanc REST API, after all the plugins are applied. In other words, if some plugin overrides or adds the called URI to the built-in Orthanc REST API, this call will return the result provided by this plugin.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2864 "Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2865 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2866 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2867 "summary": "Make a DELETE call to the REST API, as tainted by the plugins."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2868 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2869 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2870 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2871 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2872 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2873 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2874 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2875 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2876 "sdk_name": "uri",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2877 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2878 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2879 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2880 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2881 "sdk_name": "body",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2882 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2883 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2884 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2885 "c_function": "OrthancPluginRestApiPut",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2886 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2887 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2888 "body": "The body of the PUT request.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2889 "bodySize": "The size of the body.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2890 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2891 "uri": "The URI in the built-in Orthanc API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2892 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2893 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2894 "Make a PUT call to the built-in Orthanc REST API. The result to the query is stored into a newly allocated memory buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2895 "Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2896 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2897 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2898 "summary": "Make a PUT call to the built-in Orthanc REST API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2899 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2900 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2901 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2902 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2903 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2904 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2905 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2906 "sdk_name": "uri",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2907 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2908 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2909 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2910 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2911 "sdk_name": "body",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2912 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2913 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2914 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2915 "c_function": "OrthancPluginRestApiPutAfterPlugins",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2916 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2917 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2918 "body": "The body of the PUT request.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2919 "bodySize": "The size of the body.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2920 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2921 "uri": "The URI in the built-in Orthanc API."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2922 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2923 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2924 "Make a PUT call to the Orthanc REST API, after all the plugins are applied. In other words, if some plugin overrides or adds the called URI to the built-in Orthanc REST API, this call will return the result provided by this plugin. The result to the query is stored into a newly allocated memory buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2925 "Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2926 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2927 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2928 "summary": "Make a PUT call to the REST API, as tainted by the plugins."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2929 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2930 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2931 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2932 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2933 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2934 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2935 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2936 "sdk_name": "patientID",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2937 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2938 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2939 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2940 "c_function": "OrthancPluginLookupPatient",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2941 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2942 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2943 "patientID": "The Patient ID of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2944 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2945 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2946 "Look for a patient stored in Orthanc, using its Patient ID tag (0x0010, 0x0020). This function uses the database index to run as fast as possible (it does not loop over all the stored patients)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2947 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2948 "return": "The NULL value if the patient is non-existent, or a string containing the Orthanc ID of the patient. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2949 "summary": "Look for a patient."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2950 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2951 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2952 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2953 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2954 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2955 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2956 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2957 "sdk_name": "studyUID",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2958 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2959 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2960 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2961 "c_function": "OrthancPluginLookupStudy",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2962 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2963 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2964 "studyUID": "The Study Instance UID of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2965 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2966 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2967 "Look for a study stored in Orthanc, using its Study Instance UID tag (0x0020, 0x000d). This function uses the database index to run as fast as possible (it does not loop over all the stored studies)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2968 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2969 "return": "The NULL value if the study is non-existent, or a string containing the Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2970 "summary": "Look for a study."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2971 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2972 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2973 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2974 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2975 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2976 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2977 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2978 "sdk_name": "accessionNumber",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2979 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2980 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2981 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2982 "c_function": "OrthancPluginLookupStudyWithAccessionNumber",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2983 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2984 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2985 "accessionNumber": "The Accession Number of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2986 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2987 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2988 "Look for a study stored in Orthanc, using its Accession Number tag (0x0008, 0x0050). This function uses the database index to run as fast as possible (it does not loop over all the stored studies)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2989 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2990 "return": "The NULL value if the study is non-existent, or a string containing the Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2991 "summary": "Look for a study, using the accession number."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2992 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2993 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2994 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2995 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2996 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2997 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2998 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2999 "sdk_name": "seriesUID",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3000 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3001 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3002 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3003 "c_function": "OrthancPluginLookupSeries",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3004 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3005 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3006 "seriesUID": "The Series Instance UID of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3007 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3008 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3009 "Look for a series stored in Orthanc, using its Series Instance UID tag (0x0020, 0x000e). This function uses the database index to run as fast as possible (it does not loop over all the stored series)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3010 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3011 "return": "The NULL value if the series is non-existent, or a string containing the Orthanc ID of the series. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3012 "summary": "Look for a series."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3013 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3014 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3015 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3016 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3017 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3018 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3019 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3020 "sdk_name": "sopInstanceUID",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3021 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3022 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3023 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3024 "c_function": "OrthancPluginLookupInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3025 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3026 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3027 "sopInstanceUID": "The SOP Instance UID of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3028 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3029 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3030 "Look for an instance stored in Orthanc, using its SOP Instance UID tag (0x0008, 0x0018). This function uses the database index to run as fast as possible (it does not loop over all the stored instances)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3031 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3032 "return": "The NULL value if the instance is non-existent, or a string containing the Orthanc ID of the instance. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3033 "summary": "Look for an instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3034 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3035 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3036 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3037 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3038 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3039 "c_function": "OrthancPluginGetOrthancPath",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3040 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3041 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3042 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3043 "This function returns the path to the Orthanc executable."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3044 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3045 "return": "NULL in the case of an error, or a newly allocated string containing the path. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3046 "summary": "Return the path to the Orthanc executable."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3047 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3048 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3049 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3050 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3051 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3052 "c_function": "OrthancPluginGetOrthancDirectory",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3053 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3054 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3055 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3056 "This function returns the path to the directory containing the Orthanc executable."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3057 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3058 "return": "NULL in the case of an error, or a newly allocated string containing the path. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3059 "summary": "Return the directory containing the Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3060 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3061 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3062 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3063 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3064 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3065 "c_function": "OrthancPluginGetConfigurationPath",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3066 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3067 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3068 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3069 "This function returns the path to the configuration file(s) that was specified when starting Orthanc. Since version 0.9.1, this path can refer to a folder that stores a set of configuration files. This function is deprecated in favor of OrthancPluginGetConfiguration()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3070 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3071 "return": "NULL in the case of an error, or a newly allocated string containing the path. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3072 "summary": "Return the path to the configuration file(s)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3073 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3074 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3075 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3076 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3077 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3078 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3079 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3080 "sdk_name": "uri",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3081 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3082 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3083 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3084 "c_function": "OrthancPluginSetRootUri",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3085 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3086 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3087 "uri": "The root URI for this plugin."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3088 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3089 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3090 "For plugins that come with a Web interface, this function declares the entry path where to find this interface. This information is notably used in the \"Plugins\" page of Orthanc Explorer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3091 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3092 "summary": "Set the URI where the plugin provides its Web interface."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3093 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3094 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3095 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3096 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3097 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3098 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3099 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3100 "sdk_name": "description",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3101 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3102 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3103 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3104 "c_function": "OrthancPluginSetDescription",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3105 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3106 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3107 "description": "The description."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3108 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3109 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3110 "Set a description for this plugin. It is displayed in the \"Plugins\" page of Orthanc Explorer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3111 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3112 "summary": "Set a description for this plugin."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3113 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3114 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3115 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3116 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3117 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3118 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3119 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3120 "sdk_name": "javascript",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3121 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3122 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3123 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3124 "c_function": "OrthancPluginExtendOrthancExplorer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3125 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3126 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3127 "javascript": "The custom JavaScript code."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3128 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3129 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3130 "Add JavaScript code to customize the default behavior of Orthanc Explorer. This can for instance be used to add new buttons."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3131 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3132 "summary": "Extend the JavaScript code of Orthanc Explorer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3133 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3134 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3135 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3136 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3137 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3138 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3139 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3140 "sdk_name": "property",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3141 "sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3142 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3143 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3144 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3145 "sdk_name": "defaultValue",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3146 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3147 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3148 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3149 "c_function": "OrthancPluginGetGlobalProperty",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3150 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3151 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3152 "defaultValue": "The value to return, if the global property is unset.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3153 "property": "The global property of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3154 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3155 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3156 "Get the value of a global property that is stored in the Orthanc database. Global properties whose index is below 1024 are reserved by Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3157 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3158 "return": "The value of the global property, or NULL in the case of an error. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3159 "summary": "Get the value of a global property."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3160 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3161 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3162 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3163 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3164 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3165 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3166 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3167 "sdk_name": "property",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3168 "sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3169 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3170 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3171 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3172 "sdk_name": "value",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3173 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3174 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3175 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3176 "c_function": "OrthancPluginSetGlobalProperty",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3177 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3178 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3179 "property": "The global property of interest.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3180 "value": "The value to be set in the global property."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3181 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3182 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3183 "Set the value of a global property into the Orthanc database. Setting a global property can be used by plugins to save their internal parameters. Plugins are only allowed to set properties whose index are above or equal to 1024 (properties below 1024 are read-only and reserved by Orthanc)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3184 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3185 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3186 "summary": "Set the value of a global property."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3187 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3188 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3189 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3190 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3191 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3192 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3193 "c_function": "OrthancPluginGetCommandLineArgumentsCount",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3194 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3195 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3196 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3197 "Retrieve the number of command-line arguments that were used to launch Orthanc."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3198 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3199 "return": "The number of arguments.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3200 "summary": "Get the number of command-line arguments."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3201 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3202 "return_sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3203 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3204 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3205 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3206 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3207 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3208 "sdk_name": "argument",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3209 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3210 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3211 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3212 "c_function": "OrthancPluginGetCommandLineArgument",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3213 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3214 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3215 "argument": "The index of the argument."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3216 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3217 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3218 "Get the value of one of the command-line arguments that were used to launch Orthanc. The number of available arguments can be retrieved by OrthancPluginGetCommandLineArgumentsCount()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3219 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3220 "return": "The value of the argument, or NULL in the case of an error. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3221 "summary": "Get the value of a command-line argument."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3222 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3223 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3224 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3225 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3226 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3227 "c_function": "OrthancPluginGetExpectedDatabaseVersion",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3228 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3229 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3230 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3231 "Retrieve the expected version of the database schema."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3232 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3233 "return": "The version.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3234 "summary": "Get the expected version of the database schema."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3235 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3236 "return_sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3237 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3238 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3239 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3240 "c_function": "OrthancPluginGetConfiguration",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3241 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3242 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3243 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3244 "This function returns the content of the configuration that is used by Orthanc, formatted as a JSON string."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3245 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3246 "return": "NULL in the case of an error, or a newly allocated string containing the configuration. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3247 "summary": "Return the content of the configuration file(s)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3248 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3249 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3250 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3251 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3252 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3253 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3254 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3255 "sdk_name": "source",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3256 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3257 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3258 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3259 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3260 "sdk_enumeration": "OrthancPluginCompressionType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3261 "sdk_name": "compression",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3262 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3263 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3264 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3265 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3266 "sdk_name": "uncompress",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3267 "sdk_type": "uint8_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3268 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3269 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3270 "c_function": "OrthancPluginBufferCompression",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3271 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3272 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3273 "compression": "The compression algorithm.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3274 "size": "The size in bytes of the source buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3275 "source": "The source buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3276 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3277 "uncompress": "If set to \"0\", the buffer must be compressed. If set to \"1\", the buffer must be uncompressed."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3278 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3279 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3280 "This function compresses or decompresses a buffer, using the version of the zlib library that is used by the Orthanc core."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3281 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3282 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3283 "summary": "Compress or decompress a buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3284 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3285 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3286 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3287 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3288 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3289 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3290 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3291 "sdk_name": "path",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3292 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3293 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3294 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3295 "c_function": "OrthancPluginReadFile",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3296 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3297 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3298 "path": "The path of the file to be read.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3299 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3300 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3301 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3302 "Read the content of a file on the filesystem, and returns it into a newly allocated memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3303 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3304 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3305 "summary": "Read a file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3306 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3307 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3308 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3309 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3310 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3311 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3312 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3313 "sdk_name": "path",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3314 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3315 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3316 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3317 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3318 "sdk_name": "data",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3319 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3320 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3321 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3322 "c_function": "OrthancPluginWriteFile",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3323 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3324 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3325 "data": "The content of the memory buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3326 "path": "The path of the file to be written.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3327 "size": "The size of the memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3328 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3329 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3330 "Write the content of a memory buffer to the filesystem."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3331 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3332 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3333 "summary": "Write a file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3334 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3335 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3336 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3337 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3338 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3339 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3340 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3341 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3342 "sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3343 "sdk_name": "error",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3344 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3345 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3346 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3347 "c_function": "OrthancPluginGetErrorDescription",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3348 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3349 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3350 "error": "The error code of interest."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3351 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3352 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3353 "This function returns the description of a given error code."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3354 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3355 "return": "The error description. This is a statically-allocated string, do not free it.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3356 "summary": "Get the description of a given error code."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3357 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3358 "return_sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3359 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3360 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3361 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3362 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3363 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3364 "sdk_name": "data",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3365 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3366 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3367 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3368 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3369 "sdk_enumeration": "OrthancPluginImageFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3370 "sdk_name": "format",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3371 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3372 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3373 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3374 "c_function": "OrthancPluginUncompressImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3375 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3376 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3377 "data": "Pointer to a memory buffer containing the compressed image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3378 "format": "The file format of the compressed image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3379 "size": "Size of the memory buffer containing the compressed image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3380 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3381 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3382 "This function decodes a compressed image from a memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3383 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3384 "return": "The uncompressed image. It must be freed with OrthancPluginFreeImage().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3385 "summary": "Decode a compressed image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3386 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3387 "return_sdk_class": "OrthancPluginImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3388 "return_sdk_type": "object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3389 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3390 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3391 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3392 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3393 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3394 "sdk_enumeration": "OrthancPluginPixelFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3395 "sdk_name": "format",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3396 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3397 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3398 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3399 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3400 "sdk_name": "width",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3401 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3402 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3403 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3404 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3405 "sdk_name": "height",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3406 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3407 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3408 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3409 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3410 "sdk_name": "pitch",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3411 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3412 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3413 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3414 "name": "arg4",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3415 "sdk_name": "buffer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3416 "sdk_type": "const void *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3417 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3418 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3419 "c_function": "OrthancPluginCompressPngImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3420 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3421 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3422 "buffer": "The memory buffer containing the uncompressed image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3423 "format": "The memory layout of the uncompressed image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3424 "height": "The height of the image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3425 "pitch": "The pitch of the image (i.e. the number of bytes between 2 successive lines of the image in the memory buffer).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3426 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3427 "width": "The width of the image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3428 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3429 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3430 "This function compresses the given memory buffer containing an image using the PNG specification, and stores the result of the compression into a newly allocated memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3431 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3432 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3433 "summary": "Encode a PNG image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3434 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3435 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3436 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3437 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3438 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3439 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3440 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3441 "sdk_enumeration": "OrthancPluginPixelFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3442 "sdk_name": "format",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3443 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3444 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3445 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3446 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3447 "sdk_name": "width",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3448 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3449 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3450 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3451 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3452 "sdk_name": "height",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3453 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3454 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3455 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3456 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3457 "sdk_name": "pitch",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3458 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3459 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3460 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3461 "name": "arg4",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3462 "sdk_name": "buffer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3463 "sdk_type": "const void *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3464 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3465 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3466 "name": "arg5",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3467 "sdk_name": "quality",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3468 "sdk_type": "uint8_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3469 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3470 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3471 "c_function": "OrthancPluginCompressJpegImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3472 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3473 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3474 "buffer": "The memory buffer containing the uncompressed image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3475 "format": "The memory layout of the uncompressed image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3476 "height": "The height of the image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3477 "pitch": "The pitch of the image (i.e. the number of bytes between 2 successive lines of the image in the memory buffer).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3478 "quality": "The quality of the JPEG encoding, between 1 (worst quality, best compression) and 100 (best quality, worst compression).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3479 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3480 "width": "The width of the image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3481 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3482 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3483 "This function compresses the given memory buffer containing an image using the JPEG specification, and stores the result of the compression into a newly allocated memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3484 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3485 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3486 "summary": "Encode a JPEG image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3487 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3488 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3489 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3490 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3491 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3492 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3493 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3494 "sdk_name": "url",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3495 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3496 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3497 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3498 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3499 "sdk_name": "username",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3500 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3501 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3502 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3503 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3504 "sdk_name": "password",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3505 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3506 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3507 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3508 "c_function": "OrthancPluginHttpGet",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3509 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3510 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3511 "password": "The password (can be \"NULL\" if no password protection).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3512 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3513 "url": "The URL of interest.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3514 "username": "The username (can be \"NULL\" if no password protection)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3515 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3516 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3517 "Make a HTTP GET call to the given URL. The result to the query is stored into a newly allocated memory buffer. Favor OrthancPluginRestApiGet() if calling the built-in REST API of the Orthanc instance that hosts this plugin."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3518 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3519 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3520 "summary": "Issue a HTTP GET call."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3521 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3522 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3523 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3524 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3525 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3526 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3527 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3528 "sdk_name": "url",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3529 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3530 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3531 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3532 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3533 "sdk_name": "body",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3534 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3535 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3536 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3537 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3538 "sdk_name": "username",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3539 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3540 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3541 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3542 "name": "arg4",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3543 "sdk_name": "password",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3544 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3545 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3546 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3547 "c_function": "OrthancPluginHttpPost",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3548 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3549 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3550 "body": "The content of the body of the request.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3551 "bodySize": "The size of the body of the request.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3552 "password": "The password (can be \"NULL\" if no password protection).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3553 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3554 "url": "The URL of interest.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3555 "username": "The username (can be \"NULL\" if no password protection)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3556 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3557 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3558 "Make a HTTP POST call to the given URL. The result to the query is stored into a newly allocated memory buffer. Favor OrthancPluginRestApiPost() if calling the built-in REST API of the Orthanc instance that hosts this plugin."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3559 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3560 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3561 "summary": "Issue a HTTP POST call."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3562 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3563 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3564 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3565 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3566 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3567 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3568 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3569 "sdk_name": "url",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3570 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3571 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3572 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3573 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3574 "sdk_name": "body",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3575 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3576 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3577 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3578 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3579 "sdk_name": "username",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3580 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3581 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3582 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3583 "name": "arg4",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3584 "sdk_name": "password",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3585 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3586 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3587 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3588 "c_function": "OrthancPluginHttpPut",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3589 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3590 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3591 "body": "The content of the body of the request.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3592 "bodySize": "The size of the body of the request.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3593 "password": "The password (can be \"NULL\" if no password protection).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3594 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3595 "url": "The URL of interest.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3596 "username": "The username (can be \"NULL\" if no password protection)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3597 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3598 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3599 "Make a HTTP PUT call to the given URL. The result to the query is stored into a newly allocated memory buffer. Favor OrthancPluginRestApiPut() if calling the built-in REST API of the Orthanc instance that hosts this plugin."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3600 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3601 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3602 "summary": "Issue a HTTP PUT call."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3603 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3604 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3605 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3606 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3607 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3608 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3609 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3610 "sdk_name": "url",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3611 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3612 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3613 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3614 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3615 "sdk_name": "username",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3616 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3617 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3618 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3619 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3620 "sdk_name": "password",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3621 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3622 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3623 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3624 "c_function": "OrthancPluginHttpDelete",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3625 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3626 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3627 "password": "The password (can be \"NULL\" if no password protection).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3628 "url": "The URL of interest.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3629 "username": "The username (can be \"NULL\" if no password protection)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3630 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3631 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3632 "Make a HTTP DELETE call to the given URL. Favor OrthancPluginRestApiDelete() if calling the built-in REST API of the Orthanc instance that hosts this plugin."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3633 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3634 "return": "0 if success, or the error code if failure.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3635 "summary": "Issue a HTTP DELETE call."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3636 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3637 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3638 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3639 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3640 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3641 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3642 "c_function": "OrthancPluginGetFontsCount",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3643 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3644 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3645 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3646 "This function returns the number of fonts that are built in the Orthanc core. These fonts can be used to draw texts on images through OrthancPluginDrawText()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3647 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3648 "return": "The number of fonts.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3649 "summary": "Return the number of available fonts."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3650 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3651 "return_sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3652 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3653 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3654 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3655 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3656 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3657 "sdk_name": "fontIndex",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3658 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3659 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3660 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3661 "c_function": "OrthancPluginGetFontName",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3662 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3663 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3664 "fontIndex": "The index of the font. This value must be less than OrthancPluginGetFontsCount()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3665 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3666 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3667 "This function returns the name of a font that is built in the Orthanc core."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3668 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3669 "return": "The font name. This is a statically-allocated string, do not free it.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3670 "summary": "Return the name of a font."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3671 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3672 "return_sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3673 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3674 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3675 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3676 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3677 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3678 "sdk_name": "fontIndex",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3679 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3680 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3681 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3682 "c_function": "OrthancPluginGetFontSize",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3683 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3684 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3685 "fontIndex": "The index of the font. This value must be less than OrthancPluginGetFontsCount()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3686 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3687 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3688 "This function returns the size of a font that is built in the Orthanc core."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3689 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3690 "return": "The font size.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3691 "summary": "Return the size of a font."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3692 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3693 "return_sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3694 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3695 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3696 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3697 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3698 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3699 "sdk_name": "code",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3700 "sdk_type": "int32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3701 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3702 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3703 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3704 "sdk_name": "httpStatus",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3705 "sdk_type": "uint16_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3706 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3707 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3708 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3709 "sdk_name": "message",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3710 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3711 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3712 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3713 "c_function": "OrthancPluginRegisterErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3714 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3715 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3716 "code": "The error code that is internal to this plugin.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3717 "httpStatus": "The HTTP status corresponding to this error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3718 "message": "The description of the error."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3719 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3720 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3721 "This function declares a custom error code that can be generated by this plugin. This declaration is used to enrich the body of the HTTP answer in the case of an error, and to set the proper HTTP status code."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3722 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3723 "return": "The error code that has been assigned inside the Orthanc core.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3724 "summary": "Declare a custom error code for this plugin."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3725 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3726 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3727 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3728 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3729 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3730 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3731 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3732 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3733 "sdk_name": "group",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3734 "sdk_type": "uint16_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3735 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3736 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3737 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3738 "sdk_name": "element",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3739 "sdk_type": "uint16_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3740 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3741 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3742 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3743 "sdk_enumeration": "OrthancPluginValueRepresentation",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3744 "sdk_name": "vr",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3745 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3746 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3747 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3748 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3749 "sdk_name": "name",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3750 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3751 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3752 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3753 "name": "arg4",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3754 "sdk_name": "minMultiplicity",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3755 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3756 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3757 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3758 "name": "arg5",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3759 "sdk_name": "maxMultiplicity",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3760 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3761 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3762 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3763 "c_function": "OrthancPluginRegisterDictionaryTag",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3764 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3765 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3766 "element": "The element of the tag.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3767 "group": "The group of the tag.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3768 "maxMultiplicity": "The maximum multiplicity of the tag. A value of 0 means an arbitrary multiplicity (\"\"n\"\").",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3769 "minMultiplicity": "The minimum multiplicity of the tag (must be above 0).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3770 "name": "The nickname of the tag.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3771 "vr": "The value representation of the tag."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3772 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3773 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3774 "This function declares a new public tag in the dictionary of DICOM tags that are known to Orthanc. This function should be used in the OrthancPluginInitialize() callback."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3775 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3776 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3777 "summary": "Register a new tag into the DICOM dictionary."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3778 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3779 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3780 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3781 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3782 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3783 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3784 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3785 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3786 "sdk_name": "group",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3787 "sdk_type": "uint16_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3788 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3789 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3790 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3791 "sdk_name": "element",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3792 "sdk_type": "uint16_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3793 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3794 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3795 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3796 "sdk_enumeration": "OrthancPluginValueRepresentation",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3797 "sdk_name": "vr",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3798 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3799 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3800 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3801 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3802 "sdk_name": "name",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3803 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3804 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3805 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3806 "name": "arg4",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3807 "sdk_name": "minMultiplicity",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3808 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3809 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3810 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3811 "name": "arg5",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3812 "sdk_name": "maxMultiplicity",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3813 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3814 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3815 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3816 "name": "arg6",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3817 "sdk_name": "privateCreator",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3818 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3819 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3820 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3821 "c_function": "OrthancPluginRegisterPrivateDictionaryTag",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3822 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3823 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3824 "element": "The element of the tag.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3825 "group": "The group of the tag.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3826 "maxMultiplicity": "The maximum multiplicity of the tag. A value of 0 means an arbitrary multiplicity (\"\"n\"\").",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3827 "minMultiplicity": "The minimum multiplicity of the tag (must be above 0).",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3828 "name": "The nickname of the tag.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3829 "privateCreator": "The private creator of this private tag.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3830 "vr": "The value representation of the tag."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3831 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3832 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3833 "This function declares a new private tag in the dictionary of DICOM tags that are known to Orthanc. This function should be used in the OrthancPluginInitialize() callback."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3834 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3835 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3836 "summary": "Register a new private tag into the DICOM dictionary."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3837 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3838 "return_sdk_enumeration": "OrthancPluginErrorCode",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3839 "return_sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3840 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3841 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3842 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3843 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3844 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3845 "sdk_name": "buffer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3846 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3847 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3848 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3849 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3850 "sdk_enumeration": "OrthancPluginDicomToJsonFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3851 "sdk_name": "format",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3852 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3853 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3854 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3855 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3856 "sdk_enumeration": "OrthancPluginDicomToJsonFlags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3857 "sdk_name": "flags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3858 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3859 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3860 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3861 "name": "arg4",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3862 "sdk_name": "maxStringLength",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3863 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3864 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3865 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3866 "c_function": "OrthancPluginDicomBufferToJson",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3867 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3868 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3869 "buffer": "The memory buffer containing the DICOM file.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3870 "flags": "Flags governing the output.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3871 "format": "The output format.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3872 "maxStringLength": "The maximum length of a field. Too long fields will be output as \"null\". The 0 value means no maximum length.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3873 "size": "The size of the memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3874 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3875 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3876 "This function takes as input a memory buffer containing a DICOM file, and outputs a JSON string representing the tags of this DICOM file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3877 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3878 "return": "The NULL value if the case of an error, or the JSON string. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3879 "summary": "Format a DICOM memory buffer as a JSON string."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3880 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3881 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3882 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3883 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3884 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3885 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3886 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3887 "sdk_name": "instanceId",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3888 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3889 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3890 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3891 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3892 "sdk_enumeration": "OrthancPluginDicomToJsonFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3893 "sdk_name": "format",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3894 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3895 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3896 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3897 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3898 "sdk_enumeration": "OrthancPluginDicomToJsonFlags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3899 "sdk_name": "flags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3900 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3901 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3902 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3903 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3904 "sdk_name": "maxStringLength",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3905 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3906 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3907 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3908 "c_function": "OrthancPluginDicomInstanceToJson",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3909 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3910 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3911 "flags": "Flags governing the output.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3912 "format": "The output format.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3913 "instanceId": "The Orthanc identifier of the instance.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3914 "maxStringLength": "The maximum length of a field. Too long fields will be output as \"null\". The 0 value means no maximum length."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3915 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3916 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3917 "This function formats a DICOM instance that is stored in Orthanc, and outputs a JSON string representing the tags of this DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3918 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3919 "return": "The NULL value if the case of an error, or the JSON string. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3920 "summary": "Format a DICOM instance as a JSON string."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3921 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3922 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3923 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3924 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3925 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3926 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3927 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3928 "sdk_name": "json",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3929 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3930 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3931 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3932 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3933 "sdk_class": "OrthancPluginImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3934 "sdk_name": "pixelData",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3935 "sdk_type": "const_object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3936 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3937 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3938 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3939 "sdk_enumeration": "OrthancPluginCreateDicomFlags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3940 "sdk_name": "flags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3941 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3942 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3943 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3944 "c_function": "OrthancPluginCreateDicom",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3945 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3946 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3947 "flags": "Flags governing the output.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3948 "json": "The input JSON file.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3949 "pixelData": "The image. Can be NULL, if the pixel data is encoded inside the JSON with the data URI scheme.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3950 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3951 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3952 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3953 "This function takes as input a string containing a JSON file describing the content of a DICOM instance. As an output, it writes the corresponding DICOM instance to a newly allocated memory buffer. Additionally, an image to be encoded within the DICOM instance can also be provided.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3954 "Private tags will be associated with the private creator whose value is specified in the \"DefaultPrivateCreator\" configuration option of Orthanc. The function OrthancPluginCreateDicom2() can be used if another private creator must be used to create this instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3955 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3956 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3957 "summary": "Create a DICOM instance from a JSON string and an image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3958 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3959 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3960 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3961 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3962 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3963 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3964 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3965 "sdk_enumeration": "OrthancPluginPixelFormat",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3966 "sdk_name": "format",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3967 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3968 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3969 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3970 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3971 "sdk_name": "width",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3972 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3973 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3974 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3975 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3976 "sdk_name": "height",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3977 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3978 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3979 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3980 "c_function": "OrthancPluginCreateImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3981 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3982 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3983 "format": "The format of the pixels.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3984 "height": "The height of the image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3985 "width": "The width of the image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3986 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3987 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3988 "This function creates an image of given size and format."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3989 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3990 "return": "The newly allocated image. It must be freed with OrthancPluginFreeImage().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3991 "summary": "Create an image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3992 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3993 "return_sdk_class": "OrthancPluginImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3994 "return_sdk_type": "object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3995 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3996 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3997 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3998 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3999 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4000 "sdk_name": "buffer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4001 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4002 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4003 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4004 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4005 "sdk_name": "frameIndex",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4006 "sdk_type": "uint32_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4007 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4008 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4009 "c_function": "OrthancPluginDecodeDicomImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4010 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4011 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4012 "buffer": "Pointer to a memory buffer containing the DICOM image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4013 "bufferSize": "Size of the memory buffer containing the DICOM image.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4014 "frameIndex": "The index of the frame of interest in a multi-frame image."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4015 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4016 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4017 "This function decodes one frame of a DICOM image that is stored in a memory buffer. This function will give the same result as OrthancPluginUncompressImage() for single-frame DICOM images."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4018 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4019 "return": "The uncompressed image. It must be freed with OrthancPluginFreeImage().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4020 "summary": "Decode one frame from a DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4021 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4022 "return_sdk_class": "OrthancPluginImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4023 "return_sdk_type": "object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4024 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4025 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4026 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4027 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4028 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4029 "sdk_name": "buffer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4030 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4031 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4032 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4033 "c_function": "OrthancPluginComputeMd5",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4034 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4035 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4036 "buffer": "The source memory buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4037 "size": "The size in bytes of the source buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4038 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4039 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4040 "This functions computes the MD5 cryptographic hash of the given memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4041 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4042 "return": "The NULL value in case of error, or a string containing the cryptographic hash. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4043 "summary": "Compute an MD5 hash."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4044 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4045 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4046 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4047 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4048 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4049 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4050 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4051 "sdk_name": "buffer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4052 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4053 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4054 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4055 "c_function": "OrthancPluginComputeSha1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4056 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4057 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4058 "buffer": "The source memory buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4059 "size": "The size in bytes of the source buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4060 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4061 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4062 "This functions computes the SHA-1 cryptographic hash of the given memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4063 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4064 "return": "The NULL value in case of error, or a string containing the cryptographic hash. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4065 "summary": "Compute a SHA-1 hash."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4066 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4067 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4068 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4069 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4070 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4071 "c_function": "OrthancPluginGenerateUuid",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4072 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4073 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4074 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4075 "Generate a random GUID/UUID (globally unique identifier)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4076 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4077 "return": "NULL in the case of an error, or a newly allocated string containing the UUID. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4078 "summary": "Generate an UUID."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4079 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4080 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4081 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4082 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4083 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4084 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4085 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4086 "sdk_name": "query",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4087 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4088 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4089 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4090 "c_function": "OrthancPluginCreateFindMatcher",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4091 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4092 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4093 "query": "The C-Find DICOM query.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4094 "size": "The size of the DICOM query."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4095 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4096 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4097 "This function creates a \"matcher\" object that can be used to check whether a DICOM instance matches a C-Find query. The C-Find query must be expressed as a DICOM buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4098 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4099 "return": "The newly allocated matcher. It must be freed with OrthancPluginFreeFindMatcher().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4100 "summary": "Create a C-Find matcher."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4101 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4102 "return_sdk_class": "OrthancPluginFindMatcher",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4103 "return_sdk_type": "object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4104 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4105 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4106 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4107 "c_function": "OrthancPluginGetPeers",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4108 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4109 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4110 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4111 "This function returns the parameters of the Orthanc peers that are known to the Orthanc server hosting the plugin."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4112 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4113 "return": "NULL if error, or a newly allocated opaque data structure containing the peers. This structure must be freed with OrthancPluginFreePeers().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4114 "summary": "Return the list of available Orthanc peers."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4115 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4116 "return_sdk_class": "OrthancPluginPeers",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4117 "return_sdk_type": "object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4118 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4119 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4120 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4121 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4122 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4123 "sdk_name": "path",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4124 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4125 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4126 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4127 "c_function": "OrthancPluginAutodetectMimeType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4128 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4129 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4130 "path": "Path to the file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4131 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4132 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4133 "This function returns the MIME type of a file by inspecting its extension."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4134 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4135 "return": "The MIME type. This is a statically-allocated string, do not free it.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4136 "summary": "Detect the MIME type of a file."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4137 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4138 "return_sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4139 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4140 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4141 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4142 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4143 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4144 "sdk_name": "name",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4145 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4146 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4147 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4148 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4149 "sdk_name": "value",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4150 "sdk_type": "float"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4151 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4152 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4153 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4154 "sdk_enumeration": "OrthancPluginMetricsType",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4155 "sdk_name": "type",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4156 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4157 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4158 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4159 "c_function": "OrthancPluginSetMetricsValue",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4160 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4161 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4162 "name": "The name of the metrics to be set.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4163 "type": "The type of the metrics. This parameter is only taken into consideration the first time this metrics is set.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4164 "value": "The value of the metrics."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4165 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4166 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4167 "This function sets the value of a metrics to monitor the behavior of the plugin through tools such as Prometheus. The values of all the metrics are stored within the Orthanc context."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4168 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4169 "summary": "Set the value of a metrics."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4170 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4171 "return_sdk_type": "void"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4172 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4173 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4174 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4175 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4176 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4177 "sdk_name": "group",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4178 "sdk_type": "uint16_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4179 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4180 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4181 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4182 "sdk_name": "element",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4183 "sdk_type": "uint16_t"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4184 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4185 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4186 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4187 "sdk_name": "privateCreator",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4188 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4189 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4190 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4191 "c_function": "OrthancPluginGetTagName",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4192 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4193 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4194 "element": "The element of the tag.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4195 "group": "The group of the tag.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4196 "privateCreator": "For private tags, the name of the private creator (can be NULL)."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4197 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4198 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4199 "This function makes a lookup to the dictionary of DICOM tags that are known to Orthanc, and returns the symbolic name of a DICOM tag."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4200 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4201 "return": "NULL in the case of an error, or a newly allocated string containing the path. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4202 "summary": "Returns the symbolic name of a DICOM tag."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4203 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4204 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4205 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4206 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4207 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4208 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4209 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4210 "sdk_name": "buffer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4211 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4212 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4213 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4214 "c_function": "OrthancPluginCreateDicomInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4215 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4216 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4217 "buffer": "The memory buffer containing the DICOM instance.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4218 "size": "The size of the memory buffer."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4219 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4220 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4221 "This function parses a memory buffer that contains a DICOM file. The function returns a new pointer to a data structure that is managed by the Orthanc core."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4222 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4223 "return": "The newly allocated DICOM instance. It must be freed with OrthancPluginFreeDicomInstance().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4224 "summary": "Parse a DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4225 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4226 "return_sdk_class": "OrthancPluginDicomInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4227 "return_sdk_type": "object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4228 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4229 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4230 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4231 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4232 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4233 "sdk_name": "buffer",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4234 "sdk_type": "const_void_pointer_with_size"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4235 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4236 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4237 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4238 "sdk_name": "transferSyntax",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4239 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4240 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4241 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4242 "c_function": "OrthancPluginTranscodeDicomInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4243 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4244 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4245 "buffer": "The memory buffer containing the DICOM instance.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4246 "size": "The size of the memory buffer.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4247 "transferSyntax": "The transfer syntax UID for the transcoding."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4248 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4249 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4250 "This function parses a memory buffer that contains a DICOM file, then transcodes it to the given transfer syntax. The function returns a new pointer to a data structure that is managed by the Orthanc core."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4251 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4252 "return": "The newly allocated DICOM instance. It must be freed with OrthancPluginFreeDicomInstance().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4253 "summary": "Parse and transcode a DICOM instance."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4254 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4255 "return_sdk_class": "OrthancPluginDicomInstance",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4256 "return_sdk_type": "object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4257 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4258 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4259 "args": [],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4260 "c_function": "OrthancPluginGenerateRestApiAuthorizationToken",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4261 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4262 "args": {},
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4263 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4264 "This function generates a token that can be set in the HTTP header \"Authorization\" so as to grant full access to the REST API of Orthanc using an external HTTP client. Using this function avoids the need of adding a separate user in the \"RegisteredUsers\" configuration of Orthanc, which eases deployments.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4265 "This feature is notably useful in multiprocess scenarios, where a subprocess created by a plugin has no access to the \"OrthancPluginContext\", and thus cannot call \"OrthancPluginRestApi[Get\|Post\|Put\|Delete]()\".",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4266 "This situation is frequently encountered in Python plugins, where the \"multiprocessing\" package can be used to bypass the Global Interpreter Lock (GIL) and thus to improve performance and concurrency."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4267 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4268 "return": "The authorization token, or NULL value in the case of an error. This string must be freed by OrthancPluginFreeString().",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4269 "summary": "Generate a token to grant full access to the REST API of Orthanc"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4270 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4271 "return_sdk_type": "char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4272 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4273 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4274 "args": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4275 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4276 "name": "arg0",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4277 "sdk_name": "json",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4278 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4279 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4280 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4281 "name": "arg1",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4282 "sdk_class": "OrthancPluginImage",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4283 "sdk_name": "pixelData",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4284 "sdk_type": "const_object"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4285 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4286 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4287 "name": "arg2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4288 "sdk_enumeration": "OrthancPluginCreateDicomFlags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4289 "sdk_name": "flags",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4290 "sdk_type": "enumeration"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4291 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4292 {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4293 "name": "arg3",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4294 "sdk_name": "privateCreator",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4295 "sdk_type": "const char *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4296 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4297 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4298 "c_function": "OrthancPluginCreateDicom2",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4299 "documentation": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4300 "args": {
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4301 "flags": "Flags governing the output.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4302 "json": "The input JSON file.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4303 "pixelData": "The image. Can be NULL, if the pixel data is encoded inside the JSON with the data URI scheme.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4304 "privateCreator": "The private creator to be used for the private DICOM tags. Check out the global configuration option \"Dictionary\" of Orthanc.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4305 "target": "The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer()."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4306 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4307 "description": [
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4308 "This function takes as input a string containing a JSON file describing the content of a DICOM instance. As an output, it writes the corresponding DICOM instance to a newly allocated memory buffer. Additionally, an image to be encoded within the DICOM instance can also be provided.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4309 "Contrarily to the function OrthancPluginCreateDicom(), this function can be explicitly provided with a private creator."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4310 ],
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4311 "return": "0 if success, other value if error.",
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4312 "summary": "Create a DICOM instance from a JSON string and an image, with a private creator."
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4313 },
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4314 "return_sdk_type": "OrthancPluginMemoryBuffer *"
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4315 }
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4316 ]
8382c7dea471 created CodeAnalysis/GenerateOrthancSDK.py Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4317 }

Mercurial > hg > orthanc-python

annotate Resources/Orthanc/Sdk-1.10.0/CodeModel.json @ 194:0c5da632f34d java-code-model