Net Function: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
[[File:Api_current_situation_network.png|thumb|right|400px|[[Net Function]]s in relation to [[Net Line]]s and [[Net Function Override]]s.]] | |||
Net Function is an item that stores properties that are shared among a group of [[Net Line]]s. First and foremost, the [[Net Type]] is stored in this Net Function. Furthermore, attributes stored in this [[item]] include its color or visualization diameter, are inherited by their net lines. | Net Function is an item that stores properties that are shared among a group of [[Net Line]]s. First and foremost, the [[Net Type]] is stored in this Net Function. Furthermore, attributes stored in this [[item]] include its color or visualization diameter, are inherited by their net lines. | ||
| Line 13: | Line 14: | ||
'''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. | '''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. | ||
[[Category:Items]] | [[Category:Items]] | ||
Revision as of 15:14, 28 February 2023
Net Function is an item that stores properties that are shared among a group of Net Lines. First and foremost, the Net Type is stored in this Net Function. Furthermore, attributes stored in this item include its color or visualization diameter, are inherited by their net lines.
Each Net Line references to a Net Function. Changes made to a Net Function are stored in a Net Function Override.
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.
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.