three.MF.V3.Tasks.FlattenGroup

View Source

 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 FlattenGroup:
 6    """*
 7    Flatten a scan group such that it only consists of single scans.
 8
 9    > Request example:
10
11    ```json
12    {
13    "Task":{
14    "Index":1,
15    "Type":"FlattenGroup",
16    "Input":0
17    }
18    }
19    ```
20
21    > Response example:
22
23    ```json
24    {
25    "Task":{
26    "Index":1,
27    "Type":"FlattenGroup",
28    "Input":0,
29    "Output":{
30    "groups":[{
31    "index":2,
32    "name":"Group 2",
33    "groups":[{
34    "index":1,
35    "name":"Group 1"
36    }]
37    }],
38    },
39    "State":"Completed"
40    }
41    }
42    ```
43    """
44    class Request:
45
46        """
47         Client request for the `FlattenGroup` task.
48        """
49        def __init__(self, Index: int, Type: str, Input: int):
50            # A unique identifier generated by the client.
51            self.Index = Index
52            # "FlattenGroup"
53            self.Type = Type
54            # The index of the group to flatten.
55            self.Input = Input
56
57    class Response:
58
59        """
60         Server response for the `FlattenGroup` task.
61        """
62        def __init__(self, Index: int, Type: str, Input: int, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
63            # The unique identifier generated by the client.
64            self.Index = Index
65            # "FlattenGroup"
66            self.Type = Type
67            # The requested index of the group to flatten.
68            self.Input = Input
69            # The root scan group in the current open project.
70            self.Output = Output
71            # The current state of the task.
72            self.State = State
73            # A string describing the error if the task has failed.
74            self.Error = Error
75
76    def __init__(self):
77        pass

class FlattenGroup: View Source

 6class FlattenGroup:
 7    """*
 8    Flatten a scan group such that it only consists of single scans.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"FlattenGroup",
17    "Input":0
18    }
19    }
20    ```
21
22    > Response example:
23
24    ```json
25    {
26    "Task":{
27    "Index":1,
28    "Type":"FlattenGroup",
29    "Input":0,
30    "Output":{
31    "groups":[{
32    "index":2,
33    "name":"Group 2",
34    "groups":[{
35    "index":1,
36    "name":"Group 1"
37    }]
38    }],
39    },
40    "State":"Completed"
41    }
42    }
43    ```
44    """
45    class Request:
46
47        """
48         Client request for the `FlattenGroup` task.
49        """
50        def __init__(self, Index: int, Type: str, Input: int):
51            # A unique identifier generated by the client.
52            self.Index = Index
53            # "FlattenGroup"
54            self.Type = Type
55            # The index of the group to flatten.
56            self.Input = Input
57
58    class Response:
59
60        """
61         Server response for the `FlattenGroup` task.
62        """
63        def __init__(self, Index: int, Type: str, Input: int, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
64            # The unique identifier generated by the client.
65            self.Index = Index
66            # "FlattenGroup"
67            self.Type = Type
68            # The requested index of the group to flatten.
69            self.Input = Input
70            # The root scan group in the current open project.
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
77    def __init__(self):
78        pass

* Flatten a scan group such that it only consists of single scans.

Request example:

{
"Task":{
"Index":1,
"Type":"FlattenGroup",
"Input":0
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"FlattenGroup",
"Input":0,
"Output":{
"groups":[{
"index":2,
"name":"Group 2",
"groups":[{
"index":1,
"name":"Group 1"
}]
}],
},
"State":"Completed"
}
}

class FlattenGroup.Request: View Source

45    class Request:
46
47        """
48         Client request for the `FlattenGroup` task.
49        """
50        def __init__(self, Index: int, Type: str, Input: int):
51            # A unique identifier generated by the client.
52            self.Index = Index
53            # "FlattenGroup"
54            self.Type = Type
55            # The index of the group to flatten.
56            self.Input = Input

Client request for the FlattenGroup task.

FlattenGroup.Request(Index: int, Type: str, Input: int) View Source

50        def __init__(self, Index: int, Type: str, Input: int):
51            # A unique identifier generated by the client.
52            self.Index = Index
53            # "FlattenGroup"
54            self.Type = Type
55            # The index of the group to flatten.
56            self.Input = Input

Index

Type

Input

class FlattenGroup.Response: View Source

58    class Response:
59
60        """
61         Server response for the `FlattenGroup` task.
62        """
63        def __init__(self, Index: int, Type: str, Input: int, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
64            # The unique identifier generated by the client.
65            self.Index = Index
66            # "FlattenGroup"
67            self.Type = Type
68            # The requested index of the group to flatten.
69            self.Input = Input
70            # The root scan group in the current open project.
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

Server response for the FlattenGroup task.

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

63        def __init__(self, Index: int, Type: str, Input: int, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
64            # The unique identifier generated by the client.
65            self.Index = Index
66            # "FlattenGroup"
67            self.Type = Type
68            # The requested index of the group to flatten.
69            self.Input = Input
70            # The root scan group in the current open project.
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

Index

Type

Input

Output

State

Error