Schema openDaApplication.xsd


element openDaApplication

diagram

annotation

documentation Main configuration for an OpenDA application. There are three mandatory components, which make up an OpenDA application: stochModelFactory, stochObserver and algorithm. Each component is configured by specifying its className attribute, workingDirectory and configFile/configString. An optional component is available for configuring the output of the results, and optional components for defining OpenDA restart input and output files.

complexType ApplicationInitialSeedXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation type   openda:ApplicationInitialSeedTypesXML   required         documentation Type of seed intialisation: fixed (i.e. always the same value), random value, or specific value. In the latter case, specify the seed value. seedValue   xs:integer   optional         documentation Value of initial seed, in case of type=="specify"

attribute ApplicationInitialSeedXML/@type

annotation

documentation Type of seed intialisation: fixed (i.e. always the same value), random value, or specific value. In the latter case, specify the seed value.

attribute ApplicationInitialSeedXML/@seedValue

annotation

documentation Value of initial seed, in case of type=="specify"

complexType ApplicationOptimizationXML

diagram

attributes

Name   Type   Use   Default   Fixed   Annotation productionRun   xs:boolean   required         documentation Optimize for performance at cost of (diagnostic) output VectorPrecisionIsFloat   xs:boolean   required         documentation The storage and computation precision of the default OpenDA Vector class is float. Note this will not hava any impact on other (native) vector implementations used in OpenDA VectorIsNative   xs:boolean   required         documentation The default vector used in OpenDA (class Vector) will use a native implementation (written in C) this is faster but at the cost of easy debugging of vector operations. Note the you need to have native OpenDA libraries compiled/installed on your system. Especially for debugging, not using the OpenDA start scripts, the libraties MUST be on you path

attribute ApplicationOptimizationXML/@productionRun

annotation

documentation Optimize for performance at cost of (diagnostic) output

attribute ApplicationOptimizationXML/@VectorPrecisionIsFloat

annotation

documentation The storage and computation precision of the default OpenDA Vector class is float. Note this will not hava any impact on other (native) vector implementations used in OpenDA

attribute ApplicationOptimizationXML/@VectorIsNative

annotation

documentation The default vector used in OpenDA (class Vector) will use a native implementation (written in C) this is faster but at the cost of easy debugging of vector operations. Note the you need to have native OpenDA libraries compiled/installed on your system. Especially for debugging, not using the OpenDA start scripts, the libraties MUST be on you path

complexType ApplicationTimeXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation precision   xs:string   required         documentation Precision of handling time, treshold for comparing unit   xs:string   optional   sec      documentation Unit of precision supported values sec,min,hour,MJD

attribute ApplicationTimeXML/@precision

annotation

documentation Precision of handling time, treshold for comparing

attribute ApplicationTimeXML/@unit

annotation

documentation Unit of precision supported values sec,min,hour,MJD

complexType ApplicationTimingSettingsXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation doTiming   xs:boolean   required         documentation (should the various steps in the application be timed?

attribute ApplicationTimingSettingsXML/@doTiming

annotation

documentation (should the various steps in the application be timed?

complexType OpenDaAlgorithmXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation className   xs:string   required         documentation Set the openda:java class name of the algorithm

attribute OpenDaAlgorithmXML/@className

annotation

documentation Set the openda:java class name of the algorithm

element OpenDaAlgorithmXML/workingDirectory

diagram
annotation	documentation Specify the directory, relative to the main configuration directory, where the algorithm configuration files are stored

element OpenDaAlgorithmXML/configFile

diagram
annotation	documentation Specify the name of the algorithm configuration file stored in the working directory

element OpenDaAlgorithmXML/configString

diagram
annotation	documentation Specify the configuration string (whether a configFile or configString is required depends on the choice of algorithm)

complexType OpenDaApplicationXML

diagram

element OpenDaApplicationXML/stochObserver

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation className   xs:string   required         documentation Set the openda:java class name of the stochastic observer
annotation	documentation Specify the stochastic observer component

element OpenDaApplicationXML/stochModelFactory

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation className   xs:string   required         documentation Set the openda:java class name of the stochastic model.
annotation	documentation Specify the stochastic model component

element OpenDaApplicationXML/algorithm

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation className   xs:string   required         documentation Set the openda:java class name of the algorithm
annotation	documentation Specify the algorithm for data assimilation or parameter calibration

element OpenDaApplicationXML/resultWriter

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation className   xs:string   required         documentation Specify the openda class name of the result writer
annotation	documentation Specify the content and format of the results file

element OpenDaApplicationXML/resultWriters

diagram
annotation	documentation Specify the results files in case more than one format is needed

element OpenDaApplicationXML/restartInFile

diagram
annotation	documentation Specify the input file from which the algoritm should restart. If omitted, no restart file is read. A restartFile of length zero is silently ignored and can be used to ignore the restart, ie to start without a restart.

element OpenDaApplicationXML/restartOutFilePrefix

diagram
annotation	documentation Specify the prefix to be used for the output restart files to be written. If ommitted, no restart files are written.

element OpenDaApplicationXML/restartOutFileExtension

diagram
annotation	documentation Specify the file extension to be used for restart output files (default: .xml). Overrules only the extension, but not the output format chosen by Openda (could be a zip file as well). Use of this option is discouraged.

element OpenDaApplicationXML/restartOutFileTimeTag

diagram
annotation	documentation Should the restart time be added to the filename of the restart file. Default is yes. Possible values: yes, no

element OpenDaApplicationXML/restartOutFileTimes

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation timeFormat   openda:RestartFormatTypesXML   optional   dateTimeString      documentation Specify the time format: 'mjd' (Modified Julian Day) or date/time string (formatted as yyyymmddhhmm) 'dateTimeString'.
annotation	documentation Specify the time stamps for which to write restarts

element OpenDaApplicationXML/timingSettings

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation doTiming   xs:boolean   required         documentation (should the various steps in the application be timed?
annotation	documentation Specify the settings for the run time timing

element OpenDaApplicationXML/optimizationSettings

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation productionRun   xs:boolean   required         documentation Optimize for performance at cost of (diagnostic) output VectorPrecisionIsFloat   xs:boolean   required         documentation The storage and computation precision of the default OpenDA Vector class is float. Note this will not hava any impact on other (native) vector implementations used in OpenDA VectorIsNative   xs:boolean   required         documentation The default vector used in OpenDA (class Vector) will use a native implementation (written in C) this is faster but at the cost of easy debugging of vector operations. Note the you need to have native OpenDA libraries compiled/installed on your system. Especially for debugging, not using the OpenDA start scripts, the libraties MUST be on you path
annotation	documentation Specify the optimization settings

element OpenDaApplicationXML/timeSettings

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation precision   xs:string   required         documentation Precision of handling time, treshold for comparing unit   xs:string   optional   sec      documentation Unit of precision supported values sec,min,hour,MJD
annotation	documentation Specify the time settings

element OpenDaApplicationXML/initialSeed

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation type   openda:ApplicationInitialSeedTypesXML   required         documentation Type of seed intialisation: fixed (i.e. always the same value), random value, or specific value. In the latter case, specify the seed value. seedValue   xs:integer   optional         documentation Value of initial seed, in case of type=="specify"
annotation	documentation Specify the type of initial seed (if ommited, default: "fixed")

complexType OpenDaResultWritersXML

diagram

element OpenDaResultWritersXML/resultWriter

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation className   xs:string   required         documentation Specify the openda class name of the result writer
annotation	documentation Specify the content and format of the results file

complexType OpenDaResultWriterXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation className   xs:string   required         documentation Specify the openda class name of the result writer

attribute OpenDaResultWriterXML/@className

annotation

documentation Specify the openda class name of the result writer

element OpenDaResultWriterXML/workingDirectory

diagram
annotation	documentation Specify the working directory where the results file should be stored

element OpenDaResultWriterXML/configFile

diagram
annotation	documentation Specify the results filename

element OpenDaResultWriterXML/configString

diagram
annotation	documentation Specify the configuration string (whether a configFile or configString is required depends on the choice of resultwriter)

element OpenDaResultWriterXML/selection

diagram
annotation	documentation Specify subselection of output sources and items to be written

complexType OpenDaStochModelXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation className   xs:string   required         documentation Set the openda:java class name of the stochastic model.

attribute OpenDaStochModelXML/@className

annotation

documentation Set the openda:java class name of the stochastic model.

element OpenDaStochModelXML/workingDirectory

diagram
annotation	documentation Specify the directory, relative to the main configuration directory, where the stochastic model configuration files are stored

element OpenDaStochModelXML/configFile

diagram
annotation	documentation Specify the name of the stochastic model configuration file stored in the working directory

element OpenDaStochModelXML/configString

diagram
annotation	documentation Specify the configuration string (whether a configFile or configString is required depends on the choice of stochastic model)

complexType OpenDaStochObserverXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation className   xs:string   required         documentation Set the openda:java class name of the stochastic observer

attribute OpenDaStochObserverXML/@className

annotation

documentation Set the openda:java class name of the stochastic observer

element OpenDaStochObserverXML/workingDirectory

diagram
annotation	documentation Specify the directory, relative to the main configuration directory, where the stochastic observer configuration files are stored

element OpenDaStochObserverXML/configFile

diagram
annotation	documentation Specify the name of the stochastic observer configuration file stored in the working directory

element OpenDaStochObserverXML/configString

diagram
annotation	documentation Specify the configuration string (whether a configFile or configString is required depends on the choice of stochastic observer)

complexType RestartOutFileTimesXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation timeFormat   openda:RestartFormatTypesXML   optional   dateTimeString      documentation Specify the time format: 'mjd' (Modified Julian Day) or date/time string (formatted as yyyymmddhhmm) 'dateTimeString'.

attribute RestartOutFileTimesXML/@timeFormat

annotation

documentation Specify the time format: 'mjd' (Modified Julian Day) or date/time string (formatted as yyyymmddhhmm) 'dateTimeString'.

simpleType ApplicationInitialSeedTypesXML

---

simpleType RestartFormatTypesXML

---

element resultSelection

diagram

complexType ResultItemXML

diagram

attributes

Name   Type   Use   Default   Fixed   Annotation id   xs:string   optional         documentation Identity (name) of the result item minSize   xs:integer   optional         documentation Minimum size (number of elements) of the result item. maxSize   xs:integer   optional         documentation Maximum size (number of elements) of the result item. outputLevel   openda:ResultWriterOutputLevelXML   optional         documentation Grouping of the result items according to their level of significance: None, Essential,Normal,Verbose,All. context   xs:string   optional         documentation Context in which the result item should be written in the output, for example model instance id, iteration id, etc. doLog   xs:boolean   optional         documentation Switch output of result item on or off source   openda:ResultWriterSourceTypeXML   optional         documentation Source of the result item ("observer", "model", "algorithm" or "other")

attribute ResultItemXML/@id

annotation

documentation Identity (name) of the result item

attribute ResultItemXML/@minSize

annotation

documentation Minimum size (number of elements) of the result item.

attribute ResultItemXML/@maxSize

annotation

documentation Maximum size (number of elements) of the result item.

attribute ResultItemXML/@outputLevel

annotation

documentation Grouping of the result items according to their level of significance: None, Essential,Normal,Verbose,All.

attribute ResultItemXML/@context

annotation

documentation Context in which the result item should be written in the output, for example model instance id, iteration id, etc.

attribute ResultItemXML/@doLog

annotation

documentation Switch output of result item on or off

attribute ResultItemXML/@source

annotation

documentation Source of the result item ("observer", "model", "algorithm" or "other")

element ResultItemXML/messageType

diagram
annotation	documentation Type of message ("step", "inner", "outer", or "evaluation"). Deprecated function, will not be supported in future versions of OpenDA.

complexType ResultLoggingXML

diagram

attributes

Name   Type   Use   Default   Fixed   Annotation observer   xs:boolean   optional   true      documentation Output source is observer model   xs:boolean   optional   true      documentation Output source is model algorithm   xs:boolean   optional   true      documentation Output source is algorithm nonConfiguredItems   xs:boolean   optional   true      documentation Output source is other non-declared component

attribute ResultLoggingXML/@observer

annotation

documentation Output source is observer

attribute ResultLoggingXML/@model

annotation

documentation Output source is model

attribute ResultLoggingXML/@algorithm

annotation

documentation Output source is algorithm

attribute ResultLoggingXML/@nonConfiguredItems

annotation

documentation Output source is other non-declared component

complexType ResultSelectionXML

diagram

element ResultSelectionXML/doLog

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation observer   xs:boolean   optional   true      documentation Output source is observer model   xs:boolean   optional   true      documentation Output source is model algorithm   xs:boolean   optional   true      documentation Output source is algorithm nonConfiguredItems   xs:boolean   optional   true      documentation Output source is other non-declared component
annotation	documentation Switch sources on or off for output

element ResultSelectionXML/resultItem

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation id   xs:string   optional         documentation Identity (name) of the result item minSize   xs:integer   optional         documentation Minimum size (number of elements) of the result item. maxSize   xs:integer   optional         documentation Maximum size (number of elements) of the result item. outputLevel   openda:ResultWriterOutputLevelXML   optional         documentation Grouping of the result items according to their level of significance: None, Essential,Normal,Verbose,All. context   xs:string   optional         documentation Context in which the result item should be written in the output, for example model instance id, iteration id, etc. doLog   xs:boolean   optional         documentation Switch output of result item on or off source   openda:ResultWriterSourceTypeXML   optional         documentation Source of the result item ("observer", "model", "algorithm" or "other")
annotation	documentation Select the items to be switched on/off for output

simpleType ResultWriterMessageTypeXML

---

simpleType ResultWriterOutputLevelXML

---

simpleType ResultWriterSourceTypeXML

---

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy