orthanc-python: Sources/Autogenerated/orthanc.pyi comparison

comparison Sources/Autogenerated/orthanc.pyi @ 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	66cd20e970d8
children	d7a6e75558ee

comparison

equal deleted inserted replaced

-:66cd20e970d8
+:0c5da632f34d
 """
 ...
 class DicomInstance:
+"""
+DICOM instance managed by the Orthanc core
+"""
 ...
 # This function returns the Application Entity Title (AET) of the DICOM modality from which a DICOM instance originates
 def GetInstanceRemoteAet(self) -> str:
 """
 Returns:
 bytes: The DICOM data.
 """
 ...
 class DicomWebNode:
+"""
+Node visited by DICOMweb conversion
+"""
 ...
 class FindAnswers:
+"""
+Answers to a DICOM C-FIND query
+"""
 ...
 # 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
 def FindAddAnswer(self, dicom: bytes) -> None:
 """
 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.
 """
 ...
 class FindMatcher:
+"""
+Matcher for DICOM C-FIND query
+"""
 ...
 # This function checks whether one DICOM instance matches C-Find matcher that was previously allocated using OrthancPluginCreateFindMatcher()
 def FindMatcherIsMatch(self, dicom: bytes) -> int:
 """
 int: 1 if the DICOM instance matches the query, 0 otherwise.
 """
 ...
 class FindQuery:
+"""
+DICOM C-FIND query
+"""
 ...
 # This function returns the number of tags that are contained in the given C-Find query
 def GetFindQuerySize(self) -> int:
 """
 Returns:
 int: The value of the group.
 """
 ...
 class Image:
+"""
+2D image managed by the Orthanc core
+"""
 ...
 # This function returns the type of memory layout for the pixels of the given image
 def GetImagePixelFormat(self) -> PixelFormat:
 """
 Returns:
 bytes: The pixel data.
 """
 ...
 class Job:
+"""
+Orthanc job
+"""
 ...
 # This function adds the given job to the pending jobs of Orthanc
 def SubmitJob(self, priority: int) -> str:
 """
 str: ID of the newly-submitted job. This string must be freed by OrthancPluginFreeString().
 """
 ...
 class Peers:
+"""
+Orthanc peer
+"""
 ...
 # This function returns the number of Orthanc peers
 def GetPeersCount(self) -> int:
 """
 str: The value of the user property, or NULL if it is not defined.
 """
 ...
 class RestOutput:
+"""
+Output for a call to the REST API of Orthanc
+"""
 ...
 # This function answers to a REST request with the content of a memory buffer
 def AnswerBuffer(self, answer: bytes, mime_type: str) -> None:
 """
 log (int): Whether to also write the detailed error to the Orthanc logs.
 """
 ...
 class ServerChunkedRequestReader:
+"""
+Read for a chunked HTTP request
+"""
 ...
 class StorageArea:
+"""
+Storage area plugin
+"""
 ...
 # This function creates a new file inside the storage area that is currently used by Orthanc
 def StorageAreaCreate(self, uuid: str, content: bytes, size: int, type: ContentType) -> None:
 """
 level (ResourceType): The type of the resources of interest.
 """
 ...
 class WorklistAnswers:
+"""
+Answers to a DICOM C-FIND worklist query
+"""
 ...
 # 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
 def WorklistAddAnswer(self, query: WorklistQuery, dicom: bytes) -> None:
 """
 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.
 """
 ...
 class WorklistQuery:
+"""
+DICOM C-FIND worklist query
+"""
 ...
 # This function checks whether one worklist (encoded as a DICOM file) matches the C-Find SCP query against modality worklists
 def WorklistIsMatch(self, dicom: bytes) -> int:
 """

Mercurial > hg > orthanc-python

comparison Sources/Autogenerated/orthanc.pyi @ 194:0c5da632f34d java-code-model