three.MF.V3.Settings.CopyGroups

 1from typing import List
 2
 3
 4class CopyGroups:
 5
 6    """
 7     Copy scan groups settings.
 8    """
 9    def __init__(self, sourceIndexes: List[int] = None, targetIndex: int = None, childPosition: int = None, nameSuffix: str = None, enumerate: bool = None):
10        # The indexes of the groups to copy.
11        self.sourceIndexes = sourceIndexes
12        """
13        The index of the group into which the source groups are copied.
14        If unspecified the copied groups are inserted after their respective source groups within the same parent group.
15        """
16        self.targetIndex = targetIndex
17        """
18        The position among the target group's children where the copied groups are inserted.
19        If unspecified the copied groups are appended to the end of the target group's children.
20        Ignored if the targetIndex is unspecified or specified but does not exist.
21        """
22        self.childPosition = childPosition
23        """
24        Optional name suffix to append to the copied group names.
25        If unspecified the copied group names are unchanged.
26        """
27        self.nameSuffix = nameSuffix
28        """
29        Append a copy index the copied group names. e.g. ("name-2", "name-3").  Default is true.
30        If a name suffix is specified then the first copy of each source group is not enumerated,
31        but subsequent copies are.
32        """
33        self.enumerate = enumerate