User:Jcreer/SMS:DMI File Definitions Elements: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOINDEX__
{{TOCright}}
{{TOCright}}
==Elements==
==Elements==
Line 47: Line 48:
|'''Used by'''
|'''Used by'''
|[[SMS:Dynamic Model Interface Schema#Element <card>|card]]
|[[SMS:Dynamic Model Interface Schema#Element <card>|card]]
|-
|'''Example'''
|
|}
=====Element ''<end_card>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"|Defines that the card end with a single iteration of the enclosing <process_each_XXX>
|-
|'''Versions'''
|1
|-
|'''Attributes'''
|none
|-
|'''Children'''
|none
|-
|'''Used by'''
|anything starting with process_each
|-
|-
|'''Example'''
|'''Example'''
Line 74: Line 97:
|}
|}


=====Element ''<file_def>''=====
=====Element ''<input_file>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| file_def
|width="530"| Defines a file to be used for input for an executable. 
|-
|-
|'''Versions'''
|'''Versions'''
Line 84: Line 107:
|-
|-
|'''Attributes'''
|'''Attributes'''
|control_def
|none
|-
|-
|'''Children'''
|'''Children'''
|width="530"| file_ref, [[SMS:Dynamic Model Interface Schema#Element <file_type>|file_type]], [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <card>|card]]
|width="530"| file_ref, [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <execute>|execute]], [[SMS:Dynamic Model Interface Schema#Element <command_args>|command_args]], [[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]]
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <model>|model]]
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]]
|-
|-
|'''Example'''
|'''Example'''
|width="530"|
|width="530"| See executable example.
|}
|}


=====Element ''<file_type>''=====
=====Element ''<input_files>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| The file format. Keywords include SEQUENTIAL_ASCII, CARD_ASCII
|width="530"| A container to place all of the input files into for a simulation.  
|-
|-
|'''Versions'''
|'''Versions'''
| 2
| 3
|-
|-
|'''Attributes'''
|'''Attributes'''
Line 109: Line 132:
|-
|-
|'''Children'''
|'''Children'''
|width="530"| none
|width="530"| input_file
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <file_def>|file_def]]
| width="530"| simulation
|-
|-
|'''Example'''
|'''Example'''
Line 118: Line 141:
|}
|}


=====Element ''<input_file>''=====
=====Element ''<output_file>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| Defines a file to be used for input for an executable.
|width="530"| Defines a file to be created by the executable.  
|-
|-
|'''Versions'''
|'''Versions'''
| 2
| 1, 2
|-
|-
|'''Attributes'''
|'''Attributes'''
Line 131: Line 154:
|-
|-
|'''Children'''
|'''Children'''
|width="530"| file_ref, [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <execute>|execute]], [[SMS:Dynamic Model Interface Schema#Element <command_args>|command_args]], [[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]]
|width="530"| file_ref, [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <execute>|execute]], export_table, export_each_coverage, export_each_material
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]]
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]]
|-
|-
|'''Example'''
|'''Example '''
|width="530"| See executable example.
|width="530"|See executable example.
|}
|}


=====Element ''<output_file>''=====
=====Element ''<output_files>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| Defines a file to be created by the executable.   
|width="530"| A container to place all of the output files into for a simulation.   
|-
|-
|'''Versions'''
|'''Versions'''
| 1, 2
| 3
|-
|-
|'''Attributes'''
|'''Attributes'''
Line 153: Line 176:
|-
|-
|'''Children'''
|'''Children'''
|width="530"| file_ref, [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <execute>|execute]], export_table, export_each_coverage, export_each_material
|width="530"| output_file
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]]
| width="530"| simulation
|-
|-
|'''Example '''
|'''Example '''
Line 230: Line 253:
|width="530"|declare_file_def, section
|width="530"|declare_file_def, section
|}
|}
[[Category:Jcreer|DMI]]

Latest revision as of 16:13, 4 March 2019


Elements

Element <card>
Info Determines the card name and format when the item is exported. For more examples see <export_format>.
Versions 1, 2
Attributes none
Children card_name, export_format, export_location, dependency, anything beginning with “process_each_”, export_group, export_optional
Used by file_def
Example 
<item>
   <text>Formulation</text>
   <card>
         <card_name>FORMULATION</card_name>
         <export_format>card "formulationUnits"</export_format>
   </card>
Element <card_name>
Info The name of the card which is used in the card file.
Versions 1, 2
Attributes none
Children none
Used by card
Example
Element <end_card>
Info Defines that the card end with a single iteration of the enclosing <process_each_XXX>
Versions 1
Attributes none
Children none
Used by anything starting with process_each
Example
Element <files>
Info
Versions 2
Attributes
Children file_def
Used by model_control_executable
Example
Element <input_file>
Info Defines a file to be used for input for an executable.
Versions 2
Attributes none
Children file_ref, export_location, execute, command_args, process_each_row, process_each_coverage, process_each_material
Used by executable
Example See executable example.
Element <input_files>
Info A container to place all of the input files into for a simulation.
Versions 3
Attributes none
Children input_file
Used by simulation
Example
Element <output_file>
Info Defines a file to be created by the executable.
Versions 1, 2
Attributes none
Children file_ref, export_location, execute, export_table, export_each_coverage, export_each_material
Used by executable
Example See executable example.
Element <output_files>
Info A container to place all of the output files into for a simulation.
Versions 3
Attributes none
Children output_file
Used by simulation
Example See executable example.
Element <section>
Info Defines a section of a file that may be in a different, but compatible, file format.
Versions 3
Attributes file_type

ignore_on_read

file_ref

file_type

Children card, use_file_def
Used by card, anything beginning with “process_each”
Example
Element <separator>
Info Determines how to separate text that is being exported into a text file.
Versions 1, 2
Attributes none
Children none
Used by export_each_row
Example See <export_table>

Attributes

Attribute @ <file_type>
Info

Specifies a file type of <declare_file_def> defines the file type.

Values “CARD_ASCII”, “SEQUENTIAL_ASCII”, “SEQUENTIAL_BINARY”, “XMDF”
Version 2
Used by declare_file_def, section
Retrieved from "https://www.xmswiki.com/index.php?title=User:Jcreer/SMS:DMI_File_Definitions_Elements&oldid=138507"