three.MF.V3.Tasks.SplitGroup

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

class SplitGroup: View Source

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

* Split a scan group (ie. move its subgroups to its parent group).

Request example:

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

Response example:

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

class SplitGroup.Request: View Source

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

Client request for the SplitGroup task.

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

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

Index

Type

Input

class SplitGroup.Response: View Source

60    class Response:
61
62        """
63         Server response for the `SplitGroup` task.
64        """
65        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):
66            # The unique identifier generated by the client.
67            self.Index = Index
68            # "SplitGroup"
69            self.Type = Type
70            # The requested index of the group to split.
71            self.Input = Input
72            # The root scan group in the current open project.
73            self.Output = Output
74            # The current state of the task.
75            self.State = State
76            # A string describing the error if the task has failed.
77            self.Error = Error

Server response for the SplitGroup task.

SplitGroup.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

65        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):
66            # The unique identifier generated by the client.
67            self.Index = Index
68            # "SplitGroup"
69            self.Type = Type
70            # The requested index of the group to split.
71            self.Input = Input
72            # The root scan group in the current open project.
73            self.Output = Output
74            # The current state of the task.
75            self.State = State
76            # A string describing the error if the task has failed.
77            self.Error = Error

Index

Type

Input

Output

State

Error