Global: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
 
(49 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{learned|what a global is|where globals currently used for|how to add and create globals|}}
[[File:Api_current_situation_calculation.png|thumb|right|400px|[[Global]]s in comparison to [[Overlay]]s, [[Indicator]]s and [[Panel]]s]]
A global is a value that exists in the project but is not necessarily connected to a specific component. The global can be used, for example in Excel calculations and influence the calculation of an Excel indicator. A global is similar to an [[attribute]] but for the entire project rather than for a specific component. The name of the global is also the global [[ID]] that can be used in queries.


==Global==
==Global uses==
A global is a number that exists in the project but is not necessarily connected to a specific component. The global can be used, for example in Excel calculations and influence the calculation of an Excel indicator.


==Global Uses==
Globals can be used, broadly speaking, to store and recall values. The most common application of this is in combination with [[excel]] sheets. Using [[TQL]], the value of a global can be loaded into an excel sheet and used in calculations. The values of globals can also be [[TQL#Numeric_values|set using TQL]] from excels. Globals can also be used to directly influence the budget of a specific [[Stakeholder|stakeholder]]. Lastly, globals can be made visible in the [[3D Visualization]].
When you have created a global the can be used communicate with a Microsoft Excel spreadsheet, when using such a spreadsheet for a (custom) [[Excel (Indicator)|Excel Indicator]].
Also, globals are currently used to attach to [[Events|event bundles]] and hereby influence the progress of indicators. Read more about how to connect the global to an [[Events|Event Bundle]] on the [[Events|events]] page.


==Properties of globals==
==Properties of globals==
There is one type of global that can be applied in different ways. A global is always made up of a name of the global and a number. Based on the purpose of the global the number represent an amount or a value which is specified by the name of the global. A global is similar to an [[Attributes|attribute]] but for the entire project rather than for a specific component.
A global is always made up of a name and a number. Based on the purpose of the global the number represents an amount or a value which is specified by the name.


===Output===
===Output===
By making use of the <code>SELECT_GLOBAL_WHERE_NAME_IS_GLOBALID</code> query in an [[Excel|Excel]] you can use globals to create output.
By using a <code>SELECT_GLOBAL_WHERE_NAME_IS_GLOBALID</code> query you can obtain the value of a global. This global's value can then be used in [[Excel|Excel]] calculations.  
It is also possible to connect the global to the budget of a specific stakeholder to directly influence the budget during a session.
It is also possible to connect the global to the budget of a specific stakeholder to directly influence the budget during a session. When the given value is a positive number it will increase the budget. When the given value is a negative number it will decrease the budget.


===Input===
===Input===
By making use of the <code>UPDATE_GLOBAL</code> statement in generating a [[TQL|query]] for an Excel, the global is used to generate input by an [[Excel|Excel calculation]].
There are 4 ways that a global's value can be set:
The second way of using a global as input is by connecting the global to an [[Events|Event Bundle]]. The value of the global can be used in the [[Events|event]] to influence an indicator.
* Each global has a starting value. At the start of a session, the global is set to this value.
* A global can be updated using a TQL update statement, of the form <code>UPDATE_GLOBAL_WHERE_NAME_IS_X</code>.
* A global's value can be changed by making use of a SET_GLOBAL_VALUE [[event]].
* A global can be directly linked to a TQL select statement, by setting the TQL property to a valid query.


==Add and remove Globals==
With the exception of linking a global directly to a TQL select statement, each method is a singular action to alter the global's value at one specific moment. Linking a global directly to a TQL select query will cause the global to be updated accordingly with every [[calculation cycle]]. This will easily overwrite any singular action such as an [[event]]. When using a TQL update statement in an excel to update a global, the effect will be similarly continuous, causing the global's value to update each calculation cycle.
{{editor ribbon|header=Indicators|bar=Globals}}


[[File:Add_global.png|framed|left|The [[Left Panel]] allows you to add, duplicate, and remove globals.]]
{{article end
{{Editor steps|title=add a global|In the ribbon header, select "Indicators".|In the ribbon bar, select "Globals".|In the left panel, select "Add".}}
|howtos=
{{Editor steps|title=duplicate a global|In the ribbon header, select "Indicators".|In the ribbon bar, select "Globals".|In the left panel, select the global you wish to duplicate.|In the left panel, select "Duplicate".}}
* [[How to add and remove Globals]]
{{Editor steps|title=remove a global|In the ribbon header, select "Indicators".|In the ribbon bar, select "Globals".|In the left panel, select the global you wish to remove.|In the left panel, select "Remove".}}<br clear=all>
* [[How to edit Global properties]]
|seealso=
[[File:YoutubeLogo1.jpg|link=https://youtu.be/IpQxzjzi1d0|thumb|left|200px|Panels en Globals (Dutch only)]]
}}


==How to edit Globals==
{{Editor current situation nav}}
{{editor ribbon|header=Indicators|bar=Globals}}


[[File:Global_panel_right.png|200px|thumb|left|Selecting a global makes its static properties adjustable in the Right Panel.]]
[[Category:Items]][[Category:Global]]
: ''Selecting a global in the left panel makes its properties adjustable in the right panel.''
<br clear=all>
 
=== Global properties===
[[File:Global_panel_left2.png|250px|right|Stakeholder properties]]
 
====Name====
: ''Each global has a name, this is shown in the left panel in the list of all globals that are created in the project. The global Name is the name of the Global ID which is used in queries.''
 
====Visualization Name====
: ''The Visualization Name is the name that is visible for the user after a global is made visual in the project, instead of the Name that is also used as the global ID. This can be done by setting a point in the 3D world, when a global is displayed in a panel or when the global is connected to the budget of a stakeholder.''
 
====Start Value====
: ''The value of the global at the beginning of the session.''
 
====Assign to Budget====
: ''With this checkbox you can decide whether you want to attach the value to the budget of a certain stakeholder or not. If you check this box the value is automatically counted as currency.''
 
====Stakeholder====
: ''The stakeholder dropdown menu is only available when the checkbox is checked. Here you decide to which of the stakeholder you attach the budget value to.''
 
====Remove Point====
: ''With the remove point option you can remove the visual global in the 3D world. The global is still present in the project, as you can see in the right panel, only it is not visible anymore in the 3D world.''
 
====Set Point====
: ''With the set point option you can let a global be displayed at a specific point in the 3D world. You can attach the global to a specific place in the 3D world regardless whether there is a construction. More information about how to draw a point in the 3D world is explained on the [[Brush|brush panel page]]''
[[File:Global_set_point.png|800px|middel|Stakeholder properties]]

Latest revision as of 10:22, 1 March 2023

Globals in comparison to Overlays, Indicators and Panels

A global is a value that exists in the project but is not necessarily connected to a specific component. The global can be used, for example in Excel calculations and influence the calculation of an Excel indicator. A global is similar to an attribute but for the entire project rather than for a specific component. The name of the global is also the global ID that can be used in queries.

Global uses

Globals can be used, broadly speaking, to store and recall values. The most common application of this is in combination with excel sheets. Using TQL, the value of a global can be loaded into an excel sheet and used in calculations. The values of globals can also be set using TQL from excels. Globals can also be used to directly influence the budget of a specific stakeholder. Lastly, globals can be made visible in the 3D Visualization.

Properties of globals

A global is always made up of a name and a number. Based on the purpose of the global the number represents an amount or a value which is specified by the name.

Output

By using a SELECT_GLOBAL_WHERE_NAME_IS_GLOBALID query you can obtain the value of a global. This global's value can then be used in Excel calculations. It is also possible to connect the global to the budget of a specific stakeholder to directly influence the budget during a session. When the given value is a positive number it will increase the budget. When the given value is a negative number it will decrease the budget.

Input

There are 4 ways that a global's value can be set:

  • Each global has a starting value. At the start of a session, the global is set to this value.
  • A global can be updated using a TQL update statement, of the form UPDATE_GLOBAL_WHERE_NAME_IS_X.
  • A global's value can be changed by making use of a SET_GLOBAL_VALUE event.
  • A global can be directly linked to a TQL select statement, by setting the TQL property to a valid query.

With the exception of linking a global directly to a TQL select statement, each method is a singular action to alter the global's value at one specific moment. Linking a global directly to a TQL select query will cause the global to be updated accordingly with every calculation cycle. This will easily overwrite any singular action such as an event. When using a TQL update statement in an excel to update a global, the effect will be similarly continuous, causing the global's value to update each calculation cycle.

How-to's

See also

Panels en Globals (Dutch only)
Editor ribbon icon current.pngCurrent Situation
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
Neighborhood • Zone • Permission Popup • Plot • Zip Code
Geo Import
Source • GeoShare
Network
Net Cluster • Net Function • Net Line • Net Load • Net Node • Net Setting
Editor
Current Situation • Future Design • Multi Scenario • Tools • Community
Retrieved from "https://support.tygron.com/w/index.php?title=Global&oldid=53963"