three.MF.V3.Tasks.NewGroup

View Source

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

class NewGroup: View Source

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

* Create a new scan group.

Request example:

{
"Task":{
"Index":1,
"Type":"NewGroup",
"Input":{
"parentIndex":0,
"baseName":"Group"
}
}
}

Response example:

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

class NewGroup.Request: View Source

50    class Request:
51
52        """
53         Client request for the `NewGroup` task.
54        """
55        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_NewGroup_NewGroup = None):
56            # A unique identifier generated by the client.
57            self.Index = Index
58            # "NewGroup"
59            self.Type = Type
60            # The requested new group settings.
61            self.Input = Input

Client request for the NewGroup task.

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

55        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_NewGroup_NewGroup = None):
56            # A unique identifier generated by the client.
57            self.Index = Index
58            # "NewGroup"
59            self.Type = Type
60            # The requested new group settings.
61            self.Input = Input

Index

Type

Input

class NewGroup.Response: View Source

63    class Response:
64
65        """
66         Server response for the `NewGroup` task.
67        """
68        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, Input: MF_V3_Settings_NewGroup_NewGroup = None, State: MF_V3_Task_TaskState = None, Error: str = None):
69            # The unique identifier generated by the client.
70            self.Index = Index
71            # "NewGroup"
72            self.Type = Type
73            # The root scan group in the current open project.
74            self.Output = Output
75            # The requested new group settings.
76            self.Input = Input
77            # The current state of the task.
78            self.State = State
79            # A string describing the error if the task has failed.
80            self.Error = Error

Server response for the NewGroup task.

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

68        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, Input: MF_V3_Settings_NewGroup_NewGroup = None, State: MF_V3_Task_TaskState = None, Error: str = None):
69            # The unique identifier generated by the client.
70            self.Index = Index
71            # "NewGroup"
72            self.Type = Type
73            # The root scan group in the current open project.
74            self.Output = Output
75            # The requested new group settings.
76            self.Input = Input
77            # The current state of the task.
78            self.State = State
79            # A string describing the error if the task has failed.
80            self.Error = Error

Index

Type

Output

Input

State

Error