Metis Smart Modeling - Variables
From Metis Documentation
| Line 1: | Line 1: | ||
| - | Description | + | {| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" |
| + | |- | ||
| + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Type | ||
| + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Icons | ||
| + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Description | ||
| + | |- | ||
| + | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| + | '''Variables''' | ||
| + | | width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| + | [[File:MetisSmartModelingVariableGroupIcon.png|link=]] | ||
| + | | width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| + | A symbolic name associated with a value and whose associated value may be changed. | ||
| + | |- | ||
| + | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" | | ||
| + | '''Group of items''' | ||
| + | | width="5%" style="text-align:center; border-style: solid; border-color: grey; border-width: 0 1px 0 0" | | ||
| + | [[File:MetisSmartModelingVariableIcon.png|link=]] | ||
| + | | width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" | | ||
| + | Represents a higher level than variables, which can include variables as well as positions. | ||
| + | |- | ||
| + | |} | ||
| + | |||
== What is a variable? == | == What is a variable? == | ||
| - | A variable is a symbolic name given to some quantity, for the purpose of allowing the name to be used independently of the information it represents. The scope of a variable is local to the model it is used in. On the other hand, its extend is limited to the | + | |
| + | A variable is a symbolic name given to some quantity, for the purpose of allowing the name to be used independently of the information it represents. The scope of a variable is local to the [[Metis_Smart_Modeling_-_Models|model]] it is used in. On the other hand, its extend is limited to the [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] its used as an input or output. The value linked to a variable may change during the execution of a [[Metis_Smart_Modeling_-_Models|model]]. | ||
| + | |||
| + | |||
| + | [[File:MetisSmartModelingSCVariablesList.PNG|center|850x860px]] | ||
{| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | {| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | ||
|- | |- | ||
| - | ! colspan="2" scope=col style="border-style: solid; border-color: grey; border-width: 0 | + | ! colspan="2" scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Variables can be used for the following "tasks" in Metis Smart Modeling: |
|- | |- | ||
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
'''Systems''' | '''Systems''' | ||
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Limits : As object and filter for setting limits on systems. | + | [[Metis_Smart_Modeling_-_Systems#Limits|Limits]] : As object and filter for setting limits on systems. |
| - | Default Configuration : As object representing base configuration for systems. | + | [[Metis_Smart_Modeling_-_Systems#Default_Configuration|Default Configuration]] : As object representing base configuration for systems. |
|- | |- | ||
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| - | '''Masks''' | + | '''[[Metis_Smart_Modeling_-_Masks|Masks]]''' |
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Links : As target for values given to most field types which can be inserted in masks. | + | [[Metis_Smart_Modeling_-_Masks#Object_properties|Links]] : As target for values given to most field types which can be inserted in [[Metis_Smart_Modeling_-_Masks|masks]]. |
| - | Dependencies : As conditions for field display in masks. | + | [[Metis_Smart_Modeling_-_Masks#Applying_conditional_display_to_objects|Dependencies]] : As conditions for field display in [[Metis_Smart_Modeling_-_Masks|masks]]. |
|- | |- | ||
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" | | | width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" | | ||
| - | '''Rules''' | + | '''[[Metis_Smart_Modeling_-_Rules|Rules]]''' |
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" | | | width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" | | ||
| - | Filter : As conditions to execute a rule. | + | [[Metis_Smart_Modeling_-_Rules#What_is_a_rule.3F|Filter]] : As conditions to execute a [[Metis_Smart_Modeling_-_Rules|rule]]. |
| - | Rule : As input or output of the execution part of a rule. | + | [[Metis_Smart_Modeling_-_Rules|Rule]] : As input or output of the execution part of a [[Metis_Smart_Modeling_-_Rules|rule]]. |
| - | Add-on : As additional output of a rule. | + | [[Metis_Smart_Modeling_-_Rules#What_is_a_rule.3F|Add-on]] : As additional output of a [[Metis_Smart_Modeling_-_Rules|rule]]. |
|- | |- | ||
|} | |} | ||
| - | + | [[File:MetisSmartModelingSCVariables1.PNG|center|600x400px]] | |
| + | |||
| + | |||
| + | * '''Name''' (mandatory) : A description for the variable. | ||
| + | * '''Comment - Title''' : Title for the comment which can be given to a variable. | ||
| + | * '''Comment - Description''' : Description for the comment which can be given to a variable. This comment is very useful to better describe the variables. | ||
| + | |||
| + | |||
| + | {{Tip | ||
| + | | Variables can be defined within most part of the Metis Smart Modeling application where variable are used. This means that variables can be created as needed. Be careful not to generate redundancy or ignore the list when associating a variable with an object, a [[Metis_Smart_Modeling_-_Rules|rule]] or a [[Metis_Smart_Modeling_-_Masks|mask]]. | ||
| + | }} | ||
| + | |||
| + | |||
| + | |||
| + | == What is a group of items? == | ||
| + | |||
| + | A group of items represents a higher level than variables. It may contain variables, positions, and most importantly groups of items themselves. This higher level is very useful when assembling different types of variables. The value linked to a group of variable once used will be the addition of the values linked to its content. Meaning that if a group of items includes two different variables holding each 3 and 5 as values, the value of the group will be 8. | ||
| + | |||
| + | When used in a [[Metis_Smart_Modeling_-_Rules|rule]] or [[Metis_Smart_Modeling_-_Models|model]], it works the same way as a simple variable. The only difference is that the output of a [[Metis_Smart_Modeling_-_Rules|rule]] (or add-on) cannot be applied on a group of items . The can only be used as input. | ||
{| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | {| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | ||
|- | |- | ||
| - | ! | + | ! colspan="2" scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Groups of items can be used for the following "tasks" in Metis Smart Modeling: |
| - | + | ||
| - | + | ||
|- | |- | ||
| - | | width=" | + | | width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | |
| - | ''' | + | '''Systems''' |
| - | + | ||
| - | + | ||
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | + | Limits : As object and filter for setting limits on systems. | |
|- | |- | ||
| - | | width=" | + | | width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | |
| - | ''' | + | '''[[Metis_Smart_Modeling_-_Masks|Masks]]''' |
| - | | width=" | + | | width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | |
| - | [[ | + | Dependencies : As conditions for field display in [[Metis_Smart_Modeling_-_Masks|masks]]. |
| + | |- | ||
| + | | width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" | | ||
| + | '''[[Metis_Smart_Modeling_-_Rules|Rules]]''' | ||
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" | | | width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 0 0" | | ||
| - | + | Filter : As conditions to execute a [[Metis_Smart_Modeling_-_Rules|rule]]. | |
| + | |||
| + | [[Metis_Smart_Modeling_-_Rules|Rule]] : As input of the execution part of a [[Metis_Smart_Modeling_-_Rules|rule]]. | ||
|- | |- | ||
|} | |} | ||
| - | |||
| - | |||
| - | + | The content of a group of items can be defined as a list of elements which will be added to determine the value stored in the group. Each element of the list can be either a position, a variable or a group of items. For each of those, a factor can be defined in order to multiply the value provided by the element. | |
| + | |||
| + | |||
| + | [[File:MetisSmartModelingSCVariables2.PNG|center|600x400px]] | ||
| + | |||
| + | |||
| + | * '''Name''' (mandatory) : A name for the group of items. | ||
| + | * '''Content''' (mandatory) : List which specifies the content of the group of items. It can contain either positions, variables or other group of items. | ||
| + | * '''Comment''' : A comment can be given to all group of items. Please refer to the description of variables for details. | ||
| + | |||
| + | |||
| + | {{Note | ||
| + | | There is a limit to the number of levels of groups of items inside groups of items. It is set to 10. | ||
| + | }} | ||
| + | |||
| + | |||
| + | Using the "test" button [[File:MetisSmartModelingTestButton.PNG|link=]] displayed on the main variable screen, it is possible to have an overview of the group of items. The functionality is intended to enable the user to analyze the content of a group. For example, if a group of items includes other groups, the test window will dismantle the object down to individual variables and positions. This allows the user to validate the construction of any group of items created in Metis Smart Modeling. The list displayed in the window also show the factors defined on the elements included in the group. | ||
| + | |||
| + | |||
| + | [[File:MetisSmartModelingSCGroupOfRulesTest.PNG|center|600x400px]] | ||
| + | |||
| + | |||
| + | {{Warning | ||
| + | | The test window doesn't allow to simulate values being given to the various elements. | ||
| + | }} | ||
| + | |||
== Creating a new variable and group of items== | == Creating a new variable and group of items== | ||
| - | |||
| - | <mediaplayer width=' | + | In the '''Variables''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new variable and group of items. A small window opens with “variable” and “group of items” as the two create options. Select “Variable” and confirm to continue. |
| + | This opens the “Variable” window. In the “Name” field, enter a name for the variable. For example, “$SelectChoice.” | ||
| + | A title and description can also be entered to better describe the use of the variable. Click on confirm. The new variable is now added to the list. Now, to create a group of items, click once again on the “add” button. | ||
| + | This time, choose “Group of Items” and confirm. In the “Name” field, enter for example, “$NB_Screens.” | ||
| + | Next, click on the “add” button. It is possible to add positions, variables or [[Metis_Smart_Modeling_-_Attributes|attributes]]. Make sure that “positions” is selected at the top. | ||
| + | Now, use the search filter to find the desired positions. | ||
| + | For example, in the “Description” field, enter “LCD” and click on “Filter.” | ||
| + | The search results appear. | ||
| + | Tick the check-box for the desired items and then click on confirm. | ||
| + | The selected items now appear in the “Content” tab. | ||
| + | Click on the “comment” tab. | ||
| + | Here a title and description can be entered to better describe the use of the group of items. | ||
| + | Click on confirm to save the new group of items. The group of items is now created. | ||
| + | |||
| + | |||
| + | {{Video | ||
| + | | <mediaplayer width='400' height='300'>File:Creating_a_variable_and_group_of_items_OK.mp4</mediaplayer> | ||
| + | | Creation and definition of a variable and a group of items. | ||
| + | }} | ||
| Line 74: | Line 158: | ||
| When defining variables, it is very useful to not only provide a description and a comment but also to define a "syntax" throughout all the variable which are created (for example: start a boolean value with a "b" and numerical values with an "n"). | | When defining variables, it is very useful to not only provide a description and a comment but also to define a "syntax" throughout all the variable which are created (for example: start a boolean value with a "b" and numerical values with an "n"). | ||
}} | }} | ||
| + | |||
| + | |||
== Modifying a variable and group of items== | == Modifying a variable and group of items== | ||
| - | + | In the '''Variables''' sub-menu, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main table allows the user/administrator to apply modifications to all properties related to the selected variable or group of items. Selecting a variable or group of items and clicking on it opens the corresponding edition window where all related properties and information can be edited. | |
| + | |||
| + | |||
| + | For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new variable or group of items. Modifications applied to the selected variable or group of items will only be saved once the edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the table displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window. | ||
| + | |||
| + | |||
| + | {{Note| When a variable is renamed, it is still valid anywhere it is used ([[Metis_Smart_Modeling_-_Masks|masks]], [[Metis_Smart_Modeling_-_Systems|systems ]] and [[Metis_Smart_Modeling_-_Rules|rules]]). Links are only broken when deleted! | ||
| + | }} | ||
| + | |||
| + | |||
| + | |||
| + | == Deleting a variable and group of items == | ||
| + | |||
| + | In the '''Variables''' sub-menu, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main table allows the user/administrator to delete the selected variable or group of items. Selecting one or more variables or groups of items and clicking on it displays the following confirmation window. | ||
| + | |||
| + | |||
| + | [[File:MSM-Modeling-Variables-Del.png|center]] | ||
| + | |||
| - | + | Once the warning is confirmed, the selected variable or group of items is removed from Metis Smart Suite and deleted from the Metis Database. | |
| - | + | ||
{{Warning | {{Warning | ||
| - | | Deleted variables or groups will render the masks and rules to which they are linked unusable! | + | | Deleted variables or groups will render the [[Metis_Smart_Modeling_-_Masks|masks]] and [[Metis_Smart_Modeling_-_Rules|rules]] to which they are linked unusable! |
}} | }} | ||
{{Note | {{Note | ||
| - | | In order to verify a rule or a group of rules for missing variables, use the "Validate" function available under to | + | | In order to verify a [[Metis_Smart_Modeling_-_Rules|rule]] or a [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] for missing variables, use the "Validate" function available under to "[[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]]" sub-menu. This functionality will display any errors appearing in the selected [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]]. |
}} | }} | ||