three.MF.V3.Task

 1from enum import Enum
 2from google.protobuf import any_pb2 as _any_pb2
 3
 4
 5class TaskState(Enum):
 6    Empty = "None"  # The task state is not defined.
 7    Sent = "Sent"  # The task has been sent by the client.
 8    Received = "Received"  # The task has been received by the server.
 9    Started = "Started"  # The task started by the server.
10    Completed = "Completed"  # The task is completed by the server.
11    Cancelled = "Cancelled"  # The task has been cancelled by the client.
12    Failed = "Failed"  # The task has failed.  A string describing the error is returned with the task.
13    Dropped = "Dropped"  # The task has not been received by the server, or task IDs were sent out of sequence.
14    Disconnected = "Disconnected"  # The client has been disconnected from the server before the task could finish.
15
16
17class Task:
18    """*
19    Generic task message for the Three Scanner.
20
21    The task message is the generic message used for requesting a task of the Three Scanner and receiving updates and results.
22
23    Example: Apply camera settings with the "SetCameras" task.
24
25    > Example request:
26
27    ```json
28    {
29    "Task":{
30    "Index":1,
31    "Type":"SetCameras"
32    "Input":{
33    "analogGain":256,
34    "digitalGain":128,
35    "exposure":18000
36    },
37    }
38    }
39    ```
40
41    > Example response:
42
43    ```json
44    {
45    "Task":{
46    "Index":1,
47    "Type":"SetCameras"
48    "Input":{
49    "analogGain":256,
50    "digitalGain":512,
51    "exposure":18000
52    },
53    "Output":{
54    "analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
55    "digitalGain":{"default":256,"max":65536,"min":256,"value":512},
56    "exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
57    },
58    "State":"Completed"
59    }
60    }
61    ```
62    """
63    def __init__(self, Index: int, Type: str, Input: _any_pb2 = None, Output: _any_pb2 = None, State: 'TaskState' = None, Error: str = None, Progress: _any_pb2 = None):
64        # A unique identifier generated by the client.  This identifier associates all incoming and outgoing task messages with a specific task requested by the client.
65        self.Index = Index
66        # The string identifying the task type. See task definitions for the list of valid task strings.
67        self.Type = Type
68        # Optional input message.  See each task definition for details.
69        self.Input = Input
70        # Optional output message.  See each task definition for details.
71        self.Output = Output
72        # The current state of the task.
73        self.State = State
74        # A string describing the error if the task has failed.
75        self.Error = Error
76        # A Progress object for tasks that give updates on long running tasks
77        self.Progress = Progress