three.MF.V3.Tasks.ListGroups 

 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 ListGroups:
 6    """*
 7    List the scan groups in the current open project.
 8
 9    > Request example:
10
11    ```json
12    {
13    "Task":{
14    "Index":1,
15    "Type":"ListGroups"
16    }
17    }
18    ```
19
20    > Response example:
21
22    ```json
23    {
24    "Task":{
25    "Index":1,
26    "Type":"ListGroups",
27    "Output":{
28    "groups":[
29    {
30    "index":1,
31    "scan":1,
32    "name":"Scan-1",
33    "color":[0.75,0.5,0.2,1.0],
34    "rotation":[0.03,0.1,-0.01],
35    "translation":[-101,67,-561],
36    "visible":true
37    },
38    {
39    "index":2,
40    "scan":2,
41    "name":"Scan-2",
42    "color":[0.7,0.9,0.6,1.0],
43    "rotation":[0.1,0.2,0.5],
44    "translation":[-90,64,-553],
45    "visible":true
46    },
47    {
48    "index":3,
49    "scan":3,
50    "name":"Scan-3",
51    "color":[0.6,0.8,0.9,1.0],
52    "visible":true
53    }
54    ]
55    },
56    "State":"Completed"
57    }
58    }
59    ```
60    """
61    class Request:
62
63        """
64         Client request for the `ListGroups` task.
65        """
66        def __init__(self, Index: int, Type: str):
67            # A unique identifier generated by the client.
68            self.Index = Index
69            # "ListGroups"
70            self.Type = Type
71
72    class Response:
73
74        """
75         Server response for the `ListGroups` task.
76        """
77        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
78            # The unique identifier generated by the client.
79            self.Index = Index
80            # "ListGroups"
81            self.Type = Type
82            # The root scan group in the current open project.
83            self.Output = Output
84            # The current state of the task.
85            self.State = State
86            # A string describing the error if the task has failed.
87            self.Error = Error
88
89    def __init__(self):
90        pass
class ListGroups: 
 6class ListGroups:
 7    """*
 8    List the scan groups in the current open project.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"ListGroups"
17    }
18    }
19    ```
20
21    > Response example:
22
23    ```json
24    {
25    "Task":{
26    "Index":1,
27    "Type":"ListGroups",
28    "Output":{
29    "groups":[
30    {
31    "index":1,
32    "scan":1,
33    "name":"Scan-1",
34    "color":[0.75,0.5,0.2,1.0],
35    "rotation":[0.03,0.1,-0.01],
36    "translation":[-101,67,-561],
37    "visible":true
38    },
39    {
40    "index":2,
41    "scan":2,
42    "name":"Scan-2",
43    "color":[0.7,0.9,0.6,1.0],
44    "rotation":[0.1,0.2,0.5],
45    "translation":[-90,64,-553],
46    "visible":true
47    },
48    {
49    "index":3,
50    "scan":3,
51    "name":"Scan-3",
52    "color":[0.6,0.8,0.9,1.0],
53    "visible":true
54    }
55    ]
56    },
57    "State":"Completed"
58    }
59    }
60    ```
61    """
62    class Request:
63
64        """
65         Client request for the `ListGroups` task.
66        """
67        def __init__(self, Index: int, Type: str):
68            # A unique identifier generated by the client.
69            self.Index = Index
70            # "ListGroups"
71            self.Type = Type
72
73    class Response:
74
75        """
76         Server response for the `ListGroups` task.
77        """
78        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
79            # The unique identifier generated by the client.
80            self.Index = Index
81            # "ListGroups"
82            self.Type = Type
83            # The root scan group in the current open project.
84            self.Output = Output
85            # The current state of the task.
86            self.State = State
87            # A string describing the error if the task has failed.
88            self.Error = Error
89
90    def __init__(self):
91        pass

* List the scan groups in the current open project.

Request example:

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

Response example:

{
"Task":{
"Index":1,
"Type":"ListGroups",
"Output":{
"groups":[
{
"index":1,
"scan":1,
"name":"Scan-1",
"color":[0.75,0.5,0.2,1.0],
"rotation":[0.03,0.1,-0.01],
"translation":[-101,67,-561],
"visible":true
},
{
"index":2,
"scan":2,
"name":"Scan-2",
"color":[0.7,0.9,0.6,1.0],
"rotation":[0.1,0.2,0.5],
"translation":[-90,64,-553],
"visible":true
},
{
"index":3,
"scan":3,
"name":"Scan-3",
"color":[0.6,0.8,0.9,1.0],
"visible":true
}
]
},
"State":"Completed"
}
}
class ListGroups.Request: 
62    class Request:
63
64        """
65         Client request for the `ListGroups` task.
66        """
67        def __init__(self, Index: int, Type: str):
68            # A unique identifier generated by the client.
69            self.Index = Index
70            # "ListGroups"
71            self.Type = Type

Client request for the ListGroups task.

ListGroups.Request(Index: int, Type: str) 
67        def __init__(self, Index: int, Type: str):
68            # A unique identifier generated by the client.
69            self.Index = Index
70            # "ListGroups"
71            self.Type = Type
Index
Type
class ListGroups.Response: 
73    class Response:
74
75        """
76         Server response for the `ListGroups` task.
77        """
78        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
79            # The unique identifier generated by the client.
80            self.Index = Index
81            # "ListGroups"
82            self.Type = Type
83            # The root scan group in the current open project.
84            self.Output = Output
85            # The current state of the task.
86            self.State = State
87            # A string describing the error if the task has failed.
88            self.Error = Error

Server response for the ListGroups task.

ListGroups.Response( Index: int, Type: str, Output: MF.V3.Descriptors.Project.Project.Group, State: MF.V3.Task.TaskState = None, Error: str = None) 
78        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
79            # The unique identifier generated by the client.
80            self.Index = Index
81            # "ListGroups"
82            self.Type = Type
83            # The root scan group in the current open project.
84            self.Output = Output
85            # The current state of the task.
86            self.State = State
87            # A string describing the error if the task has failed.
88            self.Error = Error
Index
Type
Output
State
Error