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
Properties
Property | Description |
Name | The name of the GeometryDataCollection object. (Inherited from Object) |
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. (Inherited from ObjectCollection) |
AddObjectSorted | Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name. (Inherited from ObjectCollection) |
AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
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. (Inherited from ObjectCollection) |
GetClass | Get the name of the GeometryDataCollection class. (Inherited from Object) |
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. (Inherited from ObjectCollection) |
GetGeometryData | The object the handle is referring to. |
GetItem | Returns the handle of the i:th item. (Inherited from ObjectCollection) |
GetItemAsObject | Returns the object of the i:th item. (Inherited from ObjectCollection) |
GetItemCount | The number of items in the collection. (Inherited from ObjectCollection) |
GetItemsObject | The object the handle is referring to. (Inherited from ObjectCollection) |
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. (Inherited from ObjectCollection) |
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. (Inherited from Object) |
IsGeometryDataInCollection | Returns true if the object is in the collection. |
IsItemInCollection | Returns true if the item is in the collection. (Inherited from ObjectCollection) |
IsNull | Returns true if the GeometryDataCollection object is invalid. (Inherited from Object) |
IsObjectInCollection | Returns true if the object is in the collection. (Inherited from ObjectCollection) |
IsSameObjectAs | Returns true if the GeometryDataCollection object is valid. (Inherited from Object) |
NonNull | Returns true if the GeometryDataCollection object is valid. (Inherited from Object) |
PrintInfo | Prints the content/info of the GeometryDataCollection object to the log. (Inherited from Object) |
RemoveAllItems | Removes all items from the collection. (Inherited from ObjectCollection) |
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. (Inherited from ObjectCollection) |
RemoveObject | Removes an object from the collection. Only the first occurrence of the object is removed from the collection. (Inherited from ObjectCollection) |
RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
Static methods
Method | Description |
IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
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. (Inherited from Object) |
Properties details
Name
The name of the GeometryDataCollection object. (Inherited from Object)
Syntax
SetName parameters
Type | Name | Min | Max | Description |
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
Type | Name | Min | Max | Description |
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
Name | Type | Min | Max | Description |
name | str | | | New name of the object. |
GetName return value
Type: str
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.
Syntax
Parameters
Type | Name | Min | Max | Description |
GeometryData | obj | | | The GeometryData to add. |
Return value
Type: rhandle
Syntax
Parameters
Type | Name | Min | Max | Description |
GeometryData | obj | | | The GeometryData to add. |
Return value
Type: System.IntPtr
Syntax
Parameters
Name | Type | Min | Max | Description |
obj | GeometryData | | | The GeometryData to add. |
Return value
Type: PyObject*
AddObject
Adds an object to the collection. The handle refers to the object until the object is removed from the collection again.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | obj | | | The object that is to be added to the collection. |
Return value
Type: rhandle
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | obj | | | The object that is to be added to the collection. |
Return value
Type: System.IntPtr
Syntax
Parameters
Name | Type | Min | Max | Description |
obj | Object | | | The object that is to be added to the collection. |
Return value
Type: PyObject*
AddObjectSorted
Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | obj | | | The object that is to be added to the collection. |
bool | ascending | | | Determines the sorting order. |
Return value
Type: rhandle
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | obj | | | The object that is to be added to the collection. |
bool | ascending | | | Determines the sorting order. |
Return value
Type: System.IntPtr
Syntax
Parameters
Name | Type | Min | Max | Description |
obj | Object | | | The object that is to be added to the collection. |
ascending | bool | | | Determines the sorting order. |
Return value
Type: PyObject*
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
Type | Name | Min | Max | Description |
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
Type | Name | Min | Max | Description |
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
Name | Type | Min | Max | Description |
observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
FindGeometryData
Finds a named object.
Syntax
Parameters
Type | Name | Min | Max | Description |
const char * | name | | | The name of the geometry object. |
Return value
Type: GeometryData
Syntax
Parameters
Type | Name | Min | Max | Description |
string | name | | | The name of the geometry object. |
Return value
Type: GeometryData
Syntax
Parameters
Name | Type | Min | Max | Description |
name | str | | | The name of the geometry object. |
Return value
Type: GeometryData
FindObject
Finds a named object in the collection. The first object with this name is returned. The search is case-sensitive.
Syntax
Parameters
Type | Name | Min | Max | Description |
const char * | name | | | The name of an object in the collection. |
Return value
Type: Object
Syntax
Parameters
Type | Name | Min | Max | Description |
string | name | | | The name of an object in the collection. |
Return value
Type: Object
Syntax
Parameters
Name | Type | Min | Max | Description |
name | str | | | The name of an object in the collection. |
Return value
Type: Object
GetClass
Get the name of the GeometryDataCollection class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
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.
Syntax
Parameters
GetFirstItem takes no parameters.
Return value
Type: rhandle
Syntax
Parameters
GetFirstItem takes no parameters.
Return value
Type: System.IntPtr
Syntax
Parameters
GetFirstItem takes no parameters.
Return value
Type: PyObject*
GetGeometryData
The object the handle is referring to.
Syntax
Parameters
Type | Name | Min | Max | Description |
rhandle | objhandle | | | The handle of the geometry data object to fetch. |
Return value
Type: GeometryData
Syntax
Parameters
Type | Name | Min | Max | Description |
System.IntPtr | objhandle | | | The handle of the geometry data object to fetch. |
Return value
Type: GeometryData
Syntax
Parameters
Name | Type | Min | Max | Description |
objhandle | PyObject* | | | The handle of the geometry data object to fetch. |
Return value
Type: GeometryData
GetItem
Returns the handle of the i:th item.
Syntax
Parameters
Type | Name | Min | Max | Description |
unsigned int | index | | | The index of an object in the collection. |
Return value
Type: rhandle
Syntax
Parameters
Type | Name | Min | Max | Description |
uint | index | | | The index of an object in the collection. |
Return value
Type: System.IntPtr
Syntax
Parameters
Name | Type | Min | Max | Description |
index | int | | | The index of an object in the collection. |
Return value
Type: PyObject*
GetItemAsObject
Returns the object of the i:th item.
Syntax
Parameters
Type | Name | Min | Max | Description |
unsigned int | index | | | The index of an object in the collection. |
Return value
Type: Object
Syntax
Parameters
Type | Name | Min | Max | Description |
uint | index | | | The index of an object in the collection. |
Return value
Type: Object
Syntax
Parameters
Name | Type | Min | Max | Description |
index | int | | | The index of an object in the collection. |
Return value
Type: Object
GetItemCount
The number of items in the collection.
Syntax
Parameters
GetItemCount takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetItemCount takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetItemCount takes no parameters.
Return value
Type: int
GetItemsObject
The object the handle is referring to.
Syntax
Parameters
Type | Name | Min | Max | Description |
rhandle | objhandle | | | The handle of an object in the collection. |
Return value
Type: Object
Syntax
Parameters
Type | Name | Min | Max | Description |
System.IntPtr | objhandle | | | The handle of an object in the collection. |
Return value
Type: Object
Syntax
Parameters
Name | Type | Min | Max | Description |
objhandle | PyObject* | | | The handle of an object in the collection. |
Return value
Type: Object
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.
Syntax
Parameters
Type | Name | Min | Max | Description |
rhandle | objhandle | | | The handle of an object i. |
Return value
Type: rhandle
Syntax
Parameters
Type | Name | Min | Max | Description |
System.IntPtr | objhandle | | | The handle of an object i. |
Return value
Type: System.IntPtr
Syntax
Parameters
Name | Type | Min | Max | Description |
objhandle | PyObject* | | | The handle of an object i. |
Return value
Type: PyObject*
GetNextItemAsGeometryData
Returns the object of the next item.
Syntax
Parameters
Type | Name | Min | Max | Description |
RhandleData | phandle | | | The handle to the geometry object. |
Return value
Type: GeometryData
Syntax
Parameters
Type | Name | Min | Max | Description |
System.IntPtr[] | phandle | | | The handle to the geometry object. |
Return value
Type: GeometryData
Syntax
Parameters
Name | Type | Min | Max | Description |
phandle | PyObject* | | | The handle to the geometry object. |
Return value
Type: GeometryData
IsA
Returns true if GeometryDataCollection is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
Type | Name | Min | Max | Description |
const char * | type | | | Name of the class to check if GeometryDataCollection is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
Type | Name | Min | Max | Description |
string | type | | | Name of the class to check if GeometryDataCollection is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
Name | Type | Min | Max | Description |
type | str | | | Name of the class to check if GeometryDataCollection is, or is a descendant of. |
Return value
Type: bool
IsGeometryDataInCollection
Returns true if the object is in the collection.
Syntax
Parameters
Type | Name | Min | Max | Description |
GeometryData | pobj | | | The GeometryData to look for. |
Return value
Type: bool
Syntax
Parameters
Type | Name | Min | Max | Description |
GeometryData | pobj | | | The GeometryData to look for. |
Return value
Type: bool
Syntax
Parameters
Name | Type | Min | Max | Description |
pobj | GeometryData | | | The GeometryData to look for. |
Return value
Type: bool
IsItemInCollection
Returns true if the item is in the collection.
Syntax
Parameters
Type | Name | Min | Max | Description |
rhandle | objhandle | | | The handle of an object to be checked for. |
Return value
Type: bool
Syntax
Parameters
Type | Name | Min | Max | Description |
System.IntPtr | objhandle | | | The handle of an object to be checked for. |
Return value
Type: bool
Syntax
Parameters
Name | Type | Min | Max | Description |
objhandle | PyObject* | | | The handle of an object to be checked for. |
Return value
Type: bool
IsNull
Returns true if the GeometryDataCollection object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsObjectInCollection
Returns true if the object is in the collection.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | pobj | | | The object to be checked for. |
Return value
Type: bool
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | pobj | | | The object to be checked for. |
Return value
Type: bool
Syntax
Parameters
Name | Type | Min | Max | Description |
pobj | Object | | | The object to be checked for. |
Return value
Type: bool
IsSameObjectAs
Returns true if the GeometryDataCollection object is valid. (Inherited from Object)
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
Name | Type | Min | Max | Description |
object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the GeometryDataCollection object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the GeometryDataCollection object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveAllItems
Removes all items from the collection.
Syntax
Parameters
RemoveAllItems takes no parameters.
Syntax
Parameters
RemoveAllItems takes no parameters.
Syntax
Parameters
RemoveAllItems takes no parameters.
RemoveGeometryData
Removes an object from the collection. Only the first occurrence of the object is removed.
Syntax
Parameters
Type | Name | Min | Max | Description |
GeometryData | pobj | | | The GeometryData to remove from the collection. |
Syntax
Parameters
Type | Name | Min | Max | Description |
GeometryData | pobj | | | The GeometryData to remove from the collection. |
Syntax
Parameters
Name | Type | Min | Max | Description |
pobj | GeometryData | | | The GeometryData to remove from the collection. |
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.
Syntax
Parameters
Type | Name | Min | Max | Description |
rhandle | objhandle | | | The handle of the object that is to be removed. |
Return value
Type: rhandle
Syntax
Parameters
Type | Name | Min | Max | Description |
System.IntPtr | objhandle | | | The handle of the object that is to be removed. |
Return value
Type: System.IntPtr
Syntax
Parameters
Name | Type | Min | Max | Description |
objhandle | PyObject* | | | The handle of the object that is to be removed. |
Return value
Type: PyObject*
RemoveObject
Removes an object from the collection. Only the first occurrence of the object is removed from the collection.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | pobj | | | The object that is to be removed. |
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | pobj | | | The object that is to be removed. |
Syntax
Parameters
Name | Type | Min | Max | Description |
pobj | Object | | | The object that is to be removed. |
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
Type | Name | Min | Max | Description |
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
Type | Name | Min | Max | Description |
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
Name | Type | Min | Max | Description |
observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
Type | Name | Min | Max | Description |
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
Type | Name | Min | Max | Description |
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
Name | Type | Min | Max | Description |
type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
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. (Inherited from Object)