three.MF.V3.Tasks.AddMergeToProject 

 1from MF.V3.Descriptors.Project import Project as MF_V3_Descriptors_Project_Project
 2from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 3
 4
 5class AddMergeToProject:
 6    """*
 7    Add a merged scan to the current project.
 8
 9    > Request example:
10
11    ```json
12    {
13    "Task":{
14    "Index":1,
15    "Type":"AddMergeToProject"
16    }
17    }
18    ```
19
20    > Response example:
21
22    ```json
23    {
24    "Task":{
25    "Index":1,
26    "Type":"AddMergeToProject",
27    "Output":{
28    "groups":[
29    {
30    "index":1,
31    "name":"Scan-1",
32    "scan": 1,
33    "color":[0.5, 0.8, 0.3]
34    }
35    ]
36    },
37    "State":"Completed"
38    }
39    }
40    ```
41    """
42    class Request:
43
44        """
45         Client request for the `AddMergeToProject` task.
46        """
47        def __init__(self, Index: int, Type: str):
48            # A unique identifier generated by the client.
49            self.Index = Index
50            # "AddMergeToProject"
51            self.Type = Type
52
53    class Response:
54
55        """
56         Server response for the `AddMergeToProject` task.
57        """
58        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
59            # The unique identifier generated by the client.
60            self.Index = Index
61            # "AddMergeToProject"
62            self.Type = Type
63            # The root scan group in the current open project.
64            self.Output = Output
65            # The current state of the task.
66            self.State = State
67            # A string describing the error if the task has failed.
68            self.Error = Error
69
70    def __init__(self):
71        pass
class AddMergeToProject: 
 6class AddMergeToProject:
 7    """*
 8    Add a merged scan to the current project.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"AddMergeToProject"
17    }
18    }
19    ```
20
21    > Response example:
22
23    ```json
24    {
25    "Task":{
26    "Index":1,
27    "Type":"AddMergeToProject",
28    "Output":{
29    "groups":[
30    {
31    "index":1,
32    "name":"Scan-1",
33    "scan": 1,
34    "color":[0.5, 0.8, 0.3]
35    }
36    ]
37    },
38    "State":"Completed"
39    }
40    }
41    ```
42    """
43    class Request:
44
45        """
46         Client request for the `AddMergeToProject` task.
47        """
48        def __init__(self, Index: int, Type: str):
49            # A unique identifier generated by the client.
50            self.Index = Index
51            # "AddMergeToProject"
52            self.Type = Type
53
54    class Response:
55
56        """
57         Server response for the `AddMergeToProject` task.
58        """
59        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
60            # The unique identifier generated by the client.
61            self.Index = Index
62            # "AddMergeToProject"
63            self.Type = Type
64            # The root scan group in the current open project.
65            self.Output = Output
66            # The current state of the task.
67            self.State = State
68            # A string describing the error if the task has failed.
69            self.Error = Error
70
71    def __init__(self):
72        pass

* Add a merged scan to the current project.

Request example:

{
"Task":{
"Index":1,
"Type":"AddMergeToProject"
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"AddMergeToProject",
"Output":{
"groups":[
{
"index":1,
"name":"Scan-1",
"scan": 1,
"color":[0.5, 0.8, 0.3]
}
]
},
"State":"Completed"
}
}
class AddMergeToProject.Request: 
43    class Request:
44
45        """
46         Client request for the `AddMergeToProject` task.
47        """
48        def __init__(self, Index: int, Type: str):
49            # A unique identifier generated by the client.
50            self.Index = Index
51            # "AddMergeToProject"
52            self.Type = Type

Client request for the AddMergeToProject task.

AddMergeToProject.Request(Index: int, Type: str) 
48        def __init__(self, Index: int, Type: str):
49            # A unique identifier generated by the client.
50            self.Index = Index
51            # "AddMergeToProject"
52            self.Type = Type
Index
Type
class AddMergeToProject.Response: 
54    class Response:
55
56        """
57         Server response for the `AddMergeToProject` task.
58        """
59        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
60            # The unique identifier generated by the client.
61            self.Index = Index
62            # "AddMergeToProject"
63            self.Type = Type
64            # The root scan group in the current open project.
65            self.Output = Output
66            # The current state of the task.
67            self.State = State
68            # A string describing the error if the task has failed.
69            self.Error = Error

Server response for the AddMergeToProject task.

AddMergeToProject.Response( Index: int, Type: str, Output: MF.V3.Descriptors.Project.Project.Group, State: MF.V3.Task.TaskState = None, Error: str = None) 
59        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
60            # The unique identifier generated by the client.
61            self.Index = Index
62            # "AddMergeToProject"
63            self.Type = Type
64            # The root scan group in the current open project.
65            self.Output = Output
66            # The current state of the task.
67            self.State = State
68            # A string describing the error if the task has failed.
69            self.Error = Error
Index
Type
Output
State
Error