Net Function: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 2: Line 2:
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.  
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.  


Attributes stored in this [[item]] include its color or visualization diameter, are inherited by their net lines.  
Attributes stored in this [[Item]], such as color or visualization diameter, are inherited by their net lines.


Each [[Net Line]] references to a Net Function.
Each [[Net Line]] references a Net Function.


===Attributes===
===Attributes===
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.
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.
'''COLOR''': The color of the net line used in the visualization of the network.
Line 15: Line 15:
'''PRICE_M''': The price per meter. Can be used to calculate the costs of the net lines.
'''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.
'''VISUALIZATION_DIAMETER_M''': The diameter of the net line. Similar to 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.





Latest revision as of 13:02, 6 July 2026

Net Functions in relation to Net Lines.

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.

Attributes stored in this Item, such as color or visualization diameter, are inherited by their net lines.

Each Net Line references a Net Function.

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 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.


Notes

  • Net Function is a Sourced Item, which means it records which Sources created it and which Sources changed any of its properties.

See also

API Endpoints