NetworkQuery

Synthèse

This object provides access to a network dataset's properties, attributes, attribute values, and elements.

Discussion

A NetworkQuery object is provided as a parameter to the attach method, and other methods can use self.networkQuery to this object. A NetworkQuery object can be used to get various properties of a network dataset or query a network dataset for attributes, elements, and so on.

Propriétés

PropriétéExplicationType de données
networkName
(Lecture seule)

The name of the network.

String
sourceNames
(Lecture seule)

The names of the sources referenced by the network. This is of type string.

Iterable

Vue d’ensemble des méthodes

MéthodeExplication
attribute (attribute_name)

Returns an attribute of the specified attribute name.

attributeUsage (attribute)

Returns the usage type of the specified attribute.

attributeParameters (attribute)

Returns the parameters of the specified attribute.

fromJunction (edge)

Returns the from junction for the specified edge.

toJunction (edge)

Returns the to junction for the specified edge.

atJunction (turn)

Returns the junction that connects the first and second edges of the turn.

turns (junction)

Returns the turns for the specified junction where the junction connects the first and second edges of each turn.

edges (element)

Returns the edges that are connected to the specified element.

edgePositions (edge)

Returns the from and to positions along the source feature for the specified edge. This method uses the digitization direction of the source feature.

The values can range from 0.0 to 1.0

edgeAzimuths (edge)

Returns the from and to azimuths for the specified edge.

sourceInfo (element)

Returns source information for the specified network element.

attributeValue (element, attribute, time_usage, local_time)

The attribute value for a specified element, with optional time.

Méthodes

attribute (attribute_name)
ParamètreExplicationType de données
attribute_name

The name of the network attribute.

String
Valeur renvoyée
Type de donnéesExplication
Attribute

An attribute object.

If the attribute name is not found, None will be returned.

attributeUsage (attribute)
ParamètreExplicationType de données
attribute

The attribute ID as an attribute object.

Attribute
Valeur renvoyée
Type de donnéesExplication
AttributeUsage

An attribute usage enumeration.

attributeParameters (attribute)
ParamètreExplicationType de données
attribute

The attribute ID as an attribute object.

Attribute
Valeur renvoyée
Type de donnéesExplication
AttributeParameter

An iterable of attribute parameters.

fromJunction (edge)
ParamètreExplicationType de données
edge

The edge that will get the from junction.

Edge
Valeur renvoyée
Type de donnéesExplication
Junction

The from junction for the specified edge.

toJunction (edge)
ParamètreExplicationType de données
edge

The edge that will get the to junction.

Edge
Valeur renvoyée
Type de donnéesExplication
Junction

The to junction for the specified edge.

atJunction (turn)
ParamètreExplicationType de données
turn

An iterable consisting of turn with the first and second edges.

Turn
Valeur renvoyée
Type de donnéesExplication
Junction

The junction that connects the first and second edges of the turn.

turns (junction)
ParamètreExplicationType de données
junction

The junction that will get the turns.

Junction
Valeur renvoyée
Type de donnéesExplication
Turn

An iterable of turns for the specified junction where the junction connects the first and second edges of each turn.

edges (element)
ParamètreExplicationType de données
element

The element the edges are connected to. The element can be a junction or a turn.

Object
Valeur renvoyée
Type de donnéesExplication
Edge

An iterable of edges that are connected to the specified element.

edgePositions (edge)
ParamètreExplicationType de données
edge

The edge that will get the from and to positions.

Edge
Valeur renvoyée
Type de donnéesExplication
tuple

The from and to positions along the source feature for the specified edge. The tuple consists of float values.

edgeAzimuths (edge)
ParamètreExplicationType de données
edge

The edge that will get the from and to azimuths.

Edge
Valeur renvoyée
Type de donnéesExplication
tuple

The from and to azimuths for the specified edge. The tuple consists of float values.

sourceInfo (element)
ParamètreExplicationType de données
element

The element that will get the source information. The element can be a Junction, an edge, or a turn.

Object
Valeur renvoyée
Type de donnéesExplication
Integer

A tuple of network source ID and network source object ID.

attributeValue (element, attribute, time_usage, local_time)
ParamètreExplicationType de données
element

The element that the attribute value will be applied to. The element can be an edge, a junction, or a turn.

Object
attribute

The attribute that the value will be applied to.

Attribute
time_usage

The time usage type.

(La valeur par défaut est NetworkTimeUsage.Unused)

NetworkTimeUsage
local_time

The time that will be used with the specified element.

(La valeur par défaut est None)

DateTime
Valeur renvoyée
Type de donnéesExplication
Object

The attribute value for a specified element at a given time. This could be an integer, a float or a boolean.