Network: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
 
(37 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{learned|what networks are|how networks relate to the {{software}}|how networks are structured|how to create networks}}
[[File:Api_current_situation_network.png|thumb|right|400px|Network with [[Net Node]]s connected by [[Net Line]]s, [[Net Load]]s clustered by [[Net Cluster]]s and configured by [[Net Setting]]s]]
[[Category:Network]]


==What is a network==
Networks in the platform are composed of multiple constituent components:
A network is broadly defined as an interconnected system of things. More specifically, networks used here are transport and distribution networks. These are systems composed of interconnected points of supply and demand for specific resources, and the routes connecting them.
* [[Net Type]]: A categorization of the network.
* [[Net Node]]s: A node present in one or more networks
* [[Net Line]]s: A connection between two net nodes
** Has an associated [[Net Function]], which in turn is related to a specific [[net type]].
* [[Net Load]]s: A definition of supply or demand in the network
** Belongs to a particular [[Net Type]]
** Is associated to [[Net Node]].
** Can be activated or deactivated with specific time states.
* [[Net Cluster]]s: Cluster of net loads that provides group (de)activation.
** Can be associated with [[Net Load]]s of different [[Net Type]]s
* [[Net Setting]]s: Settings related to the configuration of a Network of a specific Net Type.


==How networks relate to the {{software}}==
In the {{software}}, it is possible to add network information to a project.


Network functionality is currently an advanced feature, and not available to new projects by default. Please {{support|contact Tygron Support}} if you wish to make use of networks in your projects.
==Network structure==
Networks are not themselves an individual component in a project, but are composed of multiple constituent components.
===Network type===
Each network is related to a predefined resource type. This is known as the network type. The network then is the system through which that resource travels from elements of supply to elements of demand. Each network of a separate type is a separate entity, and networks of different types do not affect each other. The following network types are currently available:
* ELECTRICITY
* GAS
* HEAT
* INTERNET
* SEWAGE
===Network components===
Networks in the {{software}} consist first and foremost out of [[net line]]s and [[net node]]s. The net lines are the principle element in this structure. The two ends of net lines are defined by net nodes. Each net node has at least one net line connected to it, but any arbitrary number of net lines can start or end at a node. The collection of net lines and net nodes between two arbitrary net nodes is called a path.
Networks also have [[net load]]s, which are a definition of supply and demand. These net loads are linked to net nodes, to indicate the supply and demand on that node. A net load is a geographical element, which should be connected to a net node, with data concerning the amount of supply or demand that net node represents. Not every net node needs to have a net load connected to it. However, net loads are only relevant and valid when they are connected to a net node.
Lastly, clusters are also used in conjunction with networks. Clusters group together net loads, and serve as an intermediary to use [[TQL|queries]] on the loads of networks, or to add [[panel]]s to the network for reading out information and controlling the network. Clusters are not formally an element of the network. Their existence (or lack thereof) does not inherently influence the validity, functioning, or meaning of the network.
===Network settings===
There are a number of settings available with which to tweak how networks functions in your project. For more information on the settings available, see [[Network settings]].


===Restrictions on networks===
===Restrictions on networks===
* Networks cannot contain any cycles. All networks should be defined as a tree. If the network is not structured as a tree, network generation and other calculations may have unexpected results.
* Networks cannot contain any cycles. All networks should be defined as a tree. If the network is not structured as a tree, network generation and other calculations may have unexpected results.
* A net node can be connected to 1, 2, or more [[net line]]s, except when that node is a [[net load|load node]]. In that case, a net node can only be connected to exactly 1 net line.
* A net node can be connected to 1, 2, or more [[net line]]s, except when that node is a [[net load|load node]]. In that case, a net node can only be connected to exactly 1 net line.
* Behavior for networks linked with buildings which are altered during a session are undefined. When using network functionality, the buildings linked to by the network should not be demolished, [[upgrade]]d, sold to other stakeholders, or otherwise changed.
* Behavior for networks linked with buildings which are altered during a session are undefined. When using network functionality, the buildings linked to by the network should not be demolished, [[Upgrade Type|upgrade]]d, sold to other stakeholders, or otherwise changed.
 
==Adding and editing networks==
Because networks are complex elements in a project, there are multiple topics devoted to creating and verifying your network.
 
===Ways of creating a network===
There are multiple ways to add a network to a project. Depending on the availability of data and the prospective complexity of the network some methods may be more appropriate.
 
====Generating====
It is possible to let the {{software}} [[Generating network|generate a network]] for you. This can be done using the Net wizard, which will guide you through the process.
{{Editor ribbon|header=Network|bar=Lines|dropdown=Net Wizard}}
 
====Importing Data====
 
{{stub|section}}
 
====Manually====
Although not very practical, it is possible to create or edit networks manually, by placing [[net line]]s and [[net load]]s in the world piece by piece.
 
===Checking for errors===
When there is doubt on whether the network has been created correctly, there are options to have the {{software}} check for issues automatically.


====Network wizard====
{{article end
When creating or importing network data using the net wizard, but also when stepping through the available steps of the wizard without effecting any changes, there are 2 validation steps where all preceding information is checked. These validation steps will check the following for all [[Network_settings#Active|active network types]]:
|howtos=
* There is a root node
* [[How to generate a network using the network wizard]]
* All net lines are connected directly or indirectly to the root node
* [[How to import an existing network]]
* All net loads are connected via paths composed of net lines to the root note
* [[How to manually edit a network]]
* All net nodes with only 1 net line connected to them have a net load connected to them
* [[How to check for errors when using the network wizard]]
* All net nodes with a net load connected to them only have 1 net line connected to them
* [[How to check for errors when using the net validation panel]]
<!--* There are no cycles in the network (except for the GAS network type)-->
|seealso=
* All net loads are part of a cluster
* [[Network Overview Overlay]]
* [[Network Ownership Overlay]]
* [[Network Distance Overlay]]
|videos=
:[[File:Network_VT.jpg| link=https://youtu.be/k4WDyjdurU4|left|thumb|Network and network generation]]
}}


====Net validation====
{{Template:Editor current situation nav}}
The net validation panel will check the following for a given network type:
* There is a root node
* All net lines are connected directly or indirectly to the root node
<!--* All net loads are connected via paths composed of net lines to the root note-->
* All net nodes with only 1 net line connected to them have a net load connected to them
* All net nodes with a net load connected to them only have 1 net line connected to them
<!--* There are no cycles in the network (except for the GAS network type)-->
<!--* All net loads are part of a cluster-->
You will also be able to "highlight" the network. This will highlight all segments of the network that are connected to the root node. All sections of the network that aren't connected in any way to the root node are not connected. This allows you to find small fractures which disconnect sections of the network.

Latest revision as of 15:14, 29 February 2024

Network with Net Nodes connected by Net Lines, Net Loads clustered by Net Clusters and configured by Net Settings

Networks in the platform are composed of multiple constituent components:

  • Net Type: A categorization of the network.
  • Net Nodes: A node present in one or more networks
  • Net Lines: A connection between two net nodes
  • Net Loads: A definition of supply or demand in the network
    • Belongs to a particular Net Type
    • Is associated to Net Node.
    • Can be activated or deactivated with specific time states.
  • Net Clusters: Cluster of net loads that provides group (de)activation.
  • Net Settings: Settings related to the configuration of a Network of a specific Net Type.


Restrictions on networks

  • Networks cannot contain any cycles. All networks should be defined as a tree. If the network is not structured as a tree, network generation and other calculations may have unexpected results.
  • A net node can be connected to 1, 2, or more net lines, except when that node is a load node. In that case, a net node can only be connected to exactly 1 net line.
  • Behavior for networks linked with buildings which are altered during a session are undefined. When using network functionality, the buildings linked to by the network should not be demolished, upgraded, sold to other stakeholders, or otherwise changed.