Summary
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.
Properties
| Property | Explanation | Data Type |
| networkName (Read Only) | The name of the network. | String |
| sourceNames (Read Only) | The names of the sources referenced by the network. This is of type string. | Iterable |
Method Overview
| Method | Explanation |
| 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. |
Methods
attribute (attribute_name)
| Parameter | Explanation | Data Type |
attribute_name | The name of the network attribute. | String |
| Data Type | Explanation |
| Attribute | An attribute object. If the attribute name is not found, None will be returned. |
attributeUsage (attribute)
| Parameter | Explanation | Data Type |
attribute | The attribute ID as an attribute object. | Attribute |
| Data Type | Explanation |
| AttributeUsage | An attribute usage enumeration. |
attributeParameters (attribute)
| Parameter | Explanation | Data Type |
attribute | The attribute ID as an attribute object. | Attribute |
| Data Type | Explanation |
| AttributeParameter | An iterable of attribute parameters. |
fromJunction (edge)
| Parameter | Explanation | Data Type |
edge | The edge that will get the from junction. | Edge |
| Data Type | Explanation |
| Junction | The from junction for the specified edge. |
toJunction (edge)
| Parameter | Explanation | Data Type |
edge | The edge that will get the to junction. | Edge |
| Data Type | Explanation |
| Junction | The to junction for the specified edge. |
atJunction (turn)
| Parameter | Explanation | Data Type |
turn | An iterable consisting of turn with the first and second edges. | Turn |
| Data Type | Explanation |
| Junction | The junction that connects the first and second edges of the turn. |
turns (junction)
| Parameter | Explanation | Data Type |
junction | The junction that will get the turns. | Junction |
| Data Type | Explanation |
| Turn | An iterable of turns for the specified junction where the junction connects the first and second edges of each turn. |
edges (element)
| Parameter | Explanation | Data Type |
element | The element the edges are connected to. The element can be a junction or a turn. | Object |
| Data Type | Explanation |
| Edge | An iterable of edges that are connected to the specified element. |
edgePositions (edge)
| Parameter | Explanation | Data Type |
edge | The edge that will get the from and to positions. | Edge |
| Data Type | Explanation |
| tuple | The from and to positions along the source feature for the specified edge. The tuple consists of float values. |
edgeAzimuths (edge)
| Parameter | Explanation | Data Type |
edge | The edge that will get the from and to azimuths. | Edge |
| Data Type | Explanation |
| tuple | The from and to azimuths for the specified edge. The tuple consists of float values. |
sourceInfo (element)
| Parameter | Explanation | Data Type |
element | The element that will get the source information. The element can be a Junction, an edge, or a turn. | Object |
| Data Type | Explanation |
| Integer | A tuple of network source ID and network source object ID. |
attributeValue (element, attribute, time_usage, local_time)
| Parameter | Explanation | Data Type |
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. (The default value is NetworkTimeUsage.Unused) | NetworkTimeUsage |
local_time | The time that will be used with the specified element. (The default value is None) | DateTime |
| Data Type | Explanation |
| Object | The attribute value for a specified element at a given time. This could be an integer, a float or a boolean. |