PyANGKernel.GKGroup¶

class GKGroup¶

GKGroup corresponds to a Grouping, a list (by list or by polygon) of objects of the same type. It belongs to a Grouping Category ( GKGroupingType ).

Synopsis¶

Methods¶

def __init__()
def addObject()
def contains()
def ensureObjects()
def getGroupingType()
def getNbObjects()
def getObjects()
def getObjectsIds()
def getObjectsLinks()
def getSectionsAndTurns()
def polygonBased()
def refreshStats()
def removeAllObjects()
def removeObject()
def setGroupingType()
def setObjects()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

__init__()¶

addObject(obj[, link=GKCondition.eAnd])¶

Parameters:

obj – GKObject
link – LinkType

contains(obj)¶

Parameters:: obj – GKObject
Return type:: bool

Is the object in this group?

contains(objectId)

Parameters:: objectId – int
Return type:: bool

Is the object in this group?

ensureObjects()¶

Update the data structures if the group has been created from a polygon.

getGroupingType()¶

Return type:: GKGroupingType

getNbObjects()¶

Return type:: int

Returns the number of objects in this grouping

getObjects()¶

Return type:: .list of GKObject

getObjectsIds()¶

Return type:: .QSetuint

getObjectsLinks()¶

Return type:: .list of std.pairGKObject,GKCondition.LinkType

getSectionsAndTurns(scenario, oSections, oTurnings)¶

Parameters:

scenario – GKGenericScenario
oSections – .QSetGKSection
oTurnings – .QSetGKTurning

Get the sections and turns in the group filtering by scenario. If scenario is null it will not filter.

polygonBased()¶

Return type:: bool

True if this group has been created from a polygon, so the build is done with all the objects inside. False if it is a list of objects manually add.

refreshStats(originator, cols[, task=None])¶

Parameters:

originator – GKObject
cols – .list of std.pairGKColumn,GKColumn
task – GKTask

Refresh group statistics. Uses the first column in the pair to read data from objects and set the aggregation * in the second column of this group.

removeAllObjects()¶

removeObject(obj)¶

Parameters:: obj – GKObject

setGroupingType(atype)¶

Parameters:: atype – GKGroupingType

setObjects(groupedObjects)¶

Parameters:: groupedObjects – .list of GKObject