SMS:Dynamic Model Interface Schema: Difference between revisions
From XMS Wiki
Jump to navigationJump to search
No edit summary |
|||
| (632 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
__NOINDEX__ | |||
<center>'''Sorry the page you are looking for cannot be found.''' </center> | |||
[[File:Undercosntruction.png|center|200 px]] | |||
<center>'''We are working on creating a page for this topic.'''</center> | |||
[[SMS:SMS|Back to SMS]] | |||
<!-- | |||
{{TOCright}} | {{TOCright}} | ||
The dynamic model interface is available in SMS version 11.2 and later. It is primarily a tool for developers. The dynamic model interface provides a way to quickly generate an interface for a numeric model. | The dynamic model interface is available in SMS version 11.2 and later. It is primarily a tool for developers. The dynamic model interface provides a way to quickly generate an interface for a numeric model. | ||
Dynamic dialogs are a quick way to generate dialogs without having to compile code. To add or delete a widget on a dynamic dialog, the user simply modifies the XML document. | ==Dynamic Dialogs== | ||
Dynamic dialogs are a quick way to generate dialogs without having to compile code. To add or delete a widget on a dynamic dialog, the user simply modifies the XML document. When the modified document is loaded, the new/modified dialog exists. The XML document defines the layout, behavior and the different dialog controls. | |||
The dialog is divided into 2 sections | The dialog is divided into 2 sections: the tree view and the widget view. The tree is on the left side of the dialog and contains groups and items that represent data. Clicking on a group or item will result in the widget view being updated to match the selected tree or group item. | ||
* Order of the tree items and groups will match the order defined in the XML file. | * Order of the tree items and groups will match the order defined in the XML file. | ||
| Line 10: | Line 22: | ||
* Clicking on a single item will display associated widgets in widget view. | * Clicking on a single item will display associated widgets in widget view. | ||
* Tree item will also display the values in a non-editable field. | * Tree item will also display the values in a non-editable field. | ||
* Unique_name use format: file::unique_name#value | * Unique_name use format: file::unique_name#value | ||
* Multiple widgets, when displayed on the right side, can be expanded/collapsed. | |||
* Multiple widgets when displayed on right side can be expanded/collapsed | * Can have nested groups. | ||
* Can have nested groups | * Keywords are words SMS has reserved in the schema and can not be used as unique names. All keywords will start with a "#". | ||
* Keywords are words SMS has reserved in the schema and can not be used as unique names. All keywords will start with a | |||
===Available Keywords=== | |||
This is a list of available keywords. Additional keywords are defined with the various custom control widgets. Note that in changing from version 1 to version 2, all tags that were <code><custom_control_XXXX></code> were changed to <code><control_XXXX></code>. | |||
--> | |||
<!-- template for this section | |||
{|class=" | |||
|- | {|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;" | ||
|- | |||
|width=" | ! width="400" style="text-align:left;" colspan="2" | General Keywords | ||
|- style="background-color:#F0F0FF;" | |||
|''' | | width="100" style="text-align:left;" | '''entry''' | ||
| | | width="500" style="text-align:left;" | description or | ||
|- | |- | ||
|''' | | '''entry''' | ||
| | | description or | ||
|- style="background-color:#F0F0FF;" | |||
| '''entry''' | |||
| description or | |||
|- | |- | ||
|''' | | '''entry''' | ||
| | | description or | ||
|} | |} | ||
===== | --> | ||
<!-- | |||
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;" | |||
|- | |||
! width="400" style="text-align:left;" colspan="2" | General Keywords | |||
|- style="background-color:#F0F0FF;" | |||
| width="100" style="text-align:left;" | '''#card_name''' | |||
| width="500" style="text-align:left;" | | |||
|- | |- | ||
| | | '''#geom_name''' | ||
| | | name of geometry as it shows up in the project explorer | ||
|- style="background-color:#F0F0FF;" | |||
| '''#project_name''' | |||
| | |||
|- | |- | ||
|''' | | '''#value''' | ||
| | | | ||
|- style="background-color:#F0F0FF;" | |||
| '''#units''' | |||
| | |||
|- | |- | ||
|''' | | '''#xmdf_path''' | ||
| | | path inside the XMDF file | ||
|- style="background-color:#F0F0FF;" | |||
| '''#file_name''' | |||
| | |||
|- | |- | ||
|''' | | '''#file_path''' | ||
| | | | ||
|- style="background-color:#F0F0FF;" | |||
| '''#sms_path''' | |||
| path in sms project explorer once inside a geometric item | |||
|- | |- | ||
|''' | | '''#count''' | ||
| | | used for a widget in a table for counting the rows/columns | ||
|- style="background-color:#F0F0FF;" | |||
| '''#geom_guid''' | |||
| | |||
|} | |||
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;" | |||
|- | |||
! width="400" style="text-align:left;" colspan="2" | Arc Keywords | |||
|- style="background-color:#F0F0FF;" | |||
| width="140" style="text-align:left;" | '''#arc_id''' | |||
| width="460" style="text-align:left;" | | |||
|- | |- | ||
|''' | | '''#arc_count''' | ||
| | | | ||
|- style="background-color:#F0F0FF;" | |||
| '''#arc_point_count''' | |||
| | |||
|} | |} | ||
===== | {|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;" | ||
|- | |||
! width="400" style="text-align:left;" colspan="2" | Coverage Keywords | |||
|- style="background-color:#F0F0FF;" | |||
| width="160" style="text-align:left;" | '''#area_property ''' | |||
| width="440" style="text-align:left;" | | |||
|- | |- | ||
| | | '''#activity_classification''' | ||
| | | | ||
|- style="background-color:#F0F0FF;" | |||
| '''#cgrid_generator''' | |||
| | |||
|- | |- | ||
|''' | | '''#location''' | ||
| | | | ||
|- style="background-color:#F0F0FF;" | |||
| '''#mapping''' | |||
| | |||
|- | |- | ||
|''' | | '''#mesh_generator''' | ||
| | | | ||
|- style="background-color:#F0F0FF;" | |||
| '''#observation''' | |||
| | |||
|- | |- | ||
|''' | | '''#quadtree_generator''' | ||
| | | | ||
|- style="background-color:#F0F0FF;" | |||
| '''#spectral''' | |||
| | |||
|} | |||
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;" | |||
|- | |||
! width="400" style="text-align:left;" colspan="2" | executable_progress_update Keywords | |||
|- style="background-color:#F0F0FF;" | |||
| width="140" style="text-align:left;" | '''#progress_amount''' | |||
| width="460" style="text-align:left;" | | |||
|- | |- | ||
|''' | | '''#progress_max''' | ||
| | |||
| | |||
|} | |} | ||
===== | {|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;" | ||
|- | |||
! width="400" style="text-align:left;" colspan="2" | Material Keywords | |||
|- style="background-color:#F0F0FF;" | |||
| width="120" style="text-align:left;" | '''#material_id''' | |||
| width="480" style="text-align:left;" | | |||
|- | |- | ||
| | | '''#material_name''' | ||
| | | | ||
|- style="background-color:#F0F0FF;" | |||
| '''#material_count''' | |||
| | |||
|- | |- | ||
|''' | | '''#unassigned''' | ||
| | | | ||
|} | |||
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;" | |||
|- | |||
! width="400" style="text-align:left;" colspan="2" | Point Keywords | |||
|- style="background-color:#F0F0FF;" | |||
| width="100" style="text-align:left;" | '''#point_count''' | |||
| width="500" style="text-align:left;" | | |||
|- | |- | ||
|''' | | '''#point_id''' | ||
| | | | ||
|- style="background-color:#F0F0FF;" | |||
| '''#point_x''' | |||
| | |||
|- | |- | ||
|''' | | '''#point_y''' | ||
| | | | ||
|- | |- style="background-color:#F0F0FF;" | ||
|''' | | '''#point_z''' | ||
| | | | ||
|} | |||
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;" | |||
|- | |||
! width="400" style="text-align:left;" colspan="2" | Polygon Keywords | |||
|- style="background-color:#F0F0FF;" | |||
| width="160" style="text-align:left;" | '''#polygon_id''' | |||
| width="440" style="text-align:left;" | | |||
|- | |- | ||
|''' | | '''#polygon_count''' | ||
| | | | ||
|- style="background-color:#F0F0FF;" | |||
| '''#polygon_point_count''' | |||
| | |||
|} | |} | ||
===== | {|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;" | ||
|- | |||
! width="400" style="text-align:left;" colspan="2" | Projection Keywords | |||
|- style="background-color:#F0F0FF;" | |||
| width="140" style="text-align:left;" | '''#horizontal_datum''' | |||
| width="460" style="text-align:left;" | NAD83, NAD27, LOCAL | |||
|- | |- | ||
| | | '''#horizontal_system''' | ||
| | | UTM, STATE_PLANE, GEOGRAPHIC, LOCAL | ||
|- style="background-color:#F0F0FF;" | |||
| '''#horizontal_units''' | |||
| FEET, METERS, DEGREES | |||
|- | |- | ||
|''' | | '''#horizontal_zone''' | ||
| | | 3104, etc. | ||
|- style="background-color:#F0F0FF;" | |||
| '''#vertical_datum''' | |||
| | |||
|- | |- | ||
|''' | | '''#vertical_units''' | ||
| | |||
|} | |||
| | |||
| | |||
==Elements== | |||
Sorted alphabetically by element name. | |||
=====Element | ===Elements A-C=== | ||
{{XML entry | |||
| | | name = arc_att | ||
| | | info = Used to specify what attributes should be used for the arcs of a coverage. | ||
| | | version = 2 | ||
| | | attributes = none | ||
| children = [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]] | |||
| example = | |||
}} | |||
|none | --> | ||
| | <!--obsolete | ||
{{XML entry | |||
| name = attribute_set | |||
| | | info = This represents an item in the project explorer that is some sort of grouping. | ||
| version = 4 | |||
|[[SMS:Dynamic Model Interface Schema#Element < | | attributes = none | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Elements <takes>|takes]], [[SMS:Dynamic Model Interface Schema#Elements <menu_item>|menu_item]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Elements <model>|model]] | |||
| example = See the model example. | |||
}}--> | |||
<!-- | |||
{{XML entry | |||
| name = card | |||
| info = Determines the card name and format when the item is exported. For more examples see [[SMS:Dynamic Model Interface Schema#Element <export_format>|<export_format>]]. | |||
| version = 1 | |||
| attributes = none | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], anything beginning with "process_", [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Attribute <use_parameter>|use_paramter]]. | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], file_def | |||
| example = <item text = "Formulation"> | |||
<card> | <card> | ||
<card_name>FORMULATION</card_name> | <card_name>FORMULATION</card_name> | ||
<export_format>card "formulationUnits"</export_format> | <export_format>card "formulationUnits"</export_format> | ||
</card> | </card> | ||
}} | |||
|} | {{XML entry | ||
| name = card_name | |||
| info = The name of the card which is used in the card file. | |||
| version = 1 | |||
| attributes = none | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]] | |||
| example = | |||
}} | |||
{{XML entry | |||
{ | | name = check_box | ||
| | | info = Widget that displays text that is checked/unchecked. | ||
| version = 1 | |||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Element <default>|default]], [[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text_checked]], [[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text_unchecked]], [[SMS:Dynamic Model Interface Schema#Element <text>|text]], [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]]. | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]] | |||
| example = | |||
<check_box text = "Calculate Sediment Transport" | |||
default = "checked" | |||
unique_name = "togCalcSedimentTransport" | |||
export_text_checked = "ON" | |||
export_text_unchecked = "OFF"> | |||
<dependency>…</dependency>… | |||
|[[SMS:Dynamic Model Interface Schema#Element < | |||
| | |||
<check_box | |||
</ check_box > | </ check_box > | ||
}} | |||
{{XML entry | |||
| name = color | |||
| info = The color of an item, expressed in red, green, and blue values ranging from 0 to 255. All 0 values for red, green and blue are black. Added in SMS 11.2. | |||
{ | | version = 1 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <blue>, <green>, <red>|red]], | ||
[[SMS:Dynamic Model Interface Schema#Attribute <blue>, <green>, <red>|green]], | |||
| | [[SMS:Dynamic Model Interface Schema#Attribute <blue>, <green>, <red>|blue]] | ||
| | | children = none | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| example = | |||
|[[SMS:Dynamic Model Interface Schema# | |||
| | |||
|[[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| | |||
This would change the text to a bright red color. | This would change the text to a bright red color. | ||
<text_style> | <text_style> | ||
<color | <color red = "255" green="0" blue="0"></color> | ||
<text_style> | <text_style> | ||
}} | |||
{{XML entry | |||
| name = column | |||
| info = Definition of the column in the table. A widget defined in a column will be the widget used for each cell in the column. | |||
{ | | version = 1 | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Element <text>|text]], [[SMS:Dynamic Model Interface Schema#Element <read_only>|read_only]], | |||
| | [[SMS:Dynamic Model Interface Schema#Element <optional>|optional]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], all elements starting with "control_", [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element < table >|table]] | ||
| example = Column1 is read only, Column 2 isn't read only and is also optional.<br/> This means the column can have empty fields and a warning message won't be displayed. | |||
table | |||
. . . | |||
<column text = "Column1" read_only> | |||
</column> | |||
< column text = "Column2 optional></ column> | |||
| | </table> | ||
| | }} | ||
| | |||
<column | |||
</ column > | |||
< column | |||
{{XML entry | |||
{ | | name = combo_box | ||
| info = Widget that displays list of options. Only 1 can be selected. If no default is specified and the optional tag is present, then an empty option will be added to the combo box. If there is no default tag, and no optional tag, then the first item will be default. | |||
| | |||
| | |||
Widget that displays list of options. Only 1 can be selected. If no default is specified and the optional tag is present, then an empty option will be added to the combo box. If there is no default tag, and no optional tag, then the first item will be default. | |||
In version 2, if a combo box has | In version 2, if a combo box has display_options, and is part of a dialog that is used as an arc attribute, then a limited set of display options will appear for the options of the combo box. The display option for each option of the combo box will only be line thickness and color. The display option is NOT saved at any point and will be reset every time SMS is opened. | ||
| version = 1 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <optional>|optional]], [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], [[SMS:Dynamic Model Interface Schema#Element <display_options>|display_options]] | |||
|1 | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | ||
| | | example = Creates a combo box with hours, minutes and seconds. Hours is the default item. | ||
<combo_box unique_name="cbxTransportUnits"> | |||
<option text = "hours" default></option> | |||
<option text = "minutes"></option> | |||
<option text = "seconds"></option> | |||
<dependency>…</dependency>… | |||
| | |||
| | |||
<combo_box | |||
<option | |||
<option | |||
</ combo_box > | </ combo_box > | ||
}} | |||
|} | {{XML entry | ||
| name = command_args | |||
| info = Defines the command line arguments to run a particular executable. | |||
| version = 3 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <use_file>|use_file]] | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]] | |||
| example = See executable example. | |||
}} | |||
{{XML entry | |||
{ | | name = comment | ||
| info = Defines a character or sequence of characters that defines the start of a comment on a line. Comments are always terminated by an end of line. | |||
| | | version = 2 | ||
| attributes = none | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_file>|declare_file]] | |||
| example = The following example has a file where the exclamation point starts the comment. | |||
| | |||
| | |||
| | |||
| | |||
| | |||
<file_def> | <file_def> | ||
| Line 417: | Line 362: | ||
… | … | ||
</file_def> | </file_def> | ||
}} | |||
| | {{XML entry | ||
| name = condition | |||
| info = Evaluates two or more objects using GREATER_THAN, GREATER_THAN_EQUALS, LESS_THAN, LESS_THAN_EQUALS, EQUALS, AND, OR, NOT, CHECKED, UNCHECKED, EMPTY. If condition is not met, then message is displayed (if model_check) or widget is hidden/dimmed (if dependency). String literals, such as an entry in a combo-box, must be enclosed in double-quotes (ex. "Combo box entry"). | |||
| version = 1 | |||
| attributes = none | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]], [[SMS:Dynamic Model Interface Schema#Element <model_check_condition>|model_check_condition]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <snap_exterior>|snap_exterior]], [[SMS:Dynamic Model Interface Schema#Element <snap_interior>|snap_interior]], [[SMS:Dynamic Model Interface Schema#Element <take_coverage>|take_coverage]], [[SMS:Dynamic Model Interface Schema#Element <take_mesh2d>|take_mesh2d]], [[SMS:Dynamic Model Interface Schema#Element <take_cgrid2d>|take_cgrid2d]], [[SMS:Dynamic Model Interface Schema#Element <take_quadtree>|take_quadtree]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| example = See below | |||
< table > | < table > | ||
<column | <column text="A"> | ||
<edit_box unique_name="colA"> | |||
<edit_box | |||
</edit_box> | </edit_box> | ||
</column> | </column> | ||
…// other columns also defined | |||
<model_check> | <model_check problem_text="Column D or E is required"> | ||
<condition>( (colA EQUALS 0.0 OR colB LESS_THAN 0.0) | <condition>( (colA EQUALS 0.0 OR colB LESS_THAN 0.0) AND NOT(colD NOT EQUALS EMPTY OR colE NOT EQUALS "Some value"))</condition> | ||
</model_check> | </model_check> | ||
</ table > | < /table > | ||
}} | |||
{{XML entry | |||
{ | | name = contains | ||
| | | info = Holds all the groups and items of a group. | ||
| version = 2 | |||
| | | attributes = none | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <declare_page>|declare_page]], | |||
| example = | |||
| | }} | ||
| | |||
| | |||
| group | |||
| | |||
| | |||
{{XML entry | |||
{ | | name = control_curve | ||
| info = Displays a curve push button. When pushed, the xy curve values can be updated and a curve is displayed. | |||
| | | version = 2 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <flags>|flags]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]], [[SMS:Dynamic Model Interface Schema#Attribute <max_row_count>|max_row_count]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <x_column>|x_column]], [[SMS:Dynamic Model Interface Schema#Element <y_column>|y_column]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], [[SMS:Dynamic Model Interface Schema#Element <populate_method>|populate_method]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | |||
| example = This example creates a curve limited to 10 rows. | |||
| | |||
| [[SMS:Dynamic Model Interface Schema# | |||
| | |||
| [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | |||
| | |||
<item> | <item> | ||
<control_curve | <control_curve unique_name="myCurve1" | ||
max_row_count="10" | |||
flags = "XY_USEDATE"> | |||
<x_column text="Time"></x_column> | |||
<x_column | <y_column text="Velocity"> | ||
<y_column | |||
</y_column> | </y_column> | ||
</control_curve> | </control_curve> | ||
… | |||
}} | |||
{{XML entry | |||
| name = control_dataset | |||
| info = Displays an edit box, and push buttons for select, delete and create. Once selected, the dataset string is placed into the edit box. The dataset_type can be scalar or vector. Possible keyword outputs are file_name (which is the name of the dataset without path), geom_name, and file_path (full path c:\somewhere) and sms_path. | |||
By default, all datasets of geometries that are part of the simulation (or part of the parameters if one or more use_parameter is used) can be selected. The the geometry attribute is set to "all", then the datasets from all geometries currently loaded into SMS can be selected from, regardless of relation to the simulation and assuming no other attribute prevents it. If "all" is used, then the dataset values will be interpolated to the geometry in the simulation. | |||
The time_type attribute can be set to "all" (default), "transient", or "steady state". When "transient" is used, only datasets with multiple timesteps may be selected. When "steady state" is used, only timesteps without timesteps may be selected. | |||
The select_time attribute can be set to "all" (default), "single", or "range". If "single" is used, then only a single timestep of the dataset will be selected. If "range" is used, then both a starting and ending timestep can be selected. By default, all timesteps of a dataset are used. | |||
| version = 1 (<custom_control_XXXX>), 2 | |||
|1 (<custom_control_XXXX>), 2 | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <geometry>|geometry]], [[SMS:Dynamic Model Interface Schema#Attribute <type>|type]], [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]], [[SMS:Dynamic Model Interface Schema#Attribute <export_text>|export_text]], [[SMS:Dynamic Model Interface Schema#Attribute <inactive_export_text>|inactive_export_text]], [[SMS:Dynamic Model Interface Schema#Attribute <time_type>|time_type]], [[SMS:Dynamic Model Interface Schema#Attribute <select_time>|select_time]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]], [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]],[[SMS:Dynamic Model Interface Schema#Attribute <name>|name]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <push_button>|push_button]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <text>|text]], [[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | ||
| | | example = This example creates the custom control with only the select and delete buttons. | ||
| | |||
| | |||
| | |||
| | |||
| [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | |||
| | |||
<item> | <item> | ||
<control_dataset> | <control_dataset dataset_type="scalar"> | ||
<push_button>select<push_button> | <push_button>select<push_button> | ||
<push_button>delete</push_button> | <push_button>delete</push_button> | ||
</control_dataset> | </control_dataset> | ||
… | |||
}} | |||
{{XML entry | |||
| name = control_date | |||
| info = Displays date and time selector, where a date can be selected.<br/> Possible output is value, which will be the date formatted as specified in SMS preferences.<br/> Possible outputs are year, month, day, hour, minute, second. | |||
{ | |||
| | |||
| | |||
Keywords: | Keywords: | ||
| Line 577: | Line 464: | ||
* #AM_PM | * #AM_PM | ||
* #AM_PM_CAPS | * #AM_PM_CAPS | ||
| | | version = 1 (<custom_control_XXXX>), 2 | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | ||
| example = | |||
<item text ="Start date> | |||
<control_date unique_name="edtDate"> | |||
| | |||
| | |||
<item | |||
<control_date | |||
</control_date> | </control_date> | ||
<card> | <card> | ||
<card_name>DATE</card_name> | <card_name>DATE</card_name> | ||
<export_format>"%s Day:%s Month:%s Year:%s Hour:%s Minute%s | <export_format>"%s Day:%s Month:%s Year:%s Hour:%s Minute%s Second:%s\n", #card_name, edtDate#DAY_DIGIT, edtDate#MONTH_LONG_NAME, edtDate#YEAR_4, edtDate#HOUR_24, edtDate#MINUTE_ZERO, edtDate#SECOND_ZERO</export_format> | ||
</card> | </card> | ||
}} | |||
{{XML entry | |||
{ | | name = control_density | ||
| info = Displays an edit box and combo box. Combo box can contain kg/m^3, gr/cm^3, lb/ft^3. Possible outputs are value and units. | |||
| | |||
| | |||
Keywords: | Keywords: | ||
| Line 620: | Line 488: | ||
* #MPV_G_PER_CU_CM | * #MPV_G_PER_CU_CM | ||
* #MPV_LB_PER_CU_FT | * #MPV_LB_PER_CU_FT | ||
| | | version = 1 (<custom_control_XXXX>), 2 | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Element <default>|default]], [[SMS:Dynamic Model Interface Schema#Attribute <precision>|precision]], [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <populate_method>|populate_method]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | ||
| example = | |||
Displays kg/m^3 and lb/ft^3 in combo box. If kg/m^3 selected and exported, returns the text "kg m". | |||
| | |||
| | |||
Displays kg/m^3 and lb/ft^3 in combo box. If kg/m^3 selected and exported, returns the text | |||
<item> | <item> | ||
<text>Density </text> | <text>Density </text> | ||
<control_density> | <control_density> | ||
<option | <option text="kg/m^3" | ||
export_text = "kg m" | |||
unit_keyword="#MPV_KG_PER_CU_M"> | |||
</option> | </option> | ||
<option | <option text="lb_ft^3" | ||
export_text ="lbs ft" | |||
unit_keyword = "#MPV_LB_PER_CU_FT"> | |||
</option> | </option> | ||
</control_density> | </control_density> | ||
… | … | ||
}} | |||
{{XML entry | |||
| name = control_duration | |||
| info = Displays an edit box and combo box. Combo box contains days, hours, minutes, seconds. Possible outputs are value and units. | |||
{ | |||
| | |||
| | |||
Keywords: | Keywords: | ||
| Line 667: | Line 520: | ||
* #TIME_WEEKS | * #TIME_WEEKS | ||
* #TIME_YEARS | * #TIME_YEARS | ||
| | | version = 1 (<custom_control_XXXX>), 2 | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], [[SMS:Dynamic Model Interface Schema#Attribute <precision>|precision]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <populate_method>|populate_method]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | ||
| example = Displays only minutes and hours in combo box. If hours selected and exported, returns the text "hrs". | |||
<item text ="Transport Time Step"> | |||
| | |||
| | |||
<item | |||
<control_duration> | <control_duration> | ||
<option | <option text="minutes" | ||
export_text = "min" | |||
unit_keyword = "#TIME_MINUTES"> | |||
</option> | </option> | ||
<option | <option text = "hours" | ||
export_text = "hrs" | |||
unit_keyword = "#TIME_HOURS" | |||
default> | |||
</option> | </option> | ||
</control_duration> | </control_duration> | ||
… | … | ||
}} | |||
{{XML entry | |||
| name = control_executable | |||
| info = Displays a button for running a simulation from a dialog. Unlike the normal simulations found in the project explorer, these simulations are generally hidden from the user. As such, the options that can be used are significantly less than those of a normal simulation. | |||
|} | The model attribute defines the name of the model to be executed. The model may be one that is already defined by another XML file. Dialogs can be specified for data that will be kept for the model, but will not be shown to the user. The simulation and files specified with this control may not be the same as one already specified in another XML file. | ||
| version = 3 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <model>|model]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], [[SMS:Dynamic Model Interface Schema#Element <declare_dialogs>|declare_dialogs]], [[SMS:Dynamic Model Interface Schema#Element <declare_files>|declare_files]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]], dependency, text_style, [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]] | |||
| example = This example declares a control_executable that runs "MyModel". | |||
<control_executable model = "MyModel" | |||
unique_name="exeMyModel"> | |||
<declare dialogs> | |||
<declare dialog name="Arc BC"> | |||
<pages> | |||
<page_def name="ArcBC" | |||
display="NO_NAV"> | |||
<contains> | |||
<item> | |||
<edit_box unique_name="edtMyModelText"> | |||
</edit_box> | |||
</item> | |||
</contains> | |||
</page_def> | |||
</pages> | |||
</dialog> | |||
</dialogs> | |||
<simulation> | |||
<executable name ="MyModel"> | |||
<use_parameter>HydroFile</use_parameter> | |||
<execute_command> | |||
<command_args>" \"%s\"", edtMyModelText</command_args> | |||
<execute>"%s", #executable_name</execute> | |||
</execute_command> | |||
</executable> | |||
<input_files> | |||
<input_file> | |||
<use_file_def>myFile</use_file_def> | |||
<export_location>"%s.srhhydro", #project_name</export_location> | |||
<declare_parameter>HydroFile</declare_parameter> | |||
<input_file> | |||
</input_files> | |||
</simulation> | |||
<files> | |||
<declare file_def name=MyFile type=CARD_ASCII> | |||
<comment>! this is myfile</comment> | |||
</declare file_def> | |||
</files> | |||
</control_executable> | |||
}} | |||
=====Element | {{XML entry | ||
| name = control_feature_selector | |||
| info = Push button that opens a canvas window that allows users to select one or more points, arcs or polygons that are in the main window. | |||
| version = 3 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <feature>|feature]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <range>|range]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | |||
| example = Allows the user to select 1 to 10 arcs | |||
<item> | |||
<control_feature_selector feature = "arc"> | |||
unique_name="mySelector"> | |||
<range>1-10</range> | |||
</control_feature_selector> | |||
… | |||
}} | |||
| | {{XML entry | ||
| | | name = control_file_selector | ||
|1 (<custom_control_XXXX>), 2 | | info = Push button that opens a file open dialog to select files. Possible outputs are file_path. | ||
| | | version = 1 (<custom_control_XXXX>), 2 | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <create_file>|create_file]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <filter>|filter]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | ||
| example = Opens a file dialog, filtering on files with *.h5 and *.cmcards extensions | |||
| | |||
<item> | <item> | ||
<text>File:</text> | <text>File:</text> | ||
< | <control_file_selector | ||
filter = "Cmcards file (.cmcards)"> | |||
</ | </control_file_selector> | ||
… | … | ||
}} | |||
{{XML entry | |||
| name = control_length | |||
| info = Displays an edit box and combo box. Combo box can contain meters, cm, mm, um, ft, in. Possible outputs are value and units. | |||
{ | |||
| | |||
| | |||
Keywords: | Keywords: | ||
| Line 748: | Line 643: | ||
* #LEN_MILE | * #LEN_MILE | ||
* #LEN_UM | * #LEN_UM | ||
| | | version = 1 (<custom_control_XXXX>), 2 | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], [[SMS:Dynamic Model Interface Schema#Attribute <precision>|precision]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <populate_method>|populate_method]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | ||
| example = Displays only cm, and mm in combo box. If cm is selected and exported, returns the text "centimeter". | |||
<item text = "Length"> | |||
<control_length unique_name="myLength"> | |||
| | |||
| | |||
<item | |||
<control_length> | |||
<option> | <option> | ||
text = "cm" | |||
export_text="centimeter" | |||
unit_keyword = "#LEN_CM"> | |||
</option> | </option> | ||
<option> | <option> | ||
text = "mm" | |||
export_text = "mm"> | |||
unit_keyword="#LEN_MM" | |||
default | |||
</option> | </option> | ||
</control_length> | </control_length> | ||
… | |||
}} | |||
|} | {{XML entry | ||
| name = control_nesting | |||
| info = Push button that opens a special dialog to create nesting points. The dialog allows the user to select a parent and child grid and a coverage to put the nesting sites in. | |||
| version = 3 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | |||
| example = Creates the nesting dialog widget | |||
<item> | |||
<control_nesting unique_name="ccNesting"> | |||
</control_nesting> | |||
… | |||
}} | |||
{{XML entry | |||
| name = control_set | |||
| info = Table like widget that allows for multiple points, polygons, or arcs to be joined together as a set. An example usage would be to join two arcs in creating a weir. By default the <control_set> contains two columns, object and role. The object column identifies the arc, point, or poly id. The role column is a user defined combo box that allows for customization of types and behavior. See <roles>. Addition columns can be added by simply adding a <column> tag with a widget. See tables. When exporting you can use the #object or #role keyword for retrieving data from those particular columns. | |||
| version = 3 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <min>|min]] (default = 0), | |||
[[SMS:Dynamic Model Interface Schema#Attribute <max>|max]] (default = 2.147 billion), | |||
[[SMS:Dynamic Model Interface Schema#Attribute <increment>|increment]] (default is 1), | |||
[[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <roles>|roles]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]] | |||
| example = Example of a culvert widget with a extra "Name" column. The culvert requires 2 arcs. | |||
<control_set min = "2" | |||
max = "2" | |||
unique_name = "tblSetCulverts"> | |||
<roles behavior = "SWAP"> | |||
<role text = "upper"> | |||
<range>1-1</range> | |||
</role> | |||
<role text = "lower"> | |||
<range>1-1</range> | |||
</role> | |||
</roles> | |||
<column text = "Name"> | |||
<edit_box unique_name="edtMyArcsName" | |||
type="text"> | |||
</edit_box> | |||
</column> | |||
</control_set> | |||
User allows for either 2 or 4 arcs on a weir. | |||
<control_set min = "2" max = "4" increment = "2" > | |||
…. | |||
}} | |||
{{XML entry | |||
{ | | name = control_velocity | ||
| info = Displays an edit box and combo box. Combo box can contain m/sec, m/min, m/hours, etc.... Also could be m/sec, cm/sec, ft/sec, etc... The option tag specifies which options are displayed. The edit box will display doubles, within the given range, if provided. Possible outputs are value and units. | |||
| | |||
| | |||
Keywords: | Keywords: | ||
| Line 795: | Line 725: | ||
* #VEL_CM_PER_S | * #VEL_CM_PER_S | ||
* #VEL_MM_PER_S | * #VEL_MM_PER_S | ||
| | | version = 1 (<custom_control_XXXX>), 2 | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], [[SMS:Dynamic Model Interface Schema#Attribute <precision>|precision]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <populate_method>|populate_method]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | ||
| example = Displays m/sec and cm/sec in combo box. If m/sec selected and exported, returns the text "m sec". | |||
| | |||
| | |||
<item> | <item> | ||
<text>Velocity </text> | <text>Velocity </text> | ||
<control_velocity | <control_velocity unique_name="ccVelocity"> | ||
<range>0-100</range> | <range>0-100</range> | ||
<option | <option text="m/sec" | ||
export_text = "m sec" | |||
unit_keyword = "#VEL_M_PER_S"> | |||
</option> | </option> | ||
<option | <option text = "cm/sec" | ||
export_text = "cm sec"xt | |||
unit_keyword = "#VEL_CM_PER_S"> | |||
</option> | </option> | ||
</control_velocity> | </control_velocity> | ||
… | … | ||
}} | |||
{{XML entry | |||
| name = control_volume_flow | |||
| info = Displays an edit box and combo box. Combo box can contain m^3/sec, m^3/min, m^3/hours, etc.... Also could be m^3/sec, cm^3/sec, ft^3/sec, etc... The option tag specifies which options are displayed. The edit box will display doubles, within the given range, if provided. Possible outputs are value and units. | |||
{ | | version = 2 | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], [[SMS:Dynamic Model Interface Schema#Attribute <precision>|precision]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | |||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <populate_method>|populate_method]], [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | ||
| | | example = Displays m^3/sec and cm^3/sec in combo box. If m^3/sec selected and exported, returns the text "m^3 sec". | ||
<item text="Volume flow"> | |||
<control_volume_flow unique_name ="ccVolumeFlow"> | |||
| | |||
| | |||
| | |||
<item | |||
<control_volume_flow | |||
<range>0-100</range> | <range>0-100</range> | ||
<option | <option | ||
text = "m^3/sec" | |||
export_text = "m^3 sec" | |||
unit_keyword = "#VFLOW_CU_M_PER_SEC"> | |||
</option> | </option> | ||
<option | <option | ||
text = "cm^3/sec" | |||
export_text = "cm^3 sec" | |||
unit_keyword = "#VFLOW_CU_CM_PER_SEC"> | |||
</option> | </option> | ||
</control_volume_flow> | </control_volume_flow> | ||
… | … | ||
}} | |||
|} | {{XML entry | ||
| name = count_filter | |||
| info = Specifies the range on which the process_on_count is valid. | |||
| version = 2 | |||
| attributes = none | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_on_count>|process_on_count]] | |||
| example = | |||
}} | |||
===== | ===Elements D-H=== | ||
--> | |||
<!--obsolete | |||
| | {{XML entry | ||
| | | name = dataset_name | ||
| | | info = Determines the name of the dataset to be created. Uses the standard printf and sprintf format ([http://www.cplusplus.com/reference/clibrary/cstdio/printf/ www.cplusplus.com/reference/clibrary/cstdio/printf/]). The keywords #row_number, #column_number, #row_name, and #column_name are used when the dataset is in a table. | ||
| version = 1 | |||
| attributes = none | |||
| | | children = none | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]] | |||
|z_is_elev | | example = | ||
| | <control_dataset> | ||
| | <dataset_name>"Five percent Layer %d", #row_number</dataset_name> | ||
… | |||
| | </control_dataset> | ||
}}--> | |||
<!-- | |||
| | {{XML entry | ||
| name = declare_coverage | |||
| info = Defines a coverage type for the model. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <z_is_elev>|z_is_elev]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <bind_to>|bind_to]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <name>|name]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <use_icon>|use_icon]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <point_att>|point_att]], | |||
[[SMS:Dynamic Model Interface Schema#Element <arc_att>|arc_att]], | |||
[[SMS:Dynamic Model Interface Schema#Element <polygon_att>|polygon_att]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <material_att>|material_att]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <menu_item>|menu_item]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model>|model]] | |||
| example = This defines a coverage that can be created. | |||
< | <declare_coverage z_is_elev = "true" name="MyCov"> | ||
<point_att> | |||
<menu_item text = "Assign BC…" use_dialog = "NodeAtt"> | |||
</menu_item> | |||
</point_att> | |||
<arc_att> | |||
<menu_item text = "Assign BC…" use_dialog= "NodestringBC"> | |||
</menu_item> | |||
</arc_att> | |||
<menu_item | <material_att use_dialog= "MaterialProp"</material_att> | ||
</coverage> | </coverage> | ||
|} | }} | ||
{{XML entry | |||
| name = declare_dialogs | |||
| info = Contains all the dialogs used in a model. | |||
| version = 2 | |||
| attributes = none | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <declare_dialog>|declare_dialog]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_executable>|control_executable]], [[SMS:Dynamic Model Interface Schema#Element <model>|model]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = declare_dialog | |||
| info = Used to define a dialog. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <name>|name]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <help_button_url>|help_button_url]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <help_button_wiki>|help_button_wiki]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <pages>|pages]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <dialogs>|dialogs]] | |||
| example = | |||
}} | |||
{{XML entry | |||
{ | | name = declare_files | ||
| | | info = Contains all the files used in a model. | ||
| version = 3 | |||
| | | attributes = | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <declare_file>|declare_file]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <control_executable>|control_executable]], [[SMS:Dynamic Model Interface Schema#Element <model>|model]] | ||
| | | example = | ||
| | }} | ||
| | |||
| | |||
{{XML entry | |||
| name = declare_file | |||
| | | info = A way to declare a file that will be used in the future. | ||
| | | version = 3 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <control_file>|control_file]], [[SMS:Dynamic Model Interface Schema#Attribute <name>|name]], [[SMS:Dynamic Model Interface Schema#Attribute <file_type>|file_type]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <comment>|comment]], [[SMS:Dynamic Model Interface Schema#Element <identifier>|identifier]], [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <export>|export]], [[SMS:Dynamic Model Interface Schema#Element <process_each_row>|process_each_row]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_files>|declare_files]] | ||
| | | example = | ||
| | }} | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| [[SMS:Dynamic Model Interface Schema#Element < | |||
|} | |||
{{XML entry | |||
{ | | name = declare_pages | ||
| info = Signals the beginning of page creation for a dialog. One or more pages may be created using declare_page. | |||
| | | version = 3 | ||
| | | attributes = none | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <declare_page>|declare_page]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_dialog>|declare_dialog]] | |||
| example = | |||
<declare_dialog name ="Model Control"> | |||
<declare_pages> | |||
|none | <declare_page text="Page1"> | ||
| | …. | ||
| | </declare_pagef> | ||
| | <declare_page text ="Page2"> | ||
…. | |||
</declare_page> | |||
</declare_pages> | |||
| | }} | ||
{{XML entry | |||
{ | | name = declare_page | ||
| info = This defines the page or tab of a dialog. If there is only one page_def in a dialog, then no tabs will appear. | |||
| | | version = 3 | ||
| | | attributes = text, display | ||
| | | children = contains | ||
| | | used_by = declare_pages | ||
| example = | |||
| | }} | ||
| | |||
| | |||
== | {{XML entry | ||
| name = declare_parameter | |||
| | | info = A way to declare data that will be used in the future. | ||
| | | version = 3 | ||
| | | attributes = none | ||
| children = none | |||
| used_by = input_file, [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]], [[SMS:Dynamic Model Interface Schema#Element <output_file>|output_file]], anything beginning with "process_", [[SMS:Dynamic Model Interface Schema#Element <takes>|takes]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| | | name = dependency | ||
| | | info = Dependencies allow widgets to be hidden, dimmed (grayed out), or shown based on the state/value of another widget. The [[SMS:Dynamic Model Interface Schema#Element <dependency>|<dependency>]] tag can be placed in any widget, combo-box option, item, or group. A user needs to specify the condition that this object is dependent upon and what the value(s) need(s) to be in order for the object to be shown/not dimmed. If the condition is false, by default the control is hidden. To have the control dimmed, use the [[SMS:Dynamic Model Interface Schema#Element <dim>|<dim>]] tag. | ||
| version = 1 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <dim>|dim]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element < table >|table]], any element that begins with "control_", [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]] | |||
| example = '''Example 1''' | |||
We only want our edit_box displayed if the check_box is checked (true). If check_box is not checked, we want to dim (show but is grayed out) the edit_box. | |||
| | |||
| | |||
| | |||
| | |||
|'''Example 1''' | |||
<check_box | <check_box unique_name = "MyBox"> | ||
… | … | ||
<edit_box> | <edit_box> | ||
<dependency dim> | |||
<condition>MyBox EQUALS CHECKED</condition> | |||
</dependency> | |||
'''Example 2''' | |||
We want our text_box displayed if the edit_box has a value between 0-3 or if the combo box has the value minutes or days. | |||
<edit_box | <edit_box unique_name="MyEdit_box"> | ||
… | … | ||
<combo_box | <combo_box unique_name = "MyComboBox"> | ||
<option text = "hours"></option> | |||
<option text ="minutes"></option> | |||
… | |||
<text_box> | <text_box> | ||
<dependency> | |||
<condition>(MyEdit_box GREATER_THAN_EQUALS 0 AND MyEdit_box LESS_THAN_EQUALS 3) OR (MyComboBox EQUALS "minutes" OR MyComboBox EQUALS "days")</condition> | |||
</dependency> | |||
</text_box> | </text_box> | ||
}} | |||
|} | {{XML entry | ||
| name = display_options | |||
| info = Specifies that the options in the combo box are to be used as arc/nodestring boundary condition display options. This element should only be used once in a combo_box and once in a edit_box per dialog. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <type>|type]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <text>|text]] | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <control_set>|control_set]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]] | |||
| example = | |||
<combo_box unique_name="cbxArcDeleteMe"> | |||
<display_options type= "point" text ="Save Points Name"></display_options> | |||
<option text="Hydro" default></option> | |||
<option text="Sediment"></option> | |||
</combo_box> | |||
}} | |||
{{XML entry | |||
{ | | name = dynamic_model | ||
| info = Used to define a dynamic model. | |||
| | | version = 1 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <file_type>|file_type]] – always "dynamic model", | ||
| | [[SMS:Dynamic Model Interface Schema#Attribute <version>|version]] | ||
| children = [[SMS:Dynamic Model Interface Schema#Element <model>|model]] | |||
| used_by = none | |||
| | | example = | ||
}} | |||
| | |||
| | |||
| | |||
== | {{XML entry | ||
| name = edit_box | |||
| info = Widget that displays text or numbers. If [[SMS:Dynamic Model Interface Schema#Element <type>|<type>]] not specified, default to double. The type can also be text, or integer. | |||
| | | version = 1 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], [[SMS:Dynamic Model Interface Schema#Attribute <optional>|optional]], | ||
| | [[SMS:Dynamic Model Interface Schema#Attribute <precision>|precision]], [[SMS:Dynamic Model Interface Schema#Attribute <type>|type]], [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <range>|range]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], [[SMS:Dynamic Model Interface Schema#Element <display_options>|display_options]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | ||
| | | example = | ||
| | <edit_box type="double" | ||
| | default="1.0" | ||
| | unique_name="edtBox5" | ||
| | optional> | ||
| | <range>0, 2.2</range> | ||
<dependency>…</dependency>… | |||
</ edit_box > | |||
| [[SMS:Dynamic Model Interface Schema#Element < | }} | ||
| | |||
{{XML entry | |||
{ | | name = end_card | ||
| info = Defines that the card end with a single iteration of the enclosing <process_> | |||
| | | version = 1 | ||
| | | attributes = none | ||
| | | children = none | ||
| | | used_by = anything starting with "process_" | ||
| example = | |||
}} | |||
|none | |||
| | |||
| | |||
{{XML entry | |||
{ | | name = executable | ||
| | | info = Represents a single executable used by the model. | ||
| version = 2 | |||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <executable_order>|executable_order]], | ||
| | [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]], | ||
[[SMS:Dynamic Model Interface Schema#Attribute <default_executable_name32>|default_executable_name32]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <default_executable_name64>|default_executable_name64]] | |||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <executable_progress_update>|executable_progress_update]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]] | ||
| | | example = '''Example 1''' | ||
| | <executable name ="MyModel" executable_order = "1" | ||
| | default_executable_name32="MyModel32.exe" | ||
| | default_executable_name64="MyModel64.exe"> | ||
| | <use_parameter>HydroFile</use_parameter> | ||
| | <execute_command> | ||
| [[SMS:Dynamic Model Interface Schema#Element < | <command_args>" \"%s\"", edtMyModelText</command_args> | ||
| | <execute>"%s", #executable_name</execute> | ||
</execute_command> | |||
</executable> | |||
<input_files> | |||
<input_file> | |||
<use_file_def>myFile</use_file_def> | |||
<export_location>"%s.srhhydro", #project_name</export_location> | |||
<declare_paremeter>HydroFile</declare_parameter> | |||
<input_file> | |||
</input_files> | |||
'''Example 2''' | |||
In the following example, one instance of the numeric model is executed per coverage. A file will be exported per coverage and no command line arguments are used when launching the model. | |||
<executable name = "SRH 2D" executable_order="1" </executable> | |||
<use_parameter>MyCaseFile</use_parameter> | |||
<executable_command> | |||
<command_args>"\"%s\"", #file_name</command_args> | |||
<execute>"%s - %s", #executable_name, #geom_name</execute> | |||
</executable_command> | |||
</executable> | |||
<input_files> | |||
<input_file> | |||
<process_each_coverage> | |||
<use_file_def>caseFile</use_file_def> | |||
<export_location>"%s/%s", #geom_name, #project_name</export_location> | |||
<declare_paramter>MyCaseFile</declare_parameter> | |||
</process_each_coverage> | |||
<executable> | |||
</input_file> | </input_file> | ||
</input_files> | |||
'''Example 3''' | |||
In the following example, only one instance of the numeric model is executed. A file will be exported per coverage and no command line arguments are used when launching the model. | |||
<executable> | <executable name ="SRH 2D executable_order="1""</executable> | ||
<executable_command> | |||
<execute>"%s", #executable_name</execute> | |||
</executable_command> | |||
</executable> | |||
<input_files> | |||
<input_file> | |||
<use_file_def>caseFile</use_file_def> | |||
<process_each_coverage> | |||
<export_location>"%s/%s", #geom_name, #project_name</export_location> | |||
</process_each_coverage> | </process_each_coverage> | ||
</input_file> | |||
</input_files> | |||
}} | |||
{{XML entry | |||
{ | | name = executable_command | ||
| | | info = Defined command line arguments for the executable. | ||
| version = 3 | |||
| | | attributes = none | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <command_args>|command_args]], [[SMS:Dynamic Model Interface Schema#Element <execute>|execute]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]], anything starting with process_ | |||
| example = See executable example. | |||
}} | |||
|none | |||
| | |||
| | |||
| [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]] | |||
| | |||
{{XML entry | |||
{ | | name = executable_progress_update | ||
| | | info = Updates the status bar of the model based on output from the model. | ||
| version = 3 | |||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <progress_amount>|progress_amount]], [[SMS:Dynamic Model Interface Schema#Attribute <progress_max>|progress_max]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <update_text>|update_text]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]] | ||
| | | example = For a model that outputs "CASE 1 of 35","CASE 2 of 35" etc.. | ||
| | |||
| | |||
| | |||
| | |||
| | |||
<executable | <executable name="My Model Main"> | ||
<executable_progress_update | |||
progress_amount="0" progress_max ="35"> | |||
<update_text>"CASE %d of %d" #progress_amount, #progress_max | |||
</update_text> | |||
</executable_progress_update> | |||
</executable> | </executable> | ||
}} | |||
{{XML entry | |||
{ | | name = execute | ||
| | | info = Defines when to run an executable. The text of this element is the text that will be displayed as the process name when running the model. | ||
| version = 2 | |||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <script>|script]] | ||
| | | children = anything starting with "process_" | ||
| used_by =[[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]] | |||
| example = See executable example. | |||
| | }} | ||
| | |||
| | |||
| [[SMS:Dynamic Model Interface Schema#Element < | |||
| | |||
{{XML entry | |||
{ | | name = export_format | ||
| info = Placed inside the [[SMS:Dynamic Model Interface Schema#Element <card>|<card>]] to determine how the card format will be displayed when exporting to a text file. It can be used anywhere in a sequential file. Uses the standard printf and sprintf format (www.cplusplus.com/reference/clibrary/cstdio/printf/). "#card_name" should be used when displaying the card. When using an element that starts with "custom_control", a user can use the # character to get to the value or units. | |||
| | | version = 1 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]] | ||
| | | children = none | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <export_each_row>|export_each_row]], [[SMS:Dynamic Model Interface Schema#Element <export_column>|export_column]], [[SMS:Dynamic Model Interface Schema#Element <export_each_coverage>|export_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <export_each_polygon>|export_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <export_each_arc>|export_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <export_each_point>|export_each_point]], | |||
anything starting with "process_" | |||
| | | example = '''Example 1''' | ||
|ignore_on_read | <edit_box unique_name="MyEditBox"> | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
|'''Example 1''' | |||
<edit_box | |||
</edit_box> | </edit_box> | ||
… | … | ||
<card> | <card> | ||
<card_name>FIFTH_GRAIN</card_name> | |||
<export_format>"%s %lf\n", #card_name, MyEditBox</export_format> | |||
</card> | </card> | ||
If the edit_box has the value of 15, this would print out: | If the edit_box has the value of 15, this would print out: | ||
FIFTH_GRAIN 15 | FIFTH_GRAIN 15 | ||
'''Example 2''' | |||
If export_format was changed to this: | If export_format was changed to this: | ||
<export_format> | <export_format>"%s \"%lf\" // comment\n", #card_name, MyEditBox | ||
</export_format> | </export_format> | ||
FIFTH_GRAIN | FIFTH_GRAIN "15" // comment | ||
<control_length unique_name="MyLength"> | |||
'''Example 3''' | |||
... | |||
</control_length> | |||
… | … | ||
<card> | |||
<card_name>ADAPTATION_LENGTH_TOTAL</card_name> | |||
<export_format>"%s %lf, %s\n", #card_name, MyLength#value, | |||
MyLength#units</export_format> | |||
</ | </card> | ||
ADAPTATION_LENGTH_TOTAL 25 cm | |||
}} | |||
{{XML entry | |||
{ | | name = export_group | ||
| | | info = A way of grouping optional exports. | ||
| version = 2 | |||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <required>|required]] | ||
| children = Any element beginning with "process_" and required, [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <mxmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]] | |||
| used_by = Any element beginning with "process_". | |||
| 2 | | example = | ||
| | }} | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
{{XML entry | |||
{ | | name = export_location | ||
| info = File name of a model specific file including a relative path. Can be used multiple times if exporting to more than 1 file location. It can be used the like an export_format element to specify any of the variables in the name. | |||
| | | version = 1, 2 | ||
| | | attributes = none | ||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <inpute_file>|input_file]], [[SMS:Dynamic Model Interface Schema#Element <output_file>|output_file]], anything starting with "process_” | |||
| 2 | | example = '''Example 1''' | ||
| | <export_location>\\Ideal__Inlet.cmcards</export_location> | ||
| | |||
| | |||
| | |||
'''Example 2''' | |||
<export_location>"\\%s__%s.cmcards", #PROJECT_NAME, #GEOMETRY</export_location> | |||
}} | |||
=====Element | {{XML entry | ||
| name = export_optional | |||
| | | info = Indicator of text that might be included. If it has default as a child, then SMS will write out the text included in this element. | ||
| | | version = 2 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]] | ||
| | | children = Any element beginning with "process_", [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <default>|default]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], xmdf_dataset, xmdf_data, xmdf_group, xmdf_geometry, [[SMS:Dynamic Model Interface Schema#Element <section>|section]] | ||
| used_by = , [[SMS:Dynamic Model Interface Schema#Attribute <export_group>|export_group]], any element beginning with "process_" | |||
| example = | |||
| | }} | ||
<!--obsolete | |||
{{XML entry | |||
| name = files | |||
| info = | |||
| version = 2 | |||
| | | attributes = | ||
| children = file_def | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_control_executable>|model_control_executable]] | |||
| | | example = | ||
}} | |||
--> | |||
<group> | <!-- | ||
{{XML entry | |||
| name = group | |||
| info = Tree group item that contains one or more items or groups. | |||
| version = 1 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], contains | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <contains>|<contains>]] | |||
| example = | |||
<group text = "Timing"> | |||
<contains> | |||
<item> | |||
… tree item stuff | |||
</item> | |||
</contains> | |||
</group> | </group> | ||
}} | |||
=== | --> | ||
{ | <!-- | ||
| | ===Elements I-O=== | ||
{{XML entry | |||
| | | name = input_file | ||
| info = Defines a file to be used for input for an executable. | |||
| version = 2 | |||
| 2 | | attributes = none | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <use_file>|use_file]], [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <process_each_row>|process_each_row]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <inpute_files>|input_files]] | |||
| example = See executable example. | |||
| | }} | ||
| | |||
| | |||
{{XML entry | |||
{ | | name = input_files | ||
| | | info = A container to place all of the input files into for a simulation. | ||
| version = 3 | |||
| | | attributes = none | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <input_file>|input_file]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]] | ||
| example = | |||
}} | |||
| | |||
| | |||
{{XML entry | |||
{ | | name = item | ||
| | | info = Tree item contains one or more widgets ([[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], etc). | ||
| version = 1 | |||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element < table >|table]], any element starting with "control", [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]], [[SMS:Dynamic Model Interface Schema#Element <new_line>|new_line]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <contains>|contains]] | |||
| example = | |||
| | |||
| | |||
| | |||
<item> | <item> | ||
<text>Transport Time Step</text> | <text>Transport Time Step</text> | ||
<edit_box>…. </edit_box> | <edit_box>…. </edit_box> | ||
<card>…</card> | <card>…</card> | ||
}} | |||
{{XML entry | |||
{ | | name = location | ||
| info = Used to specify which point locations to export. Point locations are defined as: "corner", "mid", "center", "disjoint" and "all". Point locations can have a slightly different meaning based on their context as described below. | |||
| | |||
| | |||
Exporting coverage arc points: | |||
*mid = middle points of arc | |||
*corner = 2 end points of an arc | |||
*disjoint = not valid | |||
*center = not valid | |||
Exporting coverage polygon points: | |||
*mid = non nodes in the polygon | |||
*corner = nodes in the polygon | |||
*disjoint = not valid | |||
*center = not valid | |||
Exporting grid/quad points: | |||
*mid = midside points on the cell | |||
*corner = corner points on the cell | |||
*disjoint = not valid | |||
*center = center point on cell | |||
Exporting mesh points: | |||
< | *disjoint = disjoint points only | ||
< | *corner = end points of arcs, nodes in polygons | ||
< | *mid = mid points in arcs, mid points in polygons | ||
< | *center = not valid | ||
| version = 3 | |||
| attributes = none | |||
</ | | children = none | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [SMS:Dynamic Model Interface Schema#Element <process_model>|process_model]], [SMS:Dynamic Model Interface Schema#Element <process_selector>|process_selector]], [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]] | |||
| example = | |||
// writes out snapped coordinates of the 2 end points of each arc | |||
<process_each_coverage> | |||
<use_parameter>myCov</use_parameter> | |||
<process_each_arc source = "snap"> | |||
<process_each_point source = "snap"> | |||
<location>corner</location> | |||
<export_format>"%Lf %Lf %Lf\n", #point_x, #point_y, #point_z | |||
</export_format> | |||
</process_each_point> | |||
</process_each_arc> | |||
</process_each_coverage> | |||
< | // writes out all points of each arc | ||
<process_each_coverage> | |||
<use_parameter>myCov</use_parameter> | |||
</ | <process_each_arc source = "snap"> | ||
<process_each_point source = "snap"> | |||
<location>corner</location> | |||
<location>mid</location> | |||
<export_format>"%Lf %Lf %Lf\n", #point_x, #point_y, #point_z | |||
</export_format> | |||
</process_each_point> | |||
</process_each_arc> | |||
</process_each_coverage> | |||
< | // writes disjoint nodes in a mesh | ||
<process_each_geometry> | |||
</ | <use_parameter>myMesh</use_parameter> | ||
<process_each_point source = "geometry"> | |||
<location>disjoint</location> | |||
<export_format>"%Lf %Lf %Lf\n", #point_x, #point_y, #point_z | |||
</export_format> | |||
</process_each_point> | |||
</process_each_geometry> | |||
< | // writes all midpoints in a grid | ||
<process_each_geometry> | |||
</ | <use_parameter>myGrid</use_parameter> | ||
</model> | <process_each_point source = "geometry"> | ||
</dynamic_model> | <location>mid</location> | ||
<export_format>"%Lf %Lf %Lf\n", #point_x, #point_y, #point_z | |||
</export_format> | |||
</process_each_point> | |||
</process_each_geometry> | |||
}} | |||
{{XML entry | |||
| name = material_att | |||
| info = Used to specify what attributes should be used for materials of a coverage. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <use_dialog>|use_dialog]] | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]] | |||
| example = See coverage example. | |||
}} | |||
--> | |||
<!--obsolete | |||
{{XML entry | |||
| name = max_rows | |||
| info = Optional element used to limit the number of rows the user can specify in a control_curve. If this element is not used, the max_rows is unlimited. | |||
| version = 2 | |||
| attributes = none | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]] | |||
| example = This example creates a curve button with the date/time flag. | |||
<item> | |||
<control_curve> | |||
<unique_name>myCurve1</unique_name> | |||
<max_rows>10</max_rows> | |||
<x_column> | |||
<text>Time</time> | |||
</x_column> | |||
<y_column> | |||
<text>Velocity</text> | |||
</y_column> | |||
</control_curve> | |||
… | |||
}}--> | |||
<!-- | |||
{{XML entry | |||
| name = menu_item | |||
| info = Item to be placed in a menu. The text is the text displayed in the menu, use_dialog describes the dialog to be launched, dependency describes what needs to be true in order for the menu item to appear. | |||
The double_click attribute (if true) indicates that this is the menu item to be launched on a double click event. For example, if a menu_item is in an arc_att, and has double_click = "true", then when an arc is double clicked, the dialog specified by the menu item is launched. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <double_click>|double_click]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <use_dialog>|use_dialog]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <text>|text]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]], [[SMS:Dynamic Model Interface Schema#Element <point_att>|point_att]], [[SMS:Dynamic Model Interface Schema#Element <arc_att>|arc_att]], [[SMS:Dynamic Model Interface Schema#Element <polygon_att>|polygon_att]] | |||
| example = See the model example. | |||
}} | |||
--> | |||
<!--obsolete | |||
{{XML entry | |||
| name = msg | |||
| info = Used to display text to the user when a model check condition has failed. | |||
| version = (Version 3 replaced with problem_text, description_text and fix_text) | |||
| attributes = none | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]] | |||
| example = | |||
< table > | |||
<column text="A> | |||
<edit_box unique_name = "colA"> | |||
</edit_box> | |||
</column> | |||
…// other columns also defined | |||
<model_check problem_text = "Column D or E is required." | |||
description_text = "This model requires column D." | |||
fix_text = "To fix do the following: …... "> | |||
<condition>( (colA OR colB) AND NOT(colD OR colE))</condition> | |||
</model_check> | |||
< /table > | |||
}}--> | |||
<!-- | |||
{{XML entry | |||
| name = model | |||
| info = Defines the model interface that is being created. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <name>|name]], [[SMS:Dynamic Model Interface Schema#Attribute <version>|version]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]], [[SMS:Dynamic Model Interface Schema#Element <declare_dialogs>|declare_dialogs]], [[SMS:Dynamic Model Interface Schema#Element <declare_files>|declare_files]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <dynamic_model>|dynamic_model]] | |||
| example = A simple model that has one coverage type, one dialog, and one file definition. This interfaces with version 4 of "MyModel". | |||
<dynamic_model filetype="dynamic model"> | |||
version="2"> | |||
<model name="MyModel" version="4"> | |||
<simulation> | |||
… | |||
</simulation> | |||
<declare_coverage name= "MyCov">l</coverage> | |||
... | |||
</coverage> | |||
<declare_dialogs> | |||
… | |||
</declare_dialogs> | |||
<file_def> | |||
… | |||
}} | |||
{{XML entry | |||
{ | | name = model_check | ||
| | | info = Used to validate data of multiple combinations when the '''OK''' button is clicked. Displays an error message if the logic in the [[SMS:Dynamic Model Interface Schema#Element <condition>|<condition>]] is false. Can use AND, OR, LESS_THAN, GREATER_THAN, EQUALS and NOT. | ||
| version = 1 | |||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <problem_text>|problem_text]], [[SMS:Dynamic Model Interface Schema#Attribute <description_text>|description_text]], [[SMS:Dynamic Model Interface Schema#Attribute <fix_text>|fix_text]] | ||
| children = [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_geometry>|process_each_geometry]], [[SMS:Dynamic Model Interface Schema#Element <declare_counter>|declare_counter]], [[SMS:Dynamic Model Interface Schema#Element <model_check_condition>|model_check_condition]] | |||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Eleements <model_checks>|model_checks]] | ||
| | | example = | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
< table > | < table > | ||
<column text="A"> | |||
<edit_box unique_name="colA"> | |||
</edit_box> | |||
</column> | |||
…// other columns also defined | …// other columns also defined | ||
< /table > | < /table > | ||
<model_check problem_text = "Column D or E is required." | |||
description_text = "This model requires column D." | |||
fix_text = "To fix do the following: …... "> | |||
<condition>( (colA EQUALS 0.0 OR colB EQUALS 0.0) AND NOT(colD EQUALS 0.0 OR colE EQUALS 0.0))</condition> | |||
</model_check> | |||
}} | |||
{{XML entry | |||
{ | | name = model_checks | ||
| info = Contains all model checks | |||
| | | version = 2 | ||
| | | attributes = none | ||
| children = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model>|model]] | |||
| 2 | | example = . | ||
| | <declare_dialogs> | ||
<declare_dialog> | |||
... | |||
| | < table > | ||
<column text="A"> | |||
<edit_box unique_name="colA"> | |||
| | </edit_box> | ||
</column> | |||
| | |||
…// other columns also defined | …// other columns also defined | ||
< /table > | |||
... | |||
<declare_dialog> | |||
< | <declare_dialogs> | ||
<model_checks> | <model_checks> | ||
<model_check problem_text = "Column D or E is required." | |||
description_text = "This model requires column D." | |||
fix_text = "To fix do the following: …... "> | |||
<condition>( (colA EQUALS 0.0 OR colB EQUALS 0.0) AND NOT(colD EQUALS 0.0 OR colE EQUALS 0.0))</condition> | |||
</model_check> | |||
<model_checks> | <model_checks> | ||
}} | |||
{{XML entry | |||
{ | | name = model_check_condition | ||
| | | info = | ||
| version = 3 | |||
| attributes = none | |||
| children = none | |||
| used_by = | |||
| example = | |||
}} | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
{{XML entry | |||
{ | | name = new_line | ||
| info = Creates a new line before adding the next widget in a tree item. | |||
| | | version = 1 | ||
| | | attributes = none | ||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]] | |||
| 1 | | example = In the dialog there would be: | ||
|none | |||
| | |||
| | |||
| | |||
Breaking Efficency: [edit box] (new_line called) | Breaking Efficency: [edit box] (new_line called) | ||
Friction Efficency: | Friction Efficency: | ||
<item> | <item> | ||
<text>Non-cohesive bedload entrainment</text> | |||
<text_box> | |||
<text>Breaking Efficency:</text> | |||
</text_box> | |||
<edit_box unique_name="edtBreakingEff"> | |||
</edit_box> | |||
<new_line></new_line> | |||
<text_box text="Friction Efficency:"> | |||
</text_box> | |||
}} | |||
{{XML entry | |||
{ | | name = option | ||
| | | info = Widget that displays list of options. Only 1 can be selected. | ||
| version = 1 | |||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <default>|default]], [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]], [[SMS:Dynamic Model Interface Schema#Attribute <unit_keyword>|unit_keyword]], [[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text]], display_options_hide | ||
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], any element that starts with "control_" and has units | |||
| 1 | | example = Creates a combo box with hours, minutes and seconds. Minutes is the default item. | ||
| | <combo_box unique_name="cbxTransportUnits"> | ||
<option text="hours"> | |||
</option> | |||
<option text="minutes" | |||
default> | |||
</option> | |||
| | <option text="seconds"> | ||
| | |||
<combo_box> | |||
<option> | |||
</option> | </option> | ||
<dependency>…</dependency>… | |||
</ combo_box > | </ combo_box > | ||
|} | }} | ||
{{XML entry | |||
| name = output_file | |||
| info = Defines a file to be created by the executable. | |||
| version = 1 | |||
| attributes = none | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <use_file>|use_file]], anything starting with "process_" | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <output_files>|output_files]] | |||
| example = See executable example. | |||
}} | |||
{{XML entry | |||
| name = output_files | |||
| info = A container to place all of the output files into for a simulation. | |||
| version = 3 | |||
| attributes = none | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <output_file>|output_file]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]] | |||
| example = See executable example. | |||
}} | |||
===Elements P-S=== | |||
--> | |||
<!--obsolete | |||
{{XML entry | |||
| name = page_def | |||
| info = This defines the page or tab of a dialog. If there is only one page_def in a dialog, then no tabs will appear. | |||
| version = 2 (depreciated use <delcare_page>) | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <name>|name]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <display>|display]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <contains>|contains]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <dialog>|dialog]] | |||
| example = | |||
}}--> | |||
<!-- | |||
{{XML entry | |||
| name = point_att | |||
| info = Used to specify what attributes should be used for the points of a coverage. | |||
| version = 2 | |||
| attributes = none | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = polygon_att | |||
| info = Used to specify what attributes should be used for the polygon of a coverage. | |||
| version = 2 | |||
| attributes = none | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = process_dataset | |||
| info = Indicator to loop through each dataset in the given context. | |||
| version = 3 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <null_value>|null_value]], [[SMS:Dynamic Model Interface Schema#Attribute <widget>|widget]] | |||
| children = | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = process_each_arc | |||
| info = Indicator to loop through each arc in the given context. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], [[SMS:Dynamic Model Interface Schema#Attribute ''<source''>|source]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = process_each_coverage | |||
| info = Indicator to loop through each coverage in the given context. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <process_each_set>|process_each_set]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <cprocess_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], count_range, [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <location>|location]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = process_each_geometry | |||
| info = Indicator to loop through each geometry in the given context. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <process_each_set>|process_each_set]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <cprocess_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], count_range, [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <location>|location]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = process_each_material | |||
| info = Indicator to loop through each material in the given context. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], declare_parameter, [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], count_range, [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = process_each_neighbor | |||
| | | info = Indicator to loop through each neighbor in the given context. | ||
| | | version = 3 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <corner_skip>|corner_skip]], [[SMS:Dynamic Model Interface Schema#Attribute <feature>|feature]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], [[SMS:Dynamic Model Interface Schema#Attribute <interior_polygon>|interior_polygon]], [[SMS:Dynamic Model Interface Schema#Attribute <null_id>|null_id]], [[SMS:Dynamic Model Interface Schema#Attribute <neighbor_per_edge>|neighbor_per_edge]], source | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]] | ||
| | | example = | ||
| | }} | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
|} | |||
==== | {{XML entry | ||
| name = process_each_point | |||
| | | info = Indicator to loop through each point in the given context. | ||
| | | version = 2 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <location>|location]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_ neighbor]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]] | ||
| | | example = | ||
| | }} | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
==== | {{XML entry | ||
| name = process_each_polygon | |||
| | | info = Indicator to loop through each polygon in the given context. | ||
| | | version = 2 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <declare_parameter>|declare_parameter]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]] | ||
| | | example = | ||
| | }} | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
|} | |||
= | {{XML entry | ||
| name = process_each_row | |||
| | | info = Indicator to loop through each row in a table. Has the widget attribute that must be used. The widget attribute needs to be set to the name of a widget which belongs to the table to be iterated through. To iterate through the rows of a curve widget, use the name of the curve widget and a keyword, such as "#x". | ||
| | | version = 2 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], widget, [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]] | ||
| | | example = | ||
| | <process_each_row widget = "someColumnWidget"> | ||
| | }} | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
=====Element | {{XML entry | ||
| name = process_each_set | |||
| | | info = Indicator to loop through each set. | ||
| | | version = 2 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | ||
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = process_each_timestep | |||
| info = Indicator to loop through each time step. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = process_model | |||
| | | info = Indicator to loop through the model. | ||
| | | version = 2 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]] | ||
| | | example = | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
}} | |||
{{XML entry | |||
{ | | name = process_multi | ||
| | | info = Indicator to loop through multiple simulations. | ||
| version = 2 | |||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]] | ||
| | | example = | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
}} | |||
{{XML entry | |||
{ | | name = process_on_condition | ||
| info = Indicator to perform a certain action only if the condition is satisfied. | |||
| | | version = 2 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_geometry>|process_each_geometry]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_formt>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]], [[SMS:Dynamic Model Interface Schema#Element <use_file_def>|use_file_def]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <use_parameter>|use_parameter]], [[SMS:Dynamic Model Interface Schema#Element <end_card>|end_card]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_row>|process_each_row]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]], [[SMS:Dynamic Model Interface Schema#Element <process_on_count>|process_on_count]], [[SMS:Dynamic Model Interface Schema#Element <process_model>|process_model]], [[SMS:Dynamic Model Interface Schema#Element <model_check_condition>|model_check_condition]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]] | ||
| | | example = | ||
| | }} | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
{{XML entry | |||
{ | | name = process_on_count | ||
| | | info = Indicator to perform a certain action only on certain iterations of a loop. | ||
| version = 2 | |||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <process_each_geometry>|process_each_geometry]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <count_filter>|count_filter]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]] | ||
| | | example = | ||
| | }} | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
{{XML entry | |||
| name = process_selector | |||
| | | info = | ||
| | | version = 2 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]] | ||
| | | example = | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
}} | |||
{{XML entry | |||
{ | | name = process_spectral_grid | ||
| info = Indicator to loop through spectral grid data. | |||
| | | version = 2 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]] | ||
| | | example = | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
}} | |||
{{XML entry | |||
{ | | name = push_button | ||
| | | info = The button to be used for a control_dataset. Can be SELECT, CREATE, or DELETE. | ||
| version = 1, 2 | |||
| | | attributes = none | ||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]] | |||
| 1, 2 | | example = See control_dataset example. | ||
| | }} | ||
| | |||
| | |||
| | |||
{{XML entry | |||
{ | | name = range | ||
| info = Determines the range of acceptable values in an [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]]. Can use the keywords GREATER_THAN, GREATER_THAN_EQUALS, LESS_THAN and LESS_THAN_EQUALS. Numbers assumed inclusive unless otherwise specified. | |||
| | | version = 1 | ||
| | | attributes = none | ||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], [[SMS:Dynamic Model Interface Schema#Element <role>|role]], any element that starts with "control_" except: control_file_selector, control_dataset and control_date | |||
| 1 | | example = '''Example 1''' | ||
|none | |||
| | |||
| | |||
| | |||
| | |||
| | |||
<edit_box> | <edit_box> | ||
<range>0-1</range> | <range>0-1</range> | ||
</ edit_box > | </ edit_box > | ||
'''Example 2''' | |||
<range>0 – 5.6546</range> | <range>0 – 5.6546</range> | ||
'''Example 3''' | |||
<range>GREATER_THAN 0</range> | <range>GREATER_THAN 0</range> | ||
'''Example 4''' | |||
<range>GREATER_THAN 0.0 - LESS_THAN 5.0</range> | <range>GREATER_THAN 0.0 - LESS_THAN 5.0</range> | ||
'''Example 5''' | |||
Both examples are equivalent | |||
<range>0.0 - LESS_THAN 5.0</range> | <range>0.0 - LESS_THAN 5.0</range> | ||
<range>GREATER_THAN_EQUALS 0.0 - LESS_THAN 5.0</range> | <range>GREATER_THAN_EQUALS 0.0 - LESS_THAN 5.0</range> | ||
}} | |||
|} | {{XML entry | ||
| name = required | |||
| info = Used to indicate that something from the exported group must be used. | |||
| version = 2 | |||
| attributes = none | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = role | |||
| info = A single entry in a combo box option for <roles>. Used to define the displayed text and range. The range specifies how many objects that can have this role. | |||
| version = 3 | |||
| attributes = none | |||
| children = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]], [[SMS:Dynamic Model Interface Schema#Attribute <range>|range]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <roles>|roles]] | |||
| example = Example of a culvert widget with a extra "Name" column | |||
<control_set unique_name="tblSetCulverts"> | |||
<roles behavior = "SWAP"> | |||
<role text="upper"> | |||
<range>1-1</range> | |||
</role> | |||
<role text="lower"> | |||
<range>1-1</range> | |||
</role> | |||
</roles> | |||
<column text = "Name"> | |||
<edit_box unique_name="edtMyArcsName" | |||
type="text"> | |||
</edit_box> | |||
</column> | |||
</control_set> | |||
}} | |||
{{XML entry | |||
{ | | name = roles | ||
| info = Defines the behavior of each role. | |||
| | | version = 3 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <behavior>|behavior]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <role>|role]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <control_set>|control_set]] | ||
| | | example = Example of a culvert widget with a extra "Name" column | ||
<control_set unique_name="tblSetCulverts"> | |||
<roles behavior = "SWAP"> | |||
<role text="upper"> | |||
<range>EQUALS 1</range> | |||
| | </role> | ||
<role text = "lower"> | |||
<range>EQUALS 1</range> | |||
</role> | |||
| | </roles> | ||
| | <column text="Name"> | ||
<edit_box unique_name="edtMyArcsName" | |||
type="text"> | |||
</edit_box> | |||
</column> | |||
</control_set> | |||
}} | |||
{{XML entry | |||
{ | | name = row | ||
| | | info = Definition of the row in the table. A widget defined in a row will be the widget used for each cell in the column.. | ||
| version = 1 | |||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]], | ||
[[SMS:Dynamic Model Interface Schema#Attribute <read_only>|read_only]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <optional>|optional]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], all elements starting with "custom_control", [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| 1 | | used_by = [[SMS:Dynamic Model Interface Schema#Element <control_set>|control_set]], [[SMS:Dynamic Model Interface Schema#Element < table >|table]] | ||
| example = Row 1 is read only, row 2 isn’t | |||
| | |||
| | |||
| | |||
< table > | < table > | ||
… | |||
<row text = "Row1" read_only></row> | |||
<row text = "Row2"></row> | |||
< /table > | |||
}} | |||
{{XML entry | |||
| name = separator | |||
| info = Determines how to separate text that is being exported into a text file. | |||
| | | version = 1 | ||
| attributes = none | |||
| children = none | |||
| used_by = | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = simulation | |||
| info = The simulation object that represents what will run and be exported upon launching a model. There can only be one per model. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <use_icon>|use_icon]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <takes>|takes]], [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]], [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <input_files>|input_files]], [[SMS:Dynamic Model Interface Schema#Element <output_files>|output_files]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_executable>|control_executable]], [[SMS:Dynamic Model Interface Schema#Element <model>|model]] | |||
| example = See the model example. | |||
}} | |||
{{XML entry | |||
| name = snap | |||
| info = Snaps the arc, point or polygon in a coverage to the underlying geometry (mesh, grid, etc) that is defined by the [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|<declare_coverage>]] bind_to attribute | |||
| version = 3 | |||
| attributes = none | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <snap_exterior>|snap_exterior]], [[SMS:Dynamic Model Interface Schema#Element <snap_extrior>|snap_interior]], [[SMS:Dynamic Model Interface Schema#Element <location>|location]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <arc_att>|arc_att]], [[SMS:Dynamic Model Interface Schema#Element <point_att>|point_att]], [[SMS:Dynamic Model Interface Schema#Element <polygon_att>|polygon_att]] | |||
| example = Snaps an arc boundary condition to the interior of the mesh when the arc type is Monitor Line and to the exterior when the arc is a Inlet-Q. | |||
== | <declare_coverage name= "Boudary Conditions" bind to ="MESH2D"> | ||
<arc_att> | |||
<menu_item double_click = "true" text = "Assign Linear BC" | |||
link_to = "Linear BC" </menu_item> | |||
<snap> | |||
<snap_exterior> | |||
<condition>cbxLineType EQUALS "Inlet-Q" | |||
</condition> | |||
</snap_exterior> | |||
<snap_interior> | |||
<condition>cbxLineType EQUALS "Monitor-Line" </condition> | |||
</snap_interior> | |||
</snap> | |||
</arc_att> | |||
</coverage> | |||
}} | |||
{{XML entry | |||
| name = snap_exterior | |||
| info = Snaps the arc, point or polygon in a coverage to the closest exterior point, arc, or polygon of the underlying geometry. | |||
| version = 3 | |||
| attributes = none | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]] | |||
| example = See <snap> | |||
}} | |||
{{XML entry | |||
{ | | name = snap_interior | ||
| info = Snaps the arc, point or polygon in a coverage to the closest interior point, arc, or polygon of the underlying geometry. | |||
| | | version = 3 | ||
| | | attributes = none | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <snap>|snap]] | |||
| example = See <snap>. | |||
}} | |||
| | |||
| | |||
| | |||
< | |||
=== | ===Elements T-Z=== | ||
{ | {{XML entry | ||
| | | name = table | ||
| info = Table widget with columns and rows. Will most likely have multiple column and row tags. Using the attribute fixed_row_count means that the user can’t add or delete rows. Not using the fixed_row_count , an insert and delete button will be included at the bottom of the table. | |||
| | | version = 1 | ||
| | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <read_only>|read_only]], | ||
| | [[SMS:Dynamic Model Interface Schema#Attribute <fixed_row_count>|fixed_row_count]], | ||
| | [[SMS:Dynamic Model Interface Schema#Attribute <max_row_count>|max_row_count]], | ||
| | [[SMS:Dynamic Model Interface Schema#Attribute <min_row_count>|min_row_count]], | ||
| | [[SMS:Dynamic Model Interface Schema#Attribute <min_height>|min_height]], | ||
| | [[SMS:Dynamic Model Interface Schema#Attribute <unique_name>|unique_name]] | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]] | |||
| example = Read only table with 2 columns and 3 rows. The number of rows are fixed. | |||
| | < table unique_name = "myTable" | ||
read_only | |||
fixed_row_count="3"> | |||
| | <column text = "hours"</column> | ||
<column text = "minutes"</column> | |||
< table | |||
</ table > | </ table > | ||
}} | |||
{{XML entry | |||
{ | | name = take_coverage | ||
| | | info = Represents a coverage that can be taken in the project explorer. | ||
| version = 2 | |||
| | | attributes = limit | ||
| children = declare_parameter, [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]], [[SMS:Dynamic Model Interface Schema#Element <use_coverage>|use_coverage]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], attribute_set | |||
| 2 | | example = See takes example. | ||
| | }} | ||
| | |||
| | |||
| | |||
{{XML entry | |||
{ | | name = take_mesh2d | ||
| | | info = Represents a coverage that can be taken in the project explorer. | ||
| version = 2 | |||
| | | attributes = limit, linear | ||
| children = declare_parameter, [[SMS:Dynamic Model Interface Schema#Element <condition>|condition]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], attribute_set | |||
| 2 | | example = See takes example. | ||
| | }} | ||
| | |||
| | |||
| | |||
{{XML entry | |||
{ | | name = takes | ||
| | | info = Represents what can be dragged under another object in the project explorer. | ||
| version = 2 | |||
| | | attributes = none | ||
| children = declare_parameter, [[SMS:Dynamic Model Interface Schema#Element <take_coverage>|take_coverage]], [[SMS:Dynamic Model Interface Schema#Element <take_mesh2d>|take_mesh2d]], take_grid2d | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], attribute_set | |||
| 2 | | example = '''Example 1''' This example shows a simulation that can take a coverage and a 2D mesh which uses linear elements. | ||
| | |||
| | |||
| | |||
| | |||
<takes> | <takes> | ||
<take_coverage limit = "1"> | |||
<use_coverage>My Cov</use_coverage> | |||
<condition>""</condition> | |||
</take_coverage> | |||
<take_mesh2d limit = "1" linear = "true"> | |||
<condition>""</condition> | |||
</take_mesh2d> | |||
<declare_parameter>meshCov</declare_parameter> | |||
</takes> | </takes> | ||
'''Example 2''' | |||
This example shows taking one type of coverage OR another type of coverage. | |||
<takes> | <takes> | ||
<take_coverage limit = "1"> | |||
<use_coverage>My Cov</use_coverage> | |||
<use_coverage>My Other Cov</use_coverage> | |||
<condition>""</condition> | |||
</take_coverage> | |||
<declare_parameter>monitorCov</declare_parameter> | |||
</takes> | </takes> | ||
}} | |||
{{XML entry | |||
{ | | name = text_box | ||
| | | info = Widget that displays text that is not editable. | ||
| version = 1 | |||
| | | attributes = alignH, alignV, text, unique_name | ||
| | | children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]] | ||
| example = | |||
<text_box unique_name = "edtD50Units" alignH= "CENTER" | |||
text = "mm"> | |||
| | |||
| | |||
| | |||
<text_box | |||
</text_box> | </text_box> | ||
}} | |||
{{XML entry | |||
{ | | name = text_size | ||
| info = Sets the point size of the text. Ranges from 8 to 20. Added in SMS 11.2. | |||
| | | version = 1, 2 | ||
| | | attributes = none | ||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
| 1, 2 | | example = This would set the size of the text to 20pt. when the value in the [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]] is less than 0.0. | ||
| | |||
| | |||
| | |||
| | |||
<edit_box> | <edit_box> | ||
<unique_name>edtA</unique_name> | <unique_name>edtA</unique_name> | ||
| Line 2,939: | Line 2,037: | ||
<text_style> | <text_style> | ||
</edit_box> | </edit_box> | ||
}} | |||
{{XML entry | |||
{ | | name = text_style | ||
| | | info = Holds the style options for the text. Added in SMS 11.2. | ||
| version = 1 | |||
| | | attributes = bold, italic, strike_through, text_size, underline | ||
| | | children = color, condition | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], all elements starting with "custom_control", [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <options>|options]] | ||
| example = This would bold the text when the value in the edit_box is less than 0.0. | |||
| | |||
| | |||
| | |||
<edit_box> | <edit_box> | ||
<unique_name>edtA</unique_name> | |||
<default>1.0</default> | |||
<text_style bold text_size="12"> | |||
<condition>edtA LESS_THAN 0.0</condition> | |||
<text_style> | |||
</edit_box> | </edit_box> | ||
|} | }} | ||
{{XML entry | |||
| name = title_format | |||
| info = This indicates what the title of an object in an h5 file is. Uses the standard printf and sprintf format ([www.cplusplus.com/reference/clibrary/cstdio/printf/ www.cplusplus.com/reference/clibrary/cstdio/printf/]). Works the same as [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]]. | |||
| version = 3 | |||
| attributes = none | |||
| children = none | |||
| used_by = h5_group, h5_geometry, h5_dataset, h5_data | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = unique_link_name | |||
| info = A unique name given to a link when using link_to_xml. This is needed to identify the unique_name elements from the file, especially when a linked to XML file is used multiple times. Hence, when using link_to_xml, this tag is required. No spaces or punctuation are allowed in the name. | |||
| version = 1, 2 | |||
| attributes = none | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <link_to_xml>|link_to_xml]] | |||
| example = See link_to_xml example. | |||
}} | |||
{{XML entry | |||
| name = update_text | |||
| info = Used to match the output text from a model to determine the progress amount. | |||
| version = 3 | |||
| attributes = none | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable_progress_update>|executable_progress_update]] | |||
| example = Lets say our model outputs "CASE 1 of 35" then "CASE 2 of 35" etc.. | |||
<executable name="My Model Main"</executable> | |||
<executable_progress_update amount="0" max ="35"> | |||
<update_text>"CASE %d of %d" #progress_amount, #progress_max | |||
</update_text> | |||
</executable_progress_update> | |||
</executable> | |||
}} | |||
{{XML entry | |||
| name = use_coverage | |||
| info = Use a coverage that has previously been defined in the attribute type in <declare_coverage> | |||
| version = 2 | |||
| attributes = none | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]], [[SMS:Dynamic Model Interface Schema#Element <take_coverage>|take_coverage]] | |||
| example = See the coverage example and the takes example. | |||
}} | |||
{{XML entry | |||
| name = use_file_def | |||
| info = A way to access file data that has been previously declared with <declare_file_def>. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <coontrol_file>|control_file]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <output_file>|output_file]], [[SMS:Dynamic Model Interface Schema#Element <input_file>|input_file]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <file>|file]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = use_parameter | |||
| info = A way to access file data that has been previously declared with <declare_parameter>. | |||
| version = 3 | |||
| attributes = none | |||
| children = none | |||
| used_by = anything beginning with "process_", [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = x_column | |||
| info = Used to define the attributes in the x column such as text (heading). | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]] | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]] | |||
| example = This example creates a curve button with the date/time flag. | |||
<item> | |||
<control_curve> | |||
<unique_name>myCurve1</unique_name> | |||
<max_rows>10</max_rows> | |||
<x_column> | |||
<text>Time</time> | |||
</x_column> | |||
<y_column> | |||
<text>Velocity</text> | |||
</y_column> | |||
</control_curve> | |||
… | |||
}} | |||
{{XML entry | |||
| name = xmdf_data | |||
| info = Writes data to the XMDF file. The attributes rows, columns and layers indicate what information should be written for each row, column or layer respectively. By default, the attributes are set to "#specified". If no attributes are set then each export_format will be assumed to be a new row. The attribute columns can only be set if the rows attribute is set. The attribute layers can only be set if both the rows attribute and the columns attribute is set. The datatype attribute can be set to "float", "double", "integer", or "text". If the datatype attribute is not set or is set to "text" then export_format can be used. Otherwise, only export can be used. If more than 1 dimension is used, then the datatype cannot be "text". If 3 dimensions are used, then the datatype cannot be "integer". | |||
| version = 3 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <datatype>|datatype]] | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]], [[SMS:Dynamic Model Interface Schema#Element <export>|export]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], file_def, and anything beginning with "process_". | |||
| example = This writes out 6 different widgets’ values, one on each row. | |||
<xmdf_data datatype = "text"> | |||
<export_format>"%s", widget1</export_format> | |||
<export_format>"%s", widget2</export_format> | |||
<export_format>"%s", widget3</export_format> | |||
<export_format>"%s", widget4</export_format> | |||
<export_format>"%s", widget5</export_format> | |||
<export_format>"%s", widget6</export_format> | |||
</xmdf_data> | |||
This writes out a table with each row being a different timestep and each column a different point. Each export would be written to different layers. | |||
<xmdf_data rows = "#timestep" columns = "#point" datatype = "double"> | |||
<export>#component1</export> | |||
<export>#component2</export> | |||
</xmdf_data> | |||
}} | |||
{{XML entry | |||
| name = xmdf_dataset | |||
| info = Writes out all of the data of a dataset in an SMS friendly format to an xmdf file. The attribute null_value is optional. If used, it specifies a numeric value that will be treated by the model as inactive. By default, SMS will write an activity array. The attribute location specifies where data should be taken from. The attribute widget specifies to only write the dataset referenced by the named widget. If no title_format is used, then the name of the dataset will be used. | |||
| version = 3 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <null_value>|null_value]], | |||
[[SMS:Dynamic Model Interface Schema#Attribute <location>|location]], | |||
widget | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]]. | |||
| example = This writes out the hardbottom dataset as specified by the widget edtHardBottomWidget that exists in some dialog. Any value that is inactive is written as -999.0. | |||
<xmdf_dataset widget = "edtHardBottomWidget" location = "all" null_value = "-999.0"> | |||
<title_format>"Hardbottom"</title_format> | |||
</xmdf_dataset> | |||
}} | |||
{{XML entry | |||
| name = xmdf_dimension | |||
| info = | |||
| version = 3 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <dimension>|dimension]] | |||
| children = | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]] | |||
| example = '''Example 1:''' The following shows how to write out the text rows of a single column of a table into a single column XMDF dataset. | |||
<xmdf_group> | |||
<title_format>"Test"</title_format> | |||
<xmdf_data> | |||
<title_format>"Table"</title_format> | |||
<process_each_row widget="myColumn1"> | |||
<xmdf_dimension dimension="rows"> | |||
<export_format>"%s", myColumn1</export_format> | |||
</xmdf_dimension> | |||
</process_each_row> | |||
</xmdf_data> | |||
</xmdf_group> | |||
'''Example 2:''' The following shows how to write out two columns of a table into two columns of single XMDF dataset. It should be noted that multi-column XMDF datasets may not be text. | |||
<xmdf_group> | |||
<title_format>"Test"</title_format> | |||
<xmdf_data datatype="double"> | |||
<title_format>"Table"</title_format> | |||
<process_each_row widget="myColumn1"> | |||
<xmdf_dimension dimension="rows"> | |||
<xmdf_dimension dimension="columns"> | |||
<export>myColumn1</export> | |||
</xmdf_dimension> | |||
<xmdf_dimension dimension="columns"> | |||
<export>myColumn2</export> | |||
</xmdf_dimension> | |||
</xmdf_dimension> | |||
</process_each_row> | |||
</xmdf_data> | |||
</xmdf_group> | |||
}} | |||
{{XML entry | |||
| name = xmdf_geometry | |||
| info = Writes a geometric object in an SMS friendly format to an XMDF file. Different geometric types will be written differently from each other. If no title_format is used, then the name of the geometry will be used. | |||
| version = 3 | |||
| attributes = none | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]] | |||
| used_by = file_def, [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = xmdf_group | |||
| info = Writes an XMDF group to the xmdf file. A title_format must be used. The group_type attribute must be used. | |||
| version = 3 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <group_type>|group_type]] | |||
| children = xmdf_group, [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]], and anything beginning with "process_". | |||
| used_by = file_def, xmdf_group, [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], and anything beginning with "process_". | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = y_column | |||
| info = Used to define the attributes in the y column such as text (heading). | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <text>|text]] | |||
| children = none | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]] | |||
| example = See example in x_column | |||
}} | |||
==Attributes== | |||
===Attributes A-C=== | |||
{{XML attributes | |||
| name = alignH | |||
| info = Align text horizontally in a text box. | |||
| values = bottom, top, center | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]] | |||
}} | |||
{{XML attributes | |||
| name = alignV | |||
| info = Align text vertically in a text box. | |||
| values = bottom, top, center | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]] | |||
}} | |||
{{XML attributes | |||
| name = amount | |||
| info = | |||
| values = integer | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <execute_progress_update>|execute_progress_update]] | |||
}} | |||
{{XML attributes | |||
| name = behavior | |||
| info = When a user changes a role, you can define behaviors that automatically update the roles. | |||
| values = ''None'': no enforcement of rules in the dialog | |||
''Swap'': all assigned up front. When some object is being assigned a role and is there are already a max number of objects assigned to the role, then any objects that had that role will be switched to the old role of the object being asgined until we surpass the maximum amount of that role, then unassigned. | |||
''Max_hide'': Don’t allow the role to show up in the combo box to be assigned to a "object" if the max has been reached for that role. | |||
''Swap_max_default'': (not implemented yet) Enforce max with default is like swap, but instead of the old option, it changes it to the default or unassigned (if no default provided) value. Chooses the first or last "object" of the role it encounters to change. | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <roles>|roles]] | |||
}} | |||
{{XML attributes | |||
| name = bind_to | |||
| info = Binds a coverage to a mesh, or grid | |||
| values = MESH2D, CGRID | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]] | |||
}} | |||
{{XML attributes | |||
| name = blue | |||
| info = A color. Ranges from 0 to 255. Added in SMS 11.2. See also green and red. | |||
| values = integer (0 to 255) | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <color>|color]] | |||
}} | |||
{{XML attributes | |||
| name = bold | |||
| info = Sets the text to be bolded when this attribute is used. Added in SMS 11.2. | |||
| values = none | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
}} | |||
{{XML attributes | |||
| name = columns | |||
| info = Represents a column in the H5 file that we are mapping to | |||
| values = #timestep, #point, #arc, #polygon, #coverage, #material | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]] | |||
}} | |||
{{XML attributes | |||
| name = corner_skip | |||
| info = Skip corners when exporting neighbors | |||
| values = true, false | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]] | |||
}} | |||
{{XML attributes | |||
| name = create_file | |||
| info = If attribute is specified, then create_file is true | |||
| values = none | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_file_selector>|control_file_selector]] | |||
}} | |||
{{XML attributes | |||
| name = dataset_type | |||
| info = Specify the dataset type as scalar or vector. Default is scalar. | |||
| values = scalar, vector | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]] | |||
}} | |||
{{XML attributes | |||
| name = dataset_widget | |||
| info = When exporting points from a dataset, the attribute identifies the dataset widget being used (contains the selected dataset). | |||
| values = Name of the dataset_widget | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]] | |||
}} | |||
{{XML attributes | |||
| name = datatype | |||
| info = | |||
| values = float, double, integer, text | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]] | |||
}} | |||
{{XML attributes | |||
| name = default | |||
| info = Sets the initial default value of a widget. Can also be used to state the default combo-box option. | |||
| values = | |||
''edit_box'' or any element that begins with ''custom_control'': double<br/> | |||
''check_box'': checked, unchecked<br/> | |||
''combo_box'': no values or empty string<br/> | |||
''export_optional'': true, false | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <option>|option]], any element that begins with "control" ("custom_control" in version 1), [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]] | |||
}} | |||
{{XML attributes | |||
| name = default_executable_name32 | |||
| info = Sets the initial default file name for the 32-bit executable. | |||
| values = text | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]] | |||
}} | |||
{{XML attributes | |||
| name = default_executable_name64 | |||
| info = Sets the initial default file name for the 64-bit executable. | |||
| values = text | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]] | |||
}} | |||
{{XML attributes | |||
| name = description_text | |||
| info = A detailed description of why a model check failed. This text is displayed to the user. | |||
| values = string | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]] | |||
}} | |||
{{XML attributes | |||
| name = dim | |||
| info = Specifies that when the dependency is false, the widget should be dimmed, not hidden. | |||
| values = none | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]] | |||
}} | |||
{{XML attributes | |||
| name = dimension | |||
| info = Specifies values for rows, columns and layers. | |||
| values = rows, columns, layers | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_dimension>|xmdf_dimension]] | |||
}} | |||
{{XML attributes | |||
| name = display | |||
| info = This is used to describe how the dialog should display. | |||
''flex'' is the default. In this mode, there is a tree on the left hand side of the dialog. Clicking on an item in the tree will display that portion of the tree along with any child items below the clicked item. Other items will be hidden on the right hand side. | |||
''full'' will show a tree on the left hand side of the dialog. Clicking on an item in the tree will move the scroll bars on the right hand side to make the item visible. All items that are not disabled due to dependencies are shown on the right hand side of the dialog in this mode. | |||
''no_nav'' will have no left hand side tree. Instead, all items that are not disabled due to dependencies are shown in this mode. Added in SMS 11.2. | |||
| values = flex, full, no_nav | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_page>|declare_page]] | |||
}} | |||
{{XML attributes | |||
| name = display_options_hide | |||
| info = Don’t show a specific combo-box option in the display option dialog of SMS. This only applies to <combo_box> ‘s that have included the <display_options> element. Default value is false. | |||
| values = true, false | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <option>|option]] | |||
}} | |||
{{XML attributes | |||
| name = double_click | |||
| info = The double_click attribute (if true) indicates that this is the menu item to be launched on a double click event. | |||
| values = true, false | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]] | |||
}} | |||
===Attributes E-L=== | |||
{{XML attributes | |||
| name = executable_order | |||
| info = Defines the order in which this executable should run relative to other executables in the same simulation. | |||
| values = integer ≥ 1 | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]] | |||
}} | |||
{{XML attributes | |||
| name = feature | |||
| info = Determine whether to select points, arcs or polygons (poly). | |||
| values = point, arc, poly | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_feature_selector>|control_feature_selector]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]] | |||
}} | |||
{{XML attributes | |||
| name = fix_text | |||
| info = A brief summary of what steps to take to fix a model check failure. This text is displayed to the user. | |||
| values = string | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]] | |||
}} | |||
{{XML attributes | |||
| name = file_type | |||
| info = Specifies a file type of <declare_file_def> defines the file type. | |||
| values = CARD_ASCII, SEQUENTIAL_ASCII, SEQUENTIAL_BINARY, XMDF | |||
| versions = 2 | |||
| used_by = declare_file_def, [[SMS:Dynamic Model Interface Schema#Element <section>|section]] | |||
}} | |||
{{XML attributes | |||
| name = filter | |||
| info = When selecting a file, used to filter the available files by the extension type. The filter tag contains two parts. The first part is the text describing the filter that gets displayed to the user. The second part is a pair of parentheses that contains the actual filter. For example: Cmcards file (.cmcards) | |||
| values = string (string) | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_file_selector>|control_file_selector]] | |||
}} | |||
{{XML attributes | |||
| name = flags | |||
| info = Flags are optional, and are used to modify the behavior/appearance of the control_curve. Only 1 flag is currently defined: XY_USEDATE. When this flag is set, the x column becomes a date/time calendar. | |||
| values = XY_USEDATE | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]] | |||
}} | |||
{{XML attributes | |||
| name = footer | |||
| info = Exported text inside a table that is placed at the end. | |||
| values = string | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <export_table>|export_table]], [[SMS:Dynamic Model Interface Schema#Element <export_each_row>|export_each_row]], [[SMS:Dynamic Model Interface Schema#Element <export_column>|export_column]] | |||
}} | |||
{{XML attributes | |||
| name = geometry | |||
| info = The default behavior is to only allow geometric objects that are contained under a simulation to be a candidate for selection. Otherwise "all" geometries are candidates. | |||
| values = all | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]] | |||
}} | |||
{{XML attributes | |||
| name = green | |||
| info = A color. Ranges from 0 to 255. Added in SMS 11.2. See also blue and red. | |||
| values = integer (0 to 255) | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <color>|color]] | |||
}} | |||
{{XML attributes | |||
| name = header | |||
| info = Exported text inside a table that is placed at the beginning. | |||
| values = string | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <export_table>|export_table]], [[SMS:Dynamic Model Interface Schema#Element <export_each_row>|export_each_row]], [[SMS:Dynamic Model Interface Schema#Element <export_column>|export_column]] | |||
}} | |||
{{XML attributes | |||
| name = help_button_url | |||
| info = Provides online help when the help button is clicked. Loads the specified url in a web browser. Example: help_button_url="www.aquaveo.com" | |||
| values = string | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_dialog>|declare_dialog]] | |||
}} | |||
{{XML attributes | |||
| name = help_button_wiki | |||
| info = Provides online help when the help button is clicked. Loads the specified url in a web browser. Example: help_button_wiki="DynSrhModelControl" | |||
| values = string | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_dialog>|declare_dialog]] | |||
}} | |||
{{XML attributes | |||
| name = increment | |||
| info = An increment values. Used Increment from the min time to the max time, using the increment. | |||
| values = Integer ≥ 1 | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_set>|control_set]] | |||
}} | |||
{{XML attributes | |||
| name = ignore_on_read | |||
| info = | |||
| values = | |||
| versions = 2 | |||
| used_by = Anything that starts with "process_" | |||
}} | |||
{{XML attributes | |||
| name = ignore_on_write | |||
| info = | |||
| values = | |||
| versions = 2 | |||
| used_by = Anything that starts with "process_" | |||
}} | |||
{{XML attributes | |||
| name = interior_polygon | |||
| info = Only used for polygons when finding neighbors. Specify the polygon preference. | |||
| values = interior_first, exterior_first, interior_only, exterior_only | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]] | |||
}} | |||
{{XML attributes | |||
| name = italic | |||
| info = Sets the text to be italicized when the element is specified. Added in SMS 11.2. | |||
| values = none | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
}} | |||
{{XML attributes | |||
| name = i_order | |||
| info = Start at min i and go to max. Only used by cartesian grids and process_each_neighbor on quad trees. | |||
| values = ascending, descending | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_row>|process_each_row]] | |||
}} | |||
{{XML attributes | |||
| name = j_order | |||
| info = Start at min j and go to max. Only used by cartesian grids and process_each_neighbor on quad trees. | |||
| values = ascending, descending | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_row>|process_each_row]] | |||
}} | |||
{{XML attributes | |||
| name = layers | |||
| info = Represents a layer in the H5 file to which we are mapping. | |||
| values = #timestep, #point, #arc, #polygon, #coverage, #material | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]] | |||
}} | |||
{{XML attributes | |||
| name = location | |||
| info = The location from which we will be getting dataset values. | |||
| values = TBD | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]] | |||
}} | |||
===Attributes M-S=== | |||
{{XML attributes | |||
| name = max | |||
| info = A max value. The default is 2.147 billion. | |||
| values = Integer ≥ 1 | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_set>|control_set]], [[SMS:Dynamic Model Interface Schema#Element <execute_progress_update>|execute_progress_update]] | |||
}} | |||
{{XML attributes | |||
| name = max_row_count | |||
| info = Used to set the maximum number of rows allowed in a table or curve. | |||
| values = integer | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element < table >|table]], [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]] | |||
}} | |||
{{XML attributes | |||
| name = min | |||
| info = A minimum value. The default is 0 (zero). | |||
| values = Integer ≥ 1 | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_set>|control_set]] | |||
}} | |||
{{XML attributes | |||
| name = model | |||
| info = Specify the model name of the executable | |||
| values = string | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_executable>|control_executable]] | |||
}} | |||
{{XML attributes | |||
| name = name | |||
| info = Specify a name. When used by dialog this is required. | |||
| values = string | |||
| versions = 3 | |||
| used_by = declare_file_def, [[SMS:Dynamic Model Interface Schema#Element <declare_dialog>|declare_dialog]], [[SMS:Dynamic Model Interface Schema#Element <model>|model]], [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]], [[SMS:Dynamic Model Interface Schema#Element <declare_coverag>|declare_coverage]] | |||
}} | |||
{{XML attributes | |||
| name = neighbor_per_edge | |||
| info = Minimum number of neighbors in any direction. The default value is 0 (zero). | |||
| values = integer | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]] | |||
}} | |||
{{XML attributes | |||
| name = null_id | |||
| info = Integer for an id of a neighbor not found | |||
| values = integer | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]] | |||
}} | |||
{{XML attributes | |||
| name = null_value | |||
| info = The null_value for the dataset. | |||
| values = any integer, any double | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]] | |||
}} | |||
{{XML attributes | |||
| name = optional | |||
| info = Placed inside widgets to suppress a warning message from being displayed if the widgets data is empty. By default, data associated with a widget is required. If the <optional> tag is included and the widget’s data is empty, a warning message won’t be displayed. | |||
| values = none | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], [[SMS:Dynamic Model Interface Schema#Element < table >|table]], any element that starts with "custom_control", [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]] | |||
}} | |||
{{XML attributes | |||
| name = order | |||
| info = The way spatial entity objects are to be sorted before iterating. Currently only available for Cartesian grids and quadtrees (process_each_neighbor). | |||
| values = clockwise, counter_clockwise, ij, ji | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]] | |||
}} | |||
{{XML attributes | |||
| name = problem_text | |||
| info = A brief summary of why a model check failed. This text is displayed to the user. | |||
| values = string | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model_check>|model_check]] | |||
}} | |||
{{XML attributes | |||
| name = red | |||
| info = A color. Ranges from 0 to 255. Added in SMS 11.2. See also blue and green. | |||
| values = integer (0 to 255) | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <color>|color]] | |||
}} | |||
{{XML attributes | |||
| name = required | |||
| info = Specifies that at least one option in the group must be present. | |||
| values = true | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]] | |||
}} | |||
{{XML attributes | |||
{ | | name = rows | ||
| | | info = Represents a row in the .h5 file to map to | ||
| values = #timestep, #point, #arc, #polygon, #coverage, #material | |||
| | | versions = 3 | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]] | ||
}} | |||
| | |||
| | |||
| | |||
{{XML attributes | |||
| name = select_time | |||
| info = | |||
| values = single, #range, #all | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]] | |||
}} | |||
{{XML attributes | |||
{ | | name = source | ||
| | | info = When exporting things such as point or arc locations, the source identifies the desired location such as on the coverage or on the geometry (grid, mesh) | ||
| values = coverage (use locations from coverage), snapped (use the snapped location on a geometry from a coverage), geometry (use locations from geometry) | |||
| | | versions = 3 | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_neighbor>|process_each_neighbor]] | |||
}} | |||
| | |||
| | |||
| | |||
{{XML attributes | |||
| name = strike_through | |||
| info = Sets the text to have a line through the middle when the element is specified. Added in SMS 11.2. | |||
| values = none | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
}} | |||
=== | ===Attributes T-Z=== | ||
{ | {{XML attributes | ||
| | | name = text | ||
| info = Text that is displayed in the SMS user interface. | |||
| | | values = any text string | ||
| | | versions = 1 | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <option>|option]], [[SMS:Dynamic Model Interface Schema#Element <x_column>|x_column]], [[SMS:Dynamic Model Interface Schema#Element <y_column>|y_column]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <display_options>|display_options]], [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <declare_page>|declare_page]], [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]] | |||
| 1 | }} | ||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
{{XML attributes | |||
| name = type | |||
| info = For <display_options> defines point, or arc | |||
| values = ''display_options'': arc, point<br/> | |||
''edit_box'': text, integer, double | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]], [[SMS:Dynamic Model Interface Schema#Element <display_options>|display_options]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]] | |||
}} | |||
{{XML attributes | |||
{ | | name = time_type | ||
| | | info = Type of time either transient, steady state, or all. Default is all. | ||
| values = transient, steady state, all | |||
| | | versions = 2 | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]] | |||
}} | |||
| | |||
| | |||
| | |||
{{XML attributes | |||
| name = underline | |||
| info = Sets the text to be underlined when this attribute is specified. Added in SMS 11.2. | |||
| values = none | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | |||
}} | |||
{{XML attributes | |||
{ | | name = unique_name | ||
| info = A unique name given to an widget, which determines how to reference the widget. When a unique_name is being referenced it should be by the file (nothing if current file), then unique_name. No spaces or punctuation (except _) are allowed in the name. The name must contain at least 1 non-numeric letter. The name must be unique. Names are not case sensitive, hence "aaa" is the same as "AAA". | |||
| | | values = string (unique) | ||
| | | versions = 1 | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], [[SMS:Dynamic Model Interface Schema#Element < table >|table]], all elements starting with "custom_control", [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <control_curve>|control_curve]] | |||
}} | |||
| | |||
| | |||
| | |||
{{XML attributes | |||
| | | name = unit_keyword | ||
| | | info = The units of a widget that begins with "control_" (where applicable). This provides a mapping for SMS to know the unit type. | ||
| | | values = | ||
Length: | Length: | ||
*LEN_KM (kilometers) | * #LEN_KM (kilometers) | ||
*LEN_M (meters) | * #LEN_M (meters) | ||
*LEN_FT (feet) | * #LEN_FT (feet) | ||
*LEN_CM (cm) | * #LEN_CM (cm) | ||
*LEN_MM (mm) | * #LEN_MM (mm) | ||
*LEN_INCH (inch) | * #LEN_INCH (inch) | ||
*LEN_YD (yd) | * #LEN_YD (yd) | ||
*LEN_MILE (mile) | * #LEN_MILE (mile) | ||
*LEN_UM (um) | * #LEN_UM (um) | ||
Time: | Time: | ||
*TIME_SECONDS | * #TIME_SECONDS | ||
*TIME_HOURS | * #TIME_HOURS | ||
*TIME_MINUTES | * #TIME_MINUTES | ||
*TIME_DAYS | * #TIME_DAYS | ||
*TIME_WEEKS | * #TIME_WEEKS | ||
Volume: | Volume: | ||
*VFLOW_CU_FT_PER_SEC | * #VFLOW_CU_FT_PER_SEC | ||
*VFLOW_CU_M_PER_SEC | * #VFLOW_CU_M_PER_SEC | ||
|} | | versions = 1 | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <option>|option]] | |||
}} | |||
{{XML attributes | |||
| name = use_dialog | |||
| info = Determines which dialog definition we are linking to | |||
| values = string | |||
| versions = 2 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <material_att>|material_att]], [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]] | |||
}} | |||
{{XML attributes | |||
| name = use_file | |||
| info = Complex command arguments can be built by referencing a <declare_file>. | |||
| values = string = a <declare_filename > | |||
| versions = 3 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <command_args>|command_args]] | |||
}} | |||
{{XML attributes | |||
{ | | name = use_icon | ||
| | | info = Allows for a custom icon to be imported into sms for coverages and simulations. When a coverage or simulation is create the custom icon will be shown instead of the default one in the tree structure. The icon must be given to Aquaveo in advance. The icon dimensions are 16x16 pixels. | ||
| values = string = (icon_name.bmp) | |||
| | | versions = 3 | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <simulation>|simulation]], [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]] | ||
}} | |||
| | |||
| | |||
{{XML attributes | |||
| name = version | |||
| info = Sets the version number | |||
| values = integer | |||
| versions = 1 | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model>|model]], [[SMS:Dynamic Model Interface Schema#Element <dynamic_model>|dynamic_model]] | |||
}} | |||
{{XML attributes | |||
{ | | name = z_is_elev | ||
| | | info = If the z value is elevation, set this to true. Default is false. | ||
| values = true, false | |||
| | | versions = 2 | ||
| | | used_by = [[SMS:Dynamic Model Interface Schema#Element <declare_coverage>|declare_coverage]] | ||
}} | |||
| | |||
| | |||
==== | ==Converting to the Dynamic Model Interface== | ||
The Dynamic Model Interface offers more flexibility to model developers than the Generic Model Interface which was used before. Generic Model Interface files can be converted into files for the Dynamic Model Interface. [http://www.aquaveo.com/contact-us Contact Aquaveo] for more information. | |||
==Tutorial Links== | |||
For more information on using the Dynamic Model Interface, download the XML file tutorial: | |||
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMI_XML_File.pdf DMI XML File Tutorial] | |||
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DynamicSample.zip DMI Tutorial Data] | |||
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMISamplePreProc.exe DMI Sample Pre-Processing Executable] | |||
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMISample.exe DMI Sample Executable] | |||
--> | |||
{{Navbox SMS}} | {{Navbox SMS}} | ||
[[Category:Dynamic Model Interface]] | |||
[[Category:External Links]] | |||
[[Category:Needs Update]] | |||
Latest revision as of 16:04, 4 March 2019
SMS – Surface-water Modeling System | ||
|---|---|---|
| Modules: | 1D Grid • Cartesian Grid • Curvilinear Grid • GIS • Map • Mesh • Particle • Quadtree • Raster • Scatter • UGrid |  |
| General Models: | 3D Structure • FVCOM • Generic • PTM | |
| Coastal Models: | ADCIRC • BOUSS-2D • CGWAVE • CMS-Flow • CMS-Wave • GenCade • STWAVE • WAM | |
| Riverine/Estuarine Models: | AdH • HEC-RAS • HYDRO AS-2D • RMA2 • RMA4 • SRH-2D • TUFLOW • TUFLOW FV | |
| Aquaveo • SMS Tutorials • SMS Workflows | ||
