PyANGKernel.GKProblemNet

class GKProblemNet

A subnetwork object

Details

A subnetwork is a smaller area in a larger network that will be studied with more detail using a dynamic simulator (usually a micro one).

The area is selected either as contained in a polygon or as a set of sections. From that information it is possible to extract all the objects inside the subnetwork.

The traversal macro tool generates the centroid configuration and demand for the subnetwork.

Inheritance diagram of PyANGKernel.GKProblemNet

Synopsis

Methods

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__()
addManualSection(section)
Parameters:

section – GKSection

Adds a section to the list of manual sections (sections in the list defined by the user to determine the subnetwork).

containsManualSection(section)
Parameters:

section – GKSection

Return type:

bool

Returns true if the section is in the list of manual sections (sections in the list defined by the user to determine the subnetwork).

count()

Counts the number of sections and nodes on this subnetwork (using classifyObjects ). After counting, this information can be read using getNbSections and getNbNodes

getManualSections()
Return type:

.list of GKSection

getNbAllNodes()
Return type:

int

Returns the number of nodes on this subnetwork. A node is counted if it is totally or partially inside. Call count before calling this method.

getNbNodes()
Return type:

int

Returns the number of nodes on this subnetwork with more than one turn. A node is counted if it is totally or partially inside. Call count before calling this method.

getNbSections()
Return type:

int

Returns the number of sections on this subnetwork. A section is counted if it is totally or partially inside. Call count before calling this method.

getObjectsInside()
Return type:

.QSetGKGeoObject

removeManualSection(section)
Parameters:

section – GKSection

Removes a section from the list of manual sections (sections in the list defined by the user to determine the subnetwork). *

Warning

The specified section MUST be contained in the list of manual sections.

setManualSections(sections)
Parameters:

sections – .list of GKSection

Sets the list of sections defined by the user to determine this subnetwork.

useManualSections(value)
Parameters:

value – bool

Sets the boolean to indicate whether we consider a list of sections set by the user (true), or false (the default) if we consider sections in the polygon.

usingManualSections()
Return type:

bool

Returns true if we consider a list of sections set by the user, false (the default) if we consider sections in the polygon.