Net Line: Difference between revisions
No edit summary |
|||
| (60 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
[[File:Api_current_situation_network.png|thumb|right|400px|[[Net Line]]s in relation to [[Net Node]]s and [[Net Function]]s.]] | |||
In the {{software}}, net lines and net nodes, along with [[Net Load]]s, form distribution networks. They are defined by 2 [[Net Node]]s, a starting node and an end node, and a [[Net Function]]. The collection of net lines and net nodes between two arbitrary net nodes is called a path. | |||
==Properties of net lines== | |||
Net lines have a number of properties, mostly related to visualization. They also allow for the definitions of arbitrary [[attribute]]s. | |||
== | ===Name=== | ||
The name of the net line is generally not visible to the end user, but can be used to keep track of specific net lines while editing, or could be called up using TQL to display more information to an end user. | |||
== | ===Length=== | ||
The length of the net line is a property resulting from where the net line starts and ends. This property cannot be edited directly, but is calculated based on its coordinates. This calculation only takes flat distance into account. Terrain height is not taken into account. | |||
== | ===Net Function=== | ||
Net lines | Each net line has a reference to a [[Net Function]]. The net function's attributes, such as its color or visualization diameter, are inherited by their net lines. This allows a single set of properties to be applied to all lines in the network. | ||
===Net | ===Net Type=== | ||
The [[Network#Network_type|network type]] this net line belongs to. Each net line can only belong to one type of network. | |||
===Attributes=== | ===Attributes=== | ||
Net lines can have any number of arbitrary [[ | Net lines can have any number of arbitrary [[attribute]]s. A few attribute names are reserved and have a special function. Generally these are defined in their [[Net Function]], but can be overridden by the Net Line. | ||
'''COLOR''': The color of the net line used in the visualization of the network. | |||
'''DIAMETER_M''': The diameter of the net line. This can be used in calculations and also affects the width of the net line as visible in the [[3D Visualization]]. | |||
'''FLOW''': The flow of a net line indicates the amount of the resource that is transported through this net line. If the network's graph is a tree, the direction is implicit and the value can be consistently positive. In more complicated networks, the direction in which the resource is transported may be relevant, and can be indicated with a positive or negative value. By default, the attribute name FLOW is preferred. The specific attribute name used for this is defined as part of the [[Net_Setting|settings of the net type]]. Depending on the [[Net_Setting#Calculation_Model|calculation model]] for networks, this attribute is used in resource flow calculations. | |||
'''PRICE_M''': The price per meter. Can be used to calculate the costs of the net lines. | |||
'''VISUALIZATION_DIAMETER_M''': The diameter of the net line. Similar to DEF_DIAMETER_M, this attribute affects the visualized width of the net line in the [[3D Visualization]], but is not intended to be used in calculations. | |||
{{article end | |||
|howtos= | |||
* [[How to manually edit Net Lines of a network]] | |||
* [[How to import Net Lines using a GeoJSON]] | |||
}} | |||
{{editor current situation nav}} | |||
[[Category:Items]] | |||
Latest revision as of 15:36, 28 February 2023
In the Tygron Platform, net lines and net nodes, along with Net Loads, form distribution networks. They are defined by 2 Net Nodes, a starting node and an end node, and a Net Function. The collection of net lines and net nodes between two arbitrary net nodes is called a path.
Properties of net lines
Net lines have a number of properties, mostly related to visualization. They also allow for the definitions of arbitrary attributes.
Name
The name of the net line is generally not visible to the end user, but can be used to keep track of specific net lines while editing, or could be called up using TQL to display more information to an end user.
Length
The length of the net line is a property resulting from where the net line starts and ends. This property cannot be edited directly, but is calculated based on its coordinates. This calculation only takes flat distance into account. Terrain height is not taken into account.
Net Function
Each net line has a reference to a Net Function. The net function's attributes, such as its color or visualization diameter, are inherited by their net lines. This allows a single set of properties to be applied to all lines in the network.
Net Type
The network type this net line belongs to. Each net line can only belong to one type of network.
Attributes
Net lines can have any number of arbitrary attributes. A few attribute names are reserved and have a special function. Generally these are defined in their Net Function, but can be overridden by the Net Line.
COLOR: The color of the net line used in the visualization of the network.
DIAMETER_M: The diameter of the net line. This can be used in calculations and also affects the width of the net line as visible in the 3D Visualization.
FLOW: The flow of a net line indicates the amount of the resource that is transported through this net line. If the network's graph is a tree, the direction is implicit and the value can be consistently positive. In more complicated networks, the direction in which the resource is transported may be relevant, and can be indicated with a positive or negative value. By default, the attribute name FLOW is preferred. The specific attribute name used for this is defined as part of the settings of the net type. Depending on the calculation model for networks, this attribute is used in resource flow calculations.
PRICE_M: The price per meter. Can be used to calculate the costs of the net lines.
VISUALIZATION_DIAMETER_M: The diameter of the net line. Similar to DEF_DIAMETER_M, this attribute affects the visualized width of the net line in the 3D Visualization, but is not intended to be used in calculations.
Current Situation
- Buildings • Terrains • Administrative • Areas • Networks • Overlays • Indicators • Panels • Globals • Queries • Geo Import
- Buildings
- Function • Function Override • Traffic Units
- Terrain
- Height sector • Elevation model • Elevation GeoTIFF • Elevation Grid Overlay • Ground Price • Terrain Type • Terrain Type Override
- Administrative
- Net Cluster • Net Function • Net Line • Net Load • Net Node • Net Setting
- Editor