|
|
| (24 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| {{learned|what net loads are|how net loads relate to the {{software}}|how net lines are defined|how to create and edit lines}}
| | [[File:Api_current_situation_network.png|thumb|right|400px|[[Net Line]]s in relation to [[Net Node]]s and [[Net Function]]s.]] |
| [[Category:Network]] | | 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. |
| | |
| ==What are net lines==
| |
| A line, in network simulation terms, is a connection between different nodes in a resource transport and distribution network. Along with the nodes of the network they form a [//en.wikipedia.org/wiki/Graph_(discrete_mathematics) graph].
| |
| | |
| ==How net lines relate to the {{software}}==
| |
| In the {{software}}, net lines and net nodes, along with [[net load]]s, form distribution networks. They are defined by 2 net nodes, a starting node and an end node, and a {{inlink|net line definition}}. The collection of net lines and net nodes between two arbitrary net nodes is called a path. | |
|
| |
|
| ==Properties of net lines== | | ==Properties of net lines== |
| Net lines have a number of properties, mostly related to visualization. They also allow for the definitions of arbitrary [[attributes]]. | | Net lines have a number of properties, mostly related to visualization. They also allow for the definitions of arbitrary [[attribute]]s. |
|
| |
|
| ===Name=== | | ===Name=== |
| Line 17: |
Line 11: |
| 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. | | 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 line definitions=== | | ===Net Function=== |
| Each net line has a reference to a net line definition. The net line definition'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. | | 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=== | | ===Net Type=== |
| Line 24: |
Line 18: |
|
| |
|
| ===Attributes=== | | ===Attributes=== |
| Net lines can have any number of arbitrary [[attributes]]. A few attribute names are reserved and have a special function. | | 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. |
| | |
| '''DEF_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 World]].
| |
| | |
| '''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 [[Network_settings|settings of the net type]]. Depending on the [[Network_settings#Calculation_Model|calculation model]] for networks, this attribute is used in resource flow calculations.
| |
| | |
| '''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 World]], but is not intended to be used in calculations.
| |
| | |
| ==Adding and editing net lines==
| |
| It is possible to edit the net lines of the network, but also to import net lines into the project.
| |
| | |
| ===Manually editing===
| |
| It is possible to manually edit the network by creating, moving, and removing the lines which make up the full network.
| |
| | |
| {{Editor location|net edit}}
| |
| [[File:net-editing-bottom.jpg|framed|left|The bottom panel in the editor, when editing the network.]]
| |
| | |
| The network drawing too will be visible at the bottom of the screen.<br style='clear:left'>
| |
| | |
| ====Modes====
| |
| The following modes are available.
| |
| | |
| =====Add=====
| |
| [[File:net-editing-bottom-add.jpg|frame|right|The option for adding net lines.]]
| |
| Draw a new line between 2 indicated locations in the 3D world. The first time you click in the world, you select that location as the first end of your new new line. When you click in a second location, a net line is created between the first and the second location. The second location is then treated as the starting point for your next net line. Each line you create this way will be connected.<br style='clear:right'>
| |
| | |
| =====Remove=====
| |
| [[File:net-editing-bottom-remove.jpg|frame|right|The option for removing net lines.]]
| |
| Click on any line in the 3D world to delete it.<br style='clear:right'>
| |
| | |
| =====Move=====
| |
| [[File:net-editing-bottom-move.jpg|frame|right|The option for moving net lines.]]
| |
| Click and hold down the left mouse button on any endpoint of a net line, then drag the mouse and release the left mouse button. The net line's end point will be moved to the location you dragged it to. If multiple net lines share the same end point, each of those net lines will now have their endpoint on that new location.<br style='clear:right'>
| |
| | |
| ====Options====
| |
| To fine-tune how the editing options work, some configuration settings are available.
| |
| | |
| =====Connect via roads=====
| |
| [[File:net-editing-bottom-roads.jpg|frame|right|The option for forcing paths over roads.]]
| |
| If checked, the path between the start node and the end node is calculated dynamically to only travel via terrain with the [[function values#Function_values|pipes permitted]] property. In general, this is functionally the same as only using roads. More nodes will be placed where required, connected with net lines. If unchecked, a net line will be created directly connected the indicated nodes. I.e. as the crow flies. (This option is not available while removing.)<br style='clear:right'>
| |
| | |
| =====Repeated=====
| |
| [[File:net-editing-bottom-repeated.jpg|frame|right|The option for iterating the removal action along the net line.]]
| |
| If checked, when a net line is removed, if due to that removal net lines are left which are dead ends, those net lines are removed as well until all those dead ends are removed. This means that long stretches comprised of multiple net lines can be removed as though they were a single net line, up to the point where they branch off into other net lines. If unchecked, only the specific net line clicked will be removed. (This option is only available while removing.)<br style='clear:right'>
| |
| | |
| =====Merge=====
| |
| [[File:net-editing-bottom-merge.jpg|frame|right|The option for merging the ends of net line end points.]]
| |
| If checked, when you place a node very close to another node in the 3D world of the same network, the existing node will be used in place of the otherwise newly placed node. This means that when you're drawing a line and the endpoint of the net line is drawn very close to an existing node, the line you're drawing will "snap" onto the existing node. If unchecked, a new node will always be created, no matter how close to an existing node the new node is placed. (This option is not available while removing.)<br style='clear:right'>
| |
| | |
| =====Show Constructions=====
| |
| [[File:net-editing-bottom-constructions.jpg|frame|right|The option for hiding and showing constructions while editing.]]
| |
| If checked, this constructions will remain visible while drawing. If unchecked, constructions will be hidden so you can place nodes more easily.<br style='clear:right'>
| |
| | |
| =====Net Type=====
| |
| [[File:net-editing-bottom-nettype.jpg|frame|right|The option for which network type to edit.]]
| |
| This is the [[net type|network]] currently being edited. Only the network being edited is visible in the [[3D world]]. You can only select networks for which {{inlink|net line definitions}} exist.<br style='clear:right'>
| |
|
| |
|
| =====NetLine Def=====
| | '''COLOR''': The color of the net line used in the visualization of the network. |
| [[File:net-editing-bottom-netdef.jpg|frame|right|The option for what kind of net lines to draw.]]
| |
| This is the {{inlink|net line definitions|type of net line}} being placed while drawing new net lines.<br style='clear:right'>
| |
|
| |
|
| =====Distance=====
| | '''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]]. |
| [[File:net-editing-bottom-distance.jpg|frame|right|The option for merging distance.]]
| |
| This is the distance for merging nodes. If the endpoint of a net line is placed within this distance from an existing net node, the existing net node is used.<br style='clear:right'> | |
|
| |
|
| =====Node Size=====
| | '''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. |
| [[File:net-editing-bottom-size.jpg|frame|right|The net node visualization size setting.]]
| |
| This is the size used to visualize net nodes while drawing net lines. This is only for clarity while editing, and when editing concludes the net nodes revert o their normal size.<br style='clear:right'>
| |
|
| |
|
| ===Importing GeoJSON===
| | '''PRICE_M''': The price per meter. Can be used to calculate the costs of the net lines. |
| It is possible to import a geojson file to add net lines to a project.
| |
|
| |
|
| {{Editor location|net import}}
| | '''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. |
|
| |
|
| It is also possible to select the option of importing data in the Net wizard. In both cases, it is recommended to import all network geojson files at the same time where possible: net lines, net line definitions, and net loads.
| |
|
| |
|
| The net lines [[GeoJSON]] file should be composed of line data with the following attributes.
| | {{article end |
| | |howtos= |
| | * [[How to manually edit Net Lines of a network]] |
| | * [[How to import Net Lines using a GeoJSON]] |
| | }} |
| | {{editor current situation nav}} |
|
| |
|
| {| class="wikitable"
| | [[Category:Items]] |
| ! Attribute
| |
| ! Description
| |
| ! Example
| |
| ! Remark
| |
| |-
| |
| | NAME
| |
| | The name of the net load.
| |
| | NetLoad 49
| |
| |
| |
| |-
| |
| | NET_TYPE
| |
| | The type of network this net load belongs to
| |
| | HEAT
| |
| | Note that when connecting net loads and net nodes or net lines of different network types while importing, this is considered incorrect input and behavior of the {{software}} will be undefined.
| |
| |-
| |
| | TYPE_ID
| |
| | The net line definition this net line should be based on
| |
| | HEAT
| |
| | This TYPE_ID should match the ID of one of the simultaneously imported net line definitions. Note that when no net line definition file is being uploaded in the same upload action, this attribute is ignored and the first net line definition of the appropriate net type is used. If none exist, a single net line definition is created and used for all net lines imported of the same net type.
| |
| |-
| |
| | START_NODE_ID
| |
| | The identifying number at one end of the net line
| |
| | 15
| |
| | rowspan="2" | Net lines are connected at the ends where START_NODE_ID of one net line matches the START_NODE_ID or END_NODE_ID of another net line, and END_NODE_ID of one net line matches the START_NODE_ID or END_NODE_ID of another net line. Note that for the relevant ends of the net lines the coordinates should be close to one another. The START_NODE_ID and END_NODE_ID of a single net line should never be the identical. If the value is unique among all START_NODE_IDs and END_NODE_IDs the net line has an end from where no further net lines continue.
| |
| |-
| |
| | END_NODE_ID
| |
| | The identifying number at the other end of the net line
| |
| | 16
| |
| |}
| |
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
Current Situation