three.MF.V3.Tasks.PopSettings

View Source

 1from MF.V3.Descriptors.Settings.Scanner import Scanner as MF_V3_Descriptors_Settings_Scanner_Scanner
 2from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 3
 4
 5class PopSettings:
 6    """*
 7    Pop and restore scanner settings from the stack and optionally apply the popped settings.
 8
 9    > Request example:
10
11    ```json
12    {
13    "Task":{
14    "Index":1,
15    "Type":"PopSettings",
16    "Input":true
17    }
18    }
19    ```
20
21    > Response example:
22
23    ```json
24    {
25    "Task":{
26    "Index":1,
27    "Type":"PopSettings",
28    "Input":true,
29    "Output":{
30    "camera":{
31    "analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
32    "autoExposure":{"default":false,"value":false},
33    "digitalGain":{"default":256,"max":65536,"min":256,"value":320},
34    "exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
35    },
36    "projector":{
37    "brightness":{"default":0.5,"max":1.0,"min":0.0,"value":0.800000011920929},
38    "on":{"default":false,"value":true}
39    },
40    "turntable":{
41    "scans":{"default":8,"max":24,"min":1,"value":3},
42    "sweep":{"default":360,"max":360,"min":5,"value":90},
43    "use":{"default":true,"value":true}
44    },
45    "capture":{
46    "quality":{"default":"Medium","value":"Medium"},
47    "texture":{"default":true,"value":true}
48    },
49    "i18n":{
50    "language":{"default":"en","value":"en"}
51    },
52    "style":{
53    "theme":{"default":"Dark","value":"Dark"}
54    },
55    "viewer":{
56    "textureOpacity":{"default":0.5,"max":1.0,"min":0.0,"value":1.0}
57    }
58    },
59    "State":"Completed"
60    }
61    }
62    ```
63    """
64    class Request:
65
66        """
67         Client request for the `PopSettings` task.
68        """
69        def __init__(self, Index: int, Type: str, Input: bool = None):
70            # A unique identifier generated by the client.
71            self.Index = Index
72            # "PopSettings"
73            self.Type = Type
74            # Apply the popped settings. If unspecified popped settings are not applied.
75            self.Input = Input
76
77    class Response:
78
79        """
80         Server response for the `PopSettings` task.
81        """
82        def __init__(self, Index: int, Type: str, Input: bool = None, Output: MF_V3_Descriptors_Settings_Scanner_Scanner = None, State: MF_V3_Task_TaskState = None, Error: str = None):
83            # The unique identifier generated by the client.
84            self.Index = Index
85            # "PopSettings"
86            self.Type = Type
87            # Request to apply the popped settings.
88            self.Input = Input
89            # The scanner settings descriptor.
90            self.Output = Output
91            # The current state of the task.
92            self.State = State
93            # A string describing the error if the task has failed.
94            self.Error = Error
95
96    def __init__(self):
97        pass

class PopSettings: View Source

 6class PopSettings:
 7    """*
 8    Pop and restore scanner settings from the stack and optionally apply the popped settings.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"PopSettings",
17    "Input":true
18    }
19    }
20    ```
21
22    > Response example:
23
24    ```json
25    {
26    "Task":{
27    "Index":1,
28    "Type":"PopSettings",
29    "Input":true,
30    "Output":{
31    "camera":{
32    "analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
33    "autoExposure":{"default":false,"value":false},
34    "digitalGain":{"default":256,"max":65536,"min":256,"value":320},
35    "exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
36    },
37    "projector":{
38    "brightness":{"default":0.5,"max":1.0,"min":0.0,"value":0.800000011920929},
39    "on":{"default":false,"value":true}
40    },
41    "turntable":{
42    "scans":{"default":8,"max":24,"min":1,"value":3},
43    "sweep":{"default":360,"max":360,"min":5,"value":90},
44    "use":{"default":true,"value":true}
45    },
46    "capture":{
47    "quality":{"default":"Medium","value":"Medium"},
48    "texture":{"default":true,"value":true}
49    },
50    "i18n":{
51    "language":{"default":"en","value":"en"}
52    },
53    "style":{
54    "theme":{"default":"Dark","value":"Dark"}
55    },
56    "viewer":{
57    "textureOpacity":{"default":0.5,"max":1.0,"min":0.0,"value":1.0}
58    }
59    },
60    "State":"Completed"
61    }
62    }
63    ```
64    """
65    class Request:
66
67        """
68         Client request for the `PopSettings` task.
69        """
70        def __init__(self, Index: int, Type: str, Input: bool = None):
71            # A unique identifier generated by the client.
72            self.Index = Index
73            # "PopSettings"
74            self.Type = Type
75            # Apply the popped settings. If unspecified popped settings are not applied.
76            self.Input = Input
77
78    class Response:
79
80        """
81         Server response for the `PopSettings` task.
82        """
83        def __init__(self, Index: int, Type: str, Input: bool = None, Output: MF_V3_Descriptors_Settings_Scanner_Scanner = None, State: MF_V3_Task_TaskState = None, Error: str = None):
84            # The unique identifier generated by the client.
85            self.Index = Index
86            # "PopSettings"
87            self.Type = Type
88            # Request to apply the popped settings.
89            self.Input = Input
90            # The scanner settings descriptor.
91            self.Output = Output
92            # The current state of the task.
93            self.State = State
94            # A string describing the error if the task has failed.
95            self.Error = Error
96
97    def __init__(self):
98        pass

* Pop and restore scanner settings from the stack and optionally apply the popped settings.

Request example:

{
"Task":{
"Index":1,
"Type":"PopSettings",
"Input":true
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"PopSettings",
"Input":true,
"Output":{
"camera":{
"analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
"autoExposure":{"default":false,"value":false},
"digitalGain":{"default":256,"max":65536,"min":256,"value":320},
"exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
},
"projector":{
"brightness":{"default":0.5,"max":1.0,"min":0.0,"value":0.800000011920929},
"on":{"default":false,"value":true}
},
"turntable":{
"scans":{"default":8,"max":24,"min":1,"value":3},
"sweep":{"default":360,"max":360,"min":5,"value":90},
"use":{"default":true,"value":true}
},
"capture":{
"quality":{"default":"Medium","value":"Medium"},
"texture":{"default":true,"value":true}
},
"i18n":{
"language":{"default":"en","value":"en"}
},
"style":{
"theme":{"default":"Dark","value":"Dark"}
},
"viewer":{
"textureOpacity":{"default":0.5,"max":1.0,"min":0.0,"value":1.0}
}
},
"State":"Completed"
}
}

class PopSettings.Request: View Source

65    class Request:
66
67        """
68         Client request for the `PopSettings` task.
69        """
70        def __init__(self, Index: int, Type: str, Input: bool = None):
71            # A unique identifier generated by the client.
72            self.Index = Index
73            # "PopSettings"
74            self.Type = Type
75            # Apply the popped settings. If unspecified popped settings are not applied.
76            self.Input = Input

Client request for the PopSettings task.

PopSettings.Request(Index: int, Type: str, Input: bool = None) View Source

70        def __init__(self, Index: int, Type: str, Input: bool = None):
71            # A unique identifier generated by the client.
72            self.Index = Index
73            # "PopSettings"
74            self.Type = Type
75            # Apply the popped settings. If unspecified popped settings are not applied.
76            self.Input = Input

Index

Type

Input

class PopSettings.Response: View Source

78    class Response:
79
80        """
81         Server response for the `PopSettings` task.
82        """
83        def __init__(self, Index: int, Type: str, Input: bool = None, Output: MF_V3_Descriptors_Settings_Scanner_Scanner = None, State: MF_V3_Task_TaskState = None, Error: str = None):
84            # The unique identifier generated by the client.
85            self.Index = Index
86            # "PopSettings"
87            self.Type = Type
88            # Request to apply the popped settings.
89            self.Input = Input
90            # The scanner settings descriptor.
91            self.Output = Output
92            # The current state of the task.
93            self.State = State
94            # A string describing the error if the task has failed.
95            self.Error = Error

Server response for the PopSettings task.

PopSettings.Response( Index: int, Type: str, Input: bool = None, Output: MF.V3.Descriptors.Settings.Scanner.Scanner = None, State: MF.V3.Task.TaskState = None, Error: str = None) View Source

83        def __init__(self, Index: int, Type: str, Input: bool = None, Output: MF_V3_Descriptors_Settings_Scanner_Scanner = None, State: MF_V3_Task_TaskState = None, Error: str = None):
84            # The unique identifier generated by the client.
85            self.Index = Index
86            # "PopSettings"
87            self.Type = Type
88            # Request to apply the popped settings.
89            self.Input = Input
90            # The scanner settings descriptor.
91            self.Output = Output
92            # The current state of the task.
93            self.State = State
94            # A string describing the error if the task has failed.
95            self.Error = Error

Index

Type

Input

Output

State

Error