three.MF.V3.Tasks.SetProject

View Source

 1from MF.V3.Descriptors.Project import Project as MF_V3_Descriptors_Project_Project
 2from MF.V3.Settings.Project import Project as MF_V3_Settings_Project_Project
 3from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 4
 5
 6class SetProject:
 7    """*
 8    Apply settings to the current open project.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"SetProject",
17    "Input":{
18    "name":"My Project"
19    },
20    }
21    }
22    ```
23
24    > Response example:
25
26    ```json
27    {
28    "Task":{
29    "Index":1,
30    "Type":"SetProject",
31    "Input":{
32    "name":"My Project"
33    },
34    "Output":{
35    "index":5,
36    "name":"My Project",
37    "groups":[{
38    "color":[0.8,0.5,0.6,1.0],
39    "index":1,
40    "name":"Scan-1",
41    "scan":1,
42    "rotation":[0.2,0.8,-0.1],
43    "translation":[-275,-32,-134],
44    "visible":true
45    }],
46    }
47    "State":"Completed"
48    }
49    }
50    ```
51    """
52    class Request:
53
54        """
55         Client request for the `SetProject` task.
56        """
57        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None):
58            # A unique identifier generated by the client.
59            self.Index = Index
60            # "SetProject"
61            self.Type = Type
62            # Project settings.
63            self.Input = Input
64
65    class Response:
66
67        """
68         Server response for the `SetProject` task.
69        """
70        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None, Output: MF_V3_Descriptors_Project_Project = None, State: MF_V3_Task_TaskState = None, Error: str = None):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "SetProject"
74            self.Type = Type
75            # Requested project settings.
76            self.Input = Input
77            # Actual project settings after applying the requested settings.
78            self.Output = Output
79            # The current state of the task.
80            self.State = State
81            # A string describing the error if the task has failed.
82            self.Error = Error
83
84    def __init__(self):
85        pass

class SetProject: View Source

 7class SetProject:
 8    """*
 9    Apply settings to the current open project.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"SetProject",
18    "Input":{
19    "name":"My Project"
20    },
21    }
22    }
23    ```
24
25    > Response example:
26
27    ```json
28    {
29    "Task":{
30    "Index":1,
31    "Type":"SetProject",
32    "Input":{
33    "name":"My Project"
34    },
35    "Output":{
36    "index":5,
37    "name":"My Project",
38    "groups":[{
39    "color":[0.8,0.5,0.6,1.0],
40    "index":1,
41    "name":"Scan-1",
42    "scan":1,
43    "rotation":[0.2,0.8,-0.1],
44    "translation":[-275,-32,-134],
45    "visible":true
46    }],
47    }
48    "State":"Completed"
49    }
50    }
51    ```
52    """
53    class Request:
54
55        """
56         Client request for the `SetProject` task.
57        """
58        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None):
59            # A unique identifier generated by the client.
60            self.Index = Index
61            # "SetProject"
62            self.Type = Type
63            # Project settings.
64            self.Input = Input
65
66    class Response:
67
68        """
69         Server response for the `SetProject` task.
70        """
71        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None, Output: MF_V3_Descriptors_Project_Project = None, State: MF_V3_Task_TaskState = None, Error: str = None):
72            # The unique identifier generated by the client.
73            self.Index = Index
74            # "SetProject"
75            self.Type = Type
76            # Requested project settings.
77            self.Input = Input
78            # Actual project settings after applying the requested settings.
79            self.Output = Output
80            # The current state of the task.
81            self.State = State
82            # A string describing the error if the task has failed.
83            self.Error = Error
84
85    def __init__(self):
86        pass

* Apply settings to the current open project.

Request example:

{
"Task":{
"Index":1,
"Type":"SetProject",
"Input":{
"name":"My Project"
},
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"SetProject",
"Input":{
"name":"My Project"
},
"Output":{
"index":5,
"name":"My Project",
"groups":[{
"color":[0.8,0.5,0.6,1.0],
"index":1,
"name":"Scan-1",
"scan":1,
"rotation":[0.2,0.8,-0.1],
"translation":[-275,-32,-134],
"visible":true
}],
}
"State":"Completed"
}
}

class SetProject.Request: View Source

53    class Request:
54
55        """
56         Client request for the `SetProject` task.
57        """
58        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None):
59            # A unique identifier generated by the client.
60            self.Index = Index
61            # "SetProject"
62            self.Type = Type
63            # Project settings.
64            self.Input = Input

Client request for the SetProject task.

SetProject.Request(Index: int, Type: str, Input: MF.V3.Settings.Project.Project = None) View Source

58        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None):
59            # A unique identifier generated by the client.
60            self.Index = Index
61            # "SetProject"
62            self.Type = Type
63            # Project settings.
64            self.Input = Input

Index

Type

Input

class SetProject.Response: View Source

66    class Response:
67
68        """
69         Server response for the `SetProject` task.
70        """
71        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None, Output: MF_V3_Descriptors_Project_Project = None, State: MF_V3_Task_TaskState = None, Error: str = None):
72            # The unique identifier generated by the client.
73            self.Index = Index
74            # "SetProject"
75            self.Type = Type
76            # Requested project settings.
77            self.Input = Input
78            # Actual project settings after applying the requested settings.
79            self.Output = Output
80            # The current state of the task.
81            self.State = State
82            # A string describing the error if the task has failed.
83            self.Error = Error

Server response for the SetProject task.

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

71        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None, Output: MF_V3_Descriptors_Project_Project = None, State: MF_V3_Task_TaskState = None, Error: str = None):
72            # The unique identifier generated by the client.
73            self.Index = Index
74            # "SetProject"
75            self.Type = Type
76            # Requested project settings.
77            self.Input = Input
78            # Actual project settings after applying the requested settings.
79            self.Output = Output
80            # The current state of the task.
81            self.State = State
82            # A string describing the error if the task has failed.
83            self.Error = Error

Index

Type

Input

Output

State

Error