# class GeometryDataCollection

GeometryDataCollection holds a number of GeometryData objects. The objects can be looked up by their names (if they have been named with a call to SetName).

See also: ObjectCollection

# Methods

Method Description
AddGeometryData Adds a GeometryData object to the collection. The handle refers to the GeometryData until it is removed from the collection again. If the GeometryData and the pre-existing collection shares a field name they have to be of the same type and tuple size.
AddObject Adds an object to the collection. The handle refers to the object until the object is removed from the collection again.
AddObjectSorted Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name.
FindGeometryData Finds a named object.
FindObject Finds a named object in the collection. The first object with this name is returned. The search is case-sensitive.
GetClass Get the name of the GeometryDataCollection class.
GetFirstItem Returns the start of the collection. The handle returned refers to the first object in the collection. If the handle is null, then the collection is empty.
GetGeometryData The object the handle is referring to.
GetItem Returns the handle of the i:th item.
GetItemAsObject Returns the object of the i:th item.
GetItemCount The number of items in the collection.
GetItemsObject The object the handle is referring to.
GetNextItem Returns the handle to the next item in the collection. Use GetFirstItem and this method to step through the collection. If the return is null, the end of the collection has been reached.
GetNextItemAsGeometryData Returns the object of the next item.
IsA Returns true if GeometryDataCollection is a or is a descendant of the class named as the type parameter.
IsGeometryDataInCollection Returns true if the object is in the collection.
IsItemInCollection Returns true if the item is in the collection.
IsNull Returns true if the GeometryDataCollection object is invalid.
IsObjectInCollection Returns true if the object is in the collection.
RemoveAllItems Removes all items from the collection.
RemoveGeometryData Removes an object from the collection. Only the first occurrence of the object is removed.
RemoveItem Removes an item from the collection. The handle returned is the first item after this item that is in the collection. If the return is null, the item was the last item in the collection. Warning! The handle is invalid after the removal of the object.
RemoveObject Removes an object from the collection. Only the first occurance of the object is removed from the collection.

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spGeometryDataCollection, and if this is the case, returns the object cast into spGeometryDataCollection.

# Methods details

# AddGeometryData

Adds a GeometryData object to the collection. The handle refers to the GeometryData until it is removed from the collection again. If the GeometryData and the pre-existing collection shares a field name they have to be of the same type and tuple size.

    # AddObject

    Adds an object to the collection. The handle refers to the object until the object is removed from the collection again.

      # AddObjectSorted

      Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name.

        # FindGeometryData

        Finds a named object.

          # FindObject

          Finds a named object in the collection. The first object with this name is returned. The search is case-sensitive.

            # GetClass

            Get the name of the GeometryDataCollection class.

              # GetFirstItem

              Returns the start of the collection. The handle returned refers to the first object in the collection. If the handle is null, then the collection is empty.

                # GetGeometryData

                The object the handle is referring to.

                  # GetItem

                  Returns the handle of the i:th item.

                    # GetItemAsObject

                    Returns the object of the i:th item.

                      # GetItemCount

                      The number of items in the collection.

                        # GetItemsObject

                        The object the handle is referring to.

                          # GetNextItem

                          Returns the handle to the next item in the collection. Use GetFirstItem and this method to step through the collection. If the return is null, the end of the collection has been reached.

                            # GetNextItemAsGeometryData

                            Returns the object of the next item.

                              # IsA

                              Returns true if GeometryDataCollection is a or is a descendant of the class named as the type parameter.

                                # IsGeometryDataInCollection

                                Returns true if the object is in the collection.

                                  # IsItemInCollection

                                  Returns true if the item is in the collection.

                                    # IsNull

                                    Returns true if the GeometryDataCollection object is invalid.

                                      # IsObjectInCollection

                                      Returns true if the object is in the collection.

                                        # RemoveAllItems

                                        Removes all items from the collection.

                                          # RemoveGeometryData

                                          Removes an object from the collection. Only the first occurrence of the object is removed.

                                            # RemoveItem

                                            Removes an item from the collection. The handle returned is the first item after this item that is in the collection. If the return is null, the item was the last item in the collection. Warning! The handle is invalid after the removal of the object.

                                              # RemoveObject

                                              Removes an object from the collection. Only the first occurance of the object is removed from the collection.

                                                # Static methods details

                                                # IsClassA

                                                Returns true if the class is a or is a descendant of the class named as the type parameter.

                                                  # SafeCast

                                                  SafeCast makes sure the input object is of a class that can be cast into spGeometryDataCollection, and if this is the case, returns the object cast into spGeometryDataCollection.