def second_group(self) -> Group:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property SecondGroup() As Group
|
| Returns or sets the second group used by the computation.
|
| Example:
|
| The first example retrieves the second group of NewDistance
| Distance.
|
|
| Dim SecondGroup As Group
| Set SecondGroup = NewDistance.SecondGroup
|
|
|
|
|
| The second example sets the second group of NewDistance
| Distance.
|
|
| Dim SecondGroup As Group
| NewDistance.SecondGroup = SecondGroup
:return: Group
:rtype: Group
"""
return Group(self.distance.SecondGroup)
def add_from_sel(self) -> Group:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
| o Func AddFromSel() As Group
|
| Creates a Group containing all products in the selection and adds it to the
| Groups Collection.
|
| Returns:
| The created group
| Example:
|
| This example creates a new group containing all products in the
| selection
| in the TheGroups collection.
|
|
| Dim NewGroup As Group
| Set NewGroup = TheGroups.AddFromSel
:return: Group
:rtype: Group
"""
return Group(self.groups.AddFromSel())
def first_group(self) -> Group:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property FirstGroup() As Group
|
| Returns or sets the first group used by the computation.
|
| Example:
|
| The first example retrieves the first group of NewClash
| Clash.
|
|
| Dim FirstGroup As Group
| Set FirstGroup = NewClash.FirstGroup
|
|
|
|
|
| The second example sets the first group of NewClash
| Clash.
|
|
| Dim FirstGroup As Group
| NewClash.FirstGroup = FirstGroup
:return: Group
:rtype: Group
"""
return Group(self.clash.FirstGroup)
def add(self) -> Group:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
| o Func Add() As Group
|
| Creates an empty Group and adds it to the Groups
| Collection.
|
| Returns:
| The created group
| Example:
|
| This example creates a new group in the TheGroups
| collection.
|
|
| Dim NewGroup As Group
| Set NewGroup = TheGroups.Add
:return: Group
:rtype: Group
"""
return Group(self.groups.Add())
def group(self) -> Group:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Group() As Group
|
| Returns or sets the sectioned group.
|
| By default, it is the all leaves group.
|
| Example:
|
| The first example retrieves the group of NewSection
| Section.
|
| Dim AGroup As Group
| AGroup = NewSection.Group
|
| The second example sets the group of NewSection
| Section.
|
| Dim AGroup As Group
| NewSection.Group = AGroup
:return: Group
:rtype: Group
"""
return Group(self.section.Group)
def item(self, i_index: cat_variant) -> Group:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
| o Func Item(CATVariant iIndex) As Group
|
| Returns a group using its index or its name from the Groups
| collection.
|
| Parameters:
|
| iIndex
| The index or the name of the Group to retrieve from the collection
| of groups. As a numerics, this index is the rank of the Group in the
| collection. The index of the first Group in the collection is 1, and the index
| of the last Group is Count. As a string, it is the name you assigned to the
| Group.
|
| Returns:
| The retrieved Group
| Example:
|
| This example retrieves in ThisGroup the ninth
| Group,
| and in ThatGroup the Group named
| Group3 from the TheGroups collection.
|
|
| Dim ThisGroup As Group
| Set ThisGroup = TheGroups.Item(9)
| Dim ThatGroup As Group
| Set ThatGroup = TheGroups.Item("Group3")
:param cat_variant i_index:
:return: Group
:rtype: Group
"""
return Group(self.groups.Item(i_index))
def all_leaves(self) -> Group:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
| o Func AllLeaves() As Group
|
| Returns a group which contains all the terminal nodes of the current root
| product.
|
| Example:
|
| This example retrieves the group in the TheGroups
| collection.
|
|
| Dim AllLeavesGroup As Group
| Set AllLeavesGroup = TheGroups.AllLeaves
:return: Group
:rtype: Group
"""
return Group(self.groups.AllLeaves())
def __getitem__(self, n: int) -> Group:
if (n + 1) > self.count:
raise StopIteration
return Group(self.groups.item(n + 1))