Schema openDA.xsd


element openDaApplication
diagram openDA_diagrams/openDA_p1.png
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 openDA_diagrams/openDA_p2.png
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 openDA_diagrams/openDA_p3.png
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 openDA_diagrams/openDA_p4.png
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 openDA_diagrams/openDA_p5.png
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 openDA_diagrams/openDA_p6.png
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 openDA_diagrams/openDA_p7.png
annotation
documentation
Specify the directory, relative to the main configuration directory, where the algorithm configuration files are stored

element OpenDaAlgorithmXML/configFile
diagram openDA_diagrams/openDA_p8.png
annotation
documentation
Specify the name of the algorithm configuration file stored in the working directory

element OpenDaAlgorithmXML/configString
diagram openDA_diagrams/openDA_p9.png
annotation
documentation
Specify the configuration string (whether a configFile or configString is required depends on the choice of algorithm)

complexType OpenDaApplicationXML
diagram openDA_diagrams/openDA_p10.png

element OpenDaApplicationXML/stochObserver
diagram openDA_diagrams/openDA_p11.png
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 openDA_diagrams/openDA_p12.png
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 openDA_diagrams/openDA_p13.png
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 openDA_diagrams/openDA_p14.png
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 openDA_diagrams/openDA_p15.png
annotation
documentation
Specify the results files in case more than one format is needed

element OpenDaApplicationXML/restartInFile
diagram openDA_diagrams/openDA_p16.png
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 openDA_diagrams/openDA_p17.png
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 openDA_diagrams/openDA_p18.png
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 openDA_diagrams/openDA_p19.png
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 openDA_diagrams/openDA_p20.png
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 openDA_diagrams/openDA_p21.png
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 openDA_diagrams/openDA_p22.png
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 openDA_diagrams/openDA_p23.png
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 openDA_diagrams/openDA_p24.png
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 openDA_diagrams/openDA_p25.png

element OpenDaResultWritersXML/resultWriter
diagram openDA_diagrams/openDA_p26.png
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 openDA_diagrams/openDA_p27.png
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 openDA_diagrams/openDA_p28.png
annotation
documentation
Specify the working directory where the results file should be stored

element OpenDaResultWriterXML/configFile
diagram openDA_diagrams/openDA_p29.png
annotation
documentation
Specify the results filename

element OpenDaResultWriterXML/configString
diagram openDA_diagrams/openDA_p30.png
annotation
documentation
Specify the configuration string (whether a configFile or configString is required depends on the choice of resultwriter)

element OpenDaResultWriterXML/selection
diagram openDA_diagrams/openDA_p31.png
annotation
documentation
Specify subselection of output sources and items to be written

complexType OpenDaStochModelXML
diagram openDA_diagrams/openDA_p32.png
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 openDA_diagrams/openDA_p33.png
annotation
documentation
Specify the directory, relative to the main configuration directory, where the stochastic model configuration files are stored

element OpenDaStochModelXML/configFile
diagram openDA_diagrams/openDA_p34.png
annotation
documentation
Specify the name of the stochastic model configuration file stored in the working directory

element OpenDaStochModelXML/configString
diagram openDA_diagrams/openDA_p35.png
annotation
documentation
Specify the configuration string (whether a configFile or configString is required depends on the choice of stochastic model)

complexType OpenDaStochObserverXML
diagram openDA_diagrams/openDA_p36.png
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 openDA_diagrams/openDA_p37.png
annotation
documentation
Specify the directory, relative to the main configuration directory, where the stochastic observer configuration files are stored

element OpenDaStochObserverXML/configFile
diagram openDA_diagrams/openDA_p38.png
annotation
documentation
Specify the name of the stochastic observer configuration file stored in the working directory

element OpenDaStochObserverXML/configString
diagram openDA_diagrams/openDA_p39.png
annotation
documentation
Specify the configuration string (whether a configFile or configString is required depends on the choice of stochastic observer)

complexType RestartOutFileTimesXML
diagram openDA_diagrams/openDA_p40.png
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 calibrationRestart
diagram openDA_diagrams/openDA_p41.png
annotation
documentation
Restart settings for an Algoritm. Generic part: params. Algorithm specific parts per algorithm

element dudRestart
diagram openDA_diagrams/openDA_p42.png

element powelRestart
diagram openDA_diagrams/openDA_p43.png

element simplexRestart
diagram openDA_diagrams/openDA_p44.png

complexType CalibrationRestartXML
diagram openDA_diagrams/openDA_p45.png

element CalibrationRestartXML/methodName
diagram openDA_diagrams/openDA_p46.png

element CalibrationRestartXML/comment
diagram openDA_diagrams/openDA_p47.png

element CalibrationRestartXML/dud
diagram openDA_diagrams/openDA_p48.png

element CalibrationRestartXML/powell
diagram openDA_diagrams/openDA_p49.png

element CalibrationRestartXML/simplex
diagram openDA_diagrams/openDA_p50.png

complexType DudXML
diagram openDA_diagrams/openDA_p51.png

element DudXML/params
diagram openDA_diagrams/openDA_p52.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
caption  xs:string        
excludeFromVector  xs:boolean  optional      
className  xs:string        

element DudXML/paramVector
diagram openDA_diagrams/openDA_p53.png

element DudXML/costValue
diagram openDA_diagrams/openDA_p54.png

element DudXML/predictions
diagram openDA_diagrams/openDA_p55.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
caption  xs:string        
excludeFromVector  xs:boolean  optional      
className  xs:string        

element DudXML/predictionVector
diagram openDA_diagrams/openDA_p56.png

complexType PowellXML
diagram openDA_diagrams/openDA_p57.png

element PowellXML/baseParams
diagram openDA_diagrams/openDA_p58.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
caption  xs:string        
excludeFromVector  xs:boolean  optional      
className  xs:string        

element PowellXML/baseParamVector
diagram openDA_diagrams/openDA_p59.png

element PowellXML/searchDirParams
diagram openDA_diagrams/openDA_p60.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
caption  xs:string        
excludeFromVector  xs:boolean  optional      
className  xs:string        

element PowellXML/searchDirParamVector
diagram openDA_diagrams/openDA_p61.png

element PowellXML/costValue
diagram openDA_diagrams/openDA_p62.png

complexType SimplexXML
diagram openDA_diagrams/openDA_p63.png

element SimplexXML/params
diagram openDA_diagrams/openDA_p64.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
caption  xs:string        
excludeFromVector  xs:boolean  optional      
className  xs:string        

element SimplexXML/paramVector
diagram openDA_diagrams/openDA_p65.png

element SimplexXML/costValue
diagram openDA_diagrams/openDA_p66.png

simpleType MethodNameXML

element filterRestart
diagram openDA_diagrams/openDA_p67.png
annotation
documentation
Restart settings for an Algoritm. Generic part: params. Algorithm specific parts per algorithm

complexType EnsembleFiltersRestartXML
diagram openDA_diagrams/openDA_p68.png

element EnsembleFiltersRestartXML/size
diagram openDA_diagrams/openDA_p69.png

complexType FilterRestartXML
diagram openDA_diagrams/openDA_p70.png

element FilterRestartXML/filterName
diagram openDA_diagrams/openDA_p71.png

element FilterRestartXML/comment
diagram openDA_diagrams/openDA_p72.png

element FilterRestartXML/ensemble
diagram openDA_diagrams/openDA_p73.png

simpleType FilterNameXML

element opendaKalmanGainStorage
diagram openDA_diagrams/openDA_p74.png
annotation
documentation
Restart settings for an Algoritm. Generic part: params. Algorithm specific parts per algorithm

complexType KalmanGainObservationsXML
diagram openDA_diagrams/openDA_p75.png

element KalmanGainObservationsXML/observation
diagram openDA_diagrams/openDA_p76.png

complexType KalmanGainObservationXML
diagram openDA_diagrams/openDA_p77.png

element KalmanGainObservationXML/id
diagram openDA_diagrams/openDA_p78.png
annotation
documentation
The identifier for the observation (unique with the list of stored observations)

element KalmanGainObservationXML/timeOffsetInDays
diagram openDA_diagrams/openDA_p79.png
annotation
documentation
The time offset of the observation, expressed in days, relative to the time stamp for this kalman gain (0 means: same time stamp as the gain, negative means before the kalman gain time stamp)

element KalmanGainObservationXML/vector
diagram openDA_diagrams/openDA_p80.png
annotation
documentation
The values of the kalman gain for this observation. This optional field is only present if the size is limited (default max 40 values; this maximum can be overridden by the filter)

element KalmanGainObservationXML/treeVector
diagram openDA_diagrams/openDA_p81.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
caption  xs:string        
excludeFromVector  xs:boolean  optional      
className  xs:string        
annotation
documentation
The values of the kalman gain for this observation, represented as tree vector. Present if the size is limited (see above)

element KalmanGainObservationXML/fileName
diagram openDA_diagrams/openDA_p82.png
annotation
documentation
The netCdfFile containing the values. This optional field is present if the gain is at TreeVector, or if there are more values than the maximum mentioned above

complexType KalmanGainStorageXML
diagram openDA_diagrams/openDA_p83.png

element KalmanGainStorageXML/comment
diagram openDA_diagrams/openDA_p84.png
annotation
documentation
Optional comment on the stored kalman gain

element KalmanGainStorageXML/timeStampAsMJD
diagram openDA_diagrams/openDA_p85.png
annotation
documentation
The time stamp for which the kalman gain is valid, represented as Modified Julian Day

element KalmanGainStorageXML/stateSize
diagram openDA_diagrams/openDA_p86.png

element KalmanGainStorageXML/timeStampAsDateTime
diagram openDA_diagrams/openDA_p87.png
annotation
documentation
The time step mentioned above, represented as Date Time

element KalmanGainStorageXML/observations
diagram openDA_diagrams/openDA_p88.png

element blackBoxStochModel
diagram openDA_diagrams/openDA_p89.png
annotation
documentation
Configuration file for the Stochastic model class org.openda.blackbox.wrapper.BBStochModelFactory. Specifies either the deterministic model in the modelConfig element, or the model instances generator in the modelFactory element, and the stochastic model that acts as umbrella over the deterministic model, in the vectorSpecification element, and an optional restartInfo element for non-default handling of deterministic model restarts. The element uncertaintyModule is included for backwards compatibility only.

complexType BlackBoxModelConfigReferenceXML
diagram openDA_diagrams/openDA_p90.png

element BlackBoxModelConfigReferenceXML/config
diagram openDA_diagrams/openDA_p91.png
annotation
documentation
Specify black box model configuration directly in the blackBoxModelConfig format

element BlackBoxModelConfigReferenceXML/file
diagram openDA_diagrams/openDA_p92.png
annotation
documentation
Specify filename of the black box model configuration file. File format: blackBoxModelConfig

complexType BlackBoxStochModelConfigXML
diagram openDA_diagrams/openDA_p93.png

element BlackBoxStochModelConfigXML/modelConfig
diagram openDA_diagrams/openDA_p94.png
annotation
documentation
Specify a specific black box model configuration. This can be either by writing directly the model configuration or by referring to a black box model configuration file.

element BlackBoxStochModelConfigXML/modelFactory
diagram openDA_diagrams/openDA_p95.png
attributes
Name  Type  Use  Default  Fixed  Annotation
exe  xs:string  optional      
documentation
Name and path of the executable file
windowsExe  xs:string  optional      
documentation
Name and path of the executable file for Windows operating system
linuxExe  xs:string  optional      
documentation
Name and path of the executable file for Linux operating system
macExe  xs:string  optional      
documentation
Name and path of the executable file for Mac operating system
className  xs:string  optional      
documentation
The openda:class name.
workingDirectory  xs:string  optional      
documentation
Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig.
actualWorkingDirectory  xs:string  optional      
documentation
Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory.
ignoreStatus  xs:boolean  optional  false    
documentation
Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.
annotation
documentation
Define a model factory. Specify class or executable, arguments to supply and fail/success checks to perform

element BlackBoxStochModelConfigXML/uncertaintyModule
diagram openDA_diagrams/openDA_p96.png
attributes
Name  Type  Use  Default  Fixed  Annotation
exe  xs:string  optional      
documentation
Name and path of the executable file
windowsExe  xs:string  optional      
documentation
Name and path of the executable file for Windows operating system
linuxExe  xs:string  optional      
documentation
Name and path of the executable file for Linux operating system
macExe  xs:string  optional      
documentation
Name and path of the executable file for Mac operating system
className  xs:string  optional      
documentation
The openda:class name.
workingDirectory  xs:string  optional      
documentation
Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig.
actualWorkingDirectory  xs:string  optional      
documentation
Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory.
ignoreStatus  xs:boolean  optional  false    
documentation
Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.
annotation
documentation
DEPRECATED. Use of this element is discouraged, use vectorSpecification -> parameters -> uncertaintyModule instead. Define stochastic model through an uncertainty module. Specify class or executable file, arguments to supply and fail/success checks to perform.

element BlackBoxStochModelConfigXML/rangeValidationConfigFile
diagram openDA_diagrams/openDA_p97.png
annotation
documentation
Optional. Path and name of a range validation config file (relative to this configuration file) that contains range validation constraints for exchange items.

element BlackBoxStochModelConfigXML/boundaryProvider
diagram openDA_diagrams/openDA_p98.png
annotation
documentation
Specify external forcings, being either boundaries, noise on boundaries or boundaries including noise.

element BlackBoxStochModelConfigXML/vectorSpecification
diagram openDA_diagrams/openDA_p99.png
annotation
documentation
Define stochastic model by specifying the vectors of parameters, state, and/or predictor

element BlackBoxStochModelConfigXML/restartInfo
diagram openDA_diagrams/openDA_p100.png
attributes
Name  Type  Use  Default  Fixed  Annotation
dirPrefix  xs:string  optional  ./savedStochModelState_    
documentation
Specify the model directory that will contain a set of restart files for a certain time stamp
(written when the algorithm requests to store states, read when the algorithm asks to restore a state)
noiseModelPrefix  xs:string  optional  ./noiseModel_    
documentation
Specify the file name prefix for storing the state of the noise model(s)
modelStateFile  xs:string  optional  ./modelState.zip    
documentation
Specify the file name prefix for storing the model state (must end with .zip)
annotation
documentation
Restart dir./files information

complexType BlackBoxStochModelParametersXML
diagram openDA_diagrams/openDA_p101.png

element BlackBoxStochModelParametersXML/uncertaintyModule
diagram openDA_diagrams/openDA_p102.png
attributes
Name  Type  Use  Default  Fixed  Annotation
className  xs:string        
documentation
The class name implementing the noise model
workingDirectory  xs:string  optional      
documentation
The noise model's working directory
annotation
documentation
The uncertainty module that defines and generates the noise correction factor exchange items

element BlackBoxStochModelParametersXML/regularisationConstant
diagram openDA_diagrams/openDA_p103.png
attributes
Name  Type  Use  Default  Fixed  Annotation
scale  xs:double  optional  1    
documentation
Set the scaling factor for this parameter (optional)
id  xs:string  optional      
documentation
Optional id for composed items that are all modified by the same parameter.
If omitted, the id's of the separate item will be concatenated. Note: the (concatenated) id is mainly used by the sparse dud algorithm
annotation
documentation
Specify which model parameters to adjust and how

element BlackBoxStochModelParametersXML/cartesianToPolar
diagram openDA_diagrams/openDA_p104.png
attributes
Name  Type  Use  Default  Fixed  Annotation
xScale  xs:double  optional  1    
documentation
Scaling factor for dx
yScale  xs:double  optional  1    
documentation
Scaling factor for dy
xSuffixCaption  xs:string  optional  dX    
documentation
Name suffix for dx in the noise model exchange items
ySuffixCaption  xs:string  optional  dY    
documentation
Name suffix for dy in the noise model exchange items
xCaption  xs:string  optional      
documentation
Name for dx in the noise model exchange items
yCaption  xs:string  optional      
documentation
Name for dy in the noise model exchange items
annotation
documentation
Specify which model parameters to adjust and how, under a transformation of the vector representation, from Cartesian (dx,dy) to Polar (amplitude,phase)

complexType BlackBoxStochModelRestartInfoXML
diagram openDA_diagrams/openDA_p105.png
attributes
Name  Type  Use  Default  Fixed  Annotation
dirPrefix  xs:string  optional  ./savedStochModelState_    
documentation
Specify the model directory that will contain a set of restart files for a certain time stamp
(written when the algorithm requests to store states, read when the algorithm asks to restore a state)
noiseModelPrefix  xs:string  optional  ./noiseModel_    
documentation
Specify the file name prefix for storing the state of the noise model(s)
modelStateFile  xs:string  optional  ./modelState.zip    
documentation
Specify the file name prefix for storing the model state (must end with .zip)

attribute BlackBoxStochModelRestartInfoXML/@dirPrefix
annotation
documentation
Specify the model directory that will contain a set of restart files for a certain time stamp
(written when the algorithm requests to store states, read when the algorithm asks to restore a state)

attribute BlackBoxStochModelRestartInfoXML/@noiseModelPrefix
annotation
documentation
Specify the file name prefix for storing the state of the noise model(s)

attribute BlackBoxStochModelRestartInfoXML/@modelStateFile
annotation
documentation
Specify the file name prefix for storing the model state (must end with .zip)

complexType BlackBoxStochModelStateXML
diagram openDA_diagrams/openDA_p106.png

element BlackBoxStochModelStateXML/noiseModel
diagram openDA_diagrams/openDA_p107.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  optional      
documentation
Specify the identity of the noise model vector. It is required if the noise model contains more than one source vectors. If the noise model contains one subvector, it may be omitted. In that case the source (sub-)vector's id is used.
className  xs:string  optional      
documentation
The class that implements the noise model
workingDirectory  xs:string  optional      
documentation
The working directory where the noise model is started
annotation
documentation
Add a noise model to the state

element BlackBoxStochModelStateXML/vector
diagram openDA_diagrams/openDA_p108.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the vector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig
annotation
documentation
Add a vector to the state

element BlackBoxStochModelStateXML/subVector
diagram openDA_diagrams/openDA_p109.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the subVector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig
annotation
documentation
Add a subvector to the state

complexType BlackBoxStochModelSubVectorXML
diagram openDA_diagrams/openDA_p110.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the subVector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig

attribute BlackBoxStochModelSubVectorXML/@id
annotation
documentation
Identity of the subVector

attribute BlackBoxStochModelSubVectorXML/@sourceVectorId
annotation
documentation
Identity of the source vector as defined in blackBoxModelConfig

element BlackBoxStochModelSubVectorXML/selection
diagram openDA_diagrams/openDA_p111.png
attributes
Name  Type  Use  Default  Fixed  Annotation
index1  openda:indexStringType  required      
documentation
Indices of the selected array elements of the first dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index2  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the second dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index3  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the third dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
base  xs:int  optional  0    
documentation
Base number, which gives the index of the vector's first element (sometimes 1 instead of 0)
annotation
documentation
Select subvector using indices of the vector elements

element BlackBoxStochModelSubVectorXML/selector
diagram openDA_diagrams/openDA_p112.png
attributes
Name  Type  Use  Default  Fixed  Annotation
className  xs:string  required      
documentation
Specify the openda:class name for performing this operation
annotation
documentation
Define operator for deriving the subvector

complexType BlackBoxStochModelUncertainParameterXML
diagram openDA_diagrams/openDA_p113.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  optional      
documentation
Identity of model's exchange item
uncertainItemId  xs:string  optional      
documentation
Identity of noise model's exchange item
transformation  openda:ParameterTransformationTypesXML  optional  identity    
documentation
Transformation of noise variable. 'identity' means that the value will be added directly  without any transformation to the adjusted parameter. 'ln' means that the value is transformed logarithmically before it is added to the parameter; this gives a correction, which is a fraction of the parameter value.

attribute BlackBoxStochModelUncertainParameterXML/@id
annotation
documentation
Identity of model's exchange item

attribute BlackBoxStochModelUncertainParameterXML/@uncertainItemId
annotation
documentation
Identity of noise model's exchange item

attribute BlackBoxStochModelUncertainParameterXML/@transformation
annotation
documentation
Transformation of noise variable. 'identity' means that the value will be added directly  without any transformation to the adjusted parameter. 'ln' means that the value is transformed logarithmically before it is added to the parameter; this gives a correction, which is a fraction of the parameter value.

complexType BlackBoxStochModelVectorSpecificationXML
diagram openDA_diagrams/openDA_p114.png

element BlackBoxStochModelVectorSpecificationXML/parameters
diagram openDA_diagrams/openDA_p115.png
annotation
documentation
Specify the model parameters vectors

element BlackBoxStochModelVectorSpecificationXML/state
diagram openDA_diagrams/openDA_p116.png
annotation
documentation
Specify the model state vectors

element BlackBoxStochModelVectorSpecificationXML/predictor
diagram openDA_diagrams/openDA_p117.png
attributes
Name  Type  Use  Default  Fixed  Annotation
collectTimeSeries  xs:boolean    false    
documentation
A flag for indicating whether predictor timeseries should be kept in the memory during simulation.
annotation
documentation
Specify the predictor vectors. i.e. the model variables that correspond to the observer variables. This can contain three different types of mappings between model and observer variables:
1. a vector for a mapping between an observed scalar and a scalar in the model. In this case the coordinates are not used and no interpolation is done.
2. a vector for a mapping between an observed grid and a grid in the model. In this case the model values are interpolated to get values at the cell centers of the observed grid. This uses the coordinates of both grids and bilinear interpolation.
3. a subVector for a mapping between an observed scalar and a cell of a grid in the model. In this case the coordinates are not used and no interpolation is done.

complexType BlackBoxStochModelVectorsXML
diagram openDA_diagrams/openDA_p118.png
attributes
Name  Type  Use  Default  Fixed  Annotation
collectTimeSeries  xs:boolean    false    
documentation
A flag for indicating whether predictor timeseries should be kept in the memory during simulation.

attribute BlackBoxStochModelVectorsXML/@collectTimeSeries
annotation
documentation
A flag for indicating whether predictor timeseries should be kept in the memory during simulation.

element BlackBoxStochModelVectorsXML/vector
diagram openDA_diagrams/openDA_p119.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the vector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig
annotation
documentation
Add a vector to the predictor

element BlackBoxStochModelVectorsXML/subVector
diagram openDA_diagrams/openDA_p120.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the subVector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig
annotation
documentation
Add a subvector to the predictor

complexType BlackBoxStochModelVectorXML
diagram openDA_diagrams/openDA_p121.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the vector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig

attribute BlackBoxStochModelVectorXML/@id
annotation
documentation
Identity of the vector

attribute BlackBoxStochModelVectorXML/@sourceVectorId
annotation
documentation
Identity of the source vector as defined in blackBoxModelConfig

complexType BoundaryDataObjectXML
diagram openDA_diagrams/openDA_p122.png

element BoundaryDataObjectXML/className
diagram openDA_diagrams/openDA_p123.png
annotation
documentation
The openda class name of the forcing's data object.

element BoundaryDataObjectXML/file
diagram openDA_diagrams/openDA_p124.png
annotation
documentation
Name of the forcing's data file.

element BoundaryDataObjectXML/arg
diagram openDA_diagrams/openDA_p125.png
annotation
documentation
Input argument(s) for the corresponding openda:class

complexType BoundaryExchangeItemXML
diagram openDA_diagrams/openDA_p126.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of a forcing ExchangeItem.
modelExchangeItemId  xs:string  optional      
documentation
Identity of the model ExchangeItem on which to impose this forcing ExchangeItem. If the model ExchangeItem id equals the id of the forcing ExchangeItem, then this attribute is not needed.

attribute BoundaryExchangeItemXML/@id
annotation
documentation
Identity of a forcing ExchangeItem.

attribute BoundaryExchangeItemXML/@modelExchangeItemId
annotation
documentation
Identity of the model ExchangeItem on which to impose this forcing ExchangeItem. If the model ExchangeItem id equals the id of the forcing ExchangeItem, then this attribute is not needed.

complexType BoundaryMappingXML
diagram openDA_diagrams/openDA_p127.png

element BoundaryMappingXML/operation
diagram openDA_diagrams/openDA_p128.png
annotation
documentation
(set): Replace model ExchangeItem's content by forcing ExchangeItem's content. (add): Add the forcing ExchangeItem's content to the model ExchangeItem's content. (multiply): Multiply the model ExchangeItem's content by the forcing ExchangeItem's content.

element BoundaryMappingXML/exchangeItem
diagram openDA_diagrams/openDA_p129.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of a forcing ExchangeItem.
modelExchangeItemId  xs:string  optional      
documentation
Identity of the model ExchangeItem on which to impose this forcing ExchangeItem. If the model ExchangeItem id equals the id of the forcing ExchangeItem, then this attribute is not needed.
annotation
documentation
List the forcing ExchangeItems for which to apply this mapping's operation. If this list is not specified, then the specified operation will be used for all forcing ExchangeItems from the specified file (in that case the model ExchangeItems must have the same ids as the forcing ExchangeItems).

complexType BoundaryProviderXML
diagram openDA_diagrams/openDA_p130.png

element BoundaryProviderXML/dataObject
diagram openDA_diagrams/openDA_p131.png
annotation
documentation
The data object containing the forcing data.

element BoundaryProviderXML/boundaryMapping
diagram openDA_diagrams/openDA_p132.png
annotation
documentation
Specify the operation when imposing the forcing ExchangeItems on the model ExchangeItems.

complexType CartesianToPolarXML
diagram openDA_diagrams/openDA_p133.png
attributes
Name  Type  Use  Default  Fixed  Annotation
xScale  xs:double  optional  1    
documentation
Scaling factor for dx
yScale  xs:double  optional  1    
documentation
Scaling factor for dy
xSuffixCaption  xs:string  optional  dX    
documentation
Name suffix for dx in the noise model exchange items
ySuffixCaption  xs:string  optional  dY    
documentation
Name suffix for dy in the noise model exchange items
xCaption  xs:string  optional      
documentation
Name for dx in the noise model exchange items
yCaption  xs:string  optional      
documentation
Name for dy in the noise model exchange items

attribute CartesianToPolarXML/@xScale
annotation
documentation
Scaling factor for dx

attribute CartesianToPolarXML/@yScale
annotation
documentation
Scaling factor for dy

attribute CartesianToPolarXML/@xSuffixCaption
annotation
documentation
Name suffix for dx in the noise model exchange items

attribute CartesianToPolarXML/@ySuffixCaption
annotation
documentation
Name suffix for dy in the noise model exchange items

attribute CartesianToPolarXML/@xCaption
annotation
documentation
Name for dx in the noise model exchange items

attribute CartesianToPolarXML/@yCaption
annotation
documentation
Name for dy in the noise model exchange items

element CartesianToPolarXML/stdDev
diagram openDA_diagrams/openDA_p134.png
attributes
Name  Type  Use  Default  Fixed  Annotation
value  xs:double  required      
documentation
The standard deviation value
initial  xs:double  optional  0    
documentation
Set the initial value of this parameter (optional)
transformation  openda:ParameterTransformationTypesXML  optional  identity    
documentation
Transformation of correction factor. 'identity' means that the correction will be added directly  without any transformation to the adjusted parameter. 'ln' means that the correction is transformed logarithmically before it is added to the parameter; this gives a correction, which is a fraction of the parameter value. 'set' will set the correction directly as the parameter value
annotation
documentation
Specify standard deviation for dx and dy                                                                             Set the standard deviation of this parameter and the method how the parameter should be corrected

element CartesianToPolarXML/vector
diagram openDA_diagrams/openDA_p135.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the vector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig
annotation
documentation
Select whole parameter vector

element CartesianToPolarXML/subVector
diagram openDA_diagrams/openDA_p136.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the subVector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig
annotation
documentation
Select only a part of the parameter vector

complexType RegularisationConstantXML
diagram openDA_diagrams/openDA_p137.png
attributes
Name  Type  Use  Default  Fixed  Annotation
scale  xs:double  optional  1    
documentation
Set the scaling factor for this parameter (optional)
id  xs:string  optional      
documentation
Optional id for composed items that are all modified by the same parameter.
If omitted, the id's of the separate item will be concatenated. Note: the (concatenated) id is mainly used by the sparse dud algorithm

attribute RegularisationConstantXML/@scale
annotation
documentation
Set the scaling factor for this parameter (optional)

attribute RegularisationConstantXML/@id
annotation
documentation
Optional id for composed items that are all modified by the same parameter.
If omitted, the id's of the separate item will be concatenated. Note: the (concatenated) id is mainly used by the sparse dud algorithm

element RegularisationConstantXML/stdDev
diagram openDA_diagrams/openDA_p138.png
attributes
Name  Type  Use  Default  Fixed  Annotation
value  xs:double  required      
documentation
The standard deviation value
initial  xs:double  optional  0    
documentation
Set the initial value of this parameter (optional)
transformation  openda:ParameterTransformationTypesXML  optional  identity    
documentation
Transformation of correction factor. 'identity' means that the correction will be added directly  without any transformation to the adjusted parameter. 'ln' means that the correction is transformed logarithmically before it is added to the parameter; this gives a correction, which is a fraction of the parameter value. 'set' will set the correction directly as the parameter value
annotation
documentation
Set the standard deviation of this parameter and the method how the parameter should be corrected

element RegularisationConstantXML/uncertainItem
diagram openDA_diagrams/openDA_p139.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  optional      
documentation
Identity of model's exchange item
uncertainItemId  xs:string  optional      
documentation
Identity of noise model's exchange item
transformation  openda:ParameterTransformationTypesXML  optional  identity    
documentation
Transformation of noise variable. 'identity' means that the value will be added directly  without any transformation to the adjusted parameter. 'ln' means that the value is transformed logarithmically before it is added to the parameter; this gives a correction, which is a fraction of the parameter value.
annotation
documentation
The uncertainy of this parameter is specified in the uncertaintyModule mentioned in the top of the present stochastic model configuration

element RegularisationConstantXML/vector
diagram openDA_diagrams/openDA_p140.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the vector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig
annotation
documentation
Select the whole parameter vector

element RegularisationConstantXML/subVector
diagram openDA_diagrams/openDA_p141.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the subVector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig
annotation
documentation
Select only a part of the parameter vector

complexType StandardDeviationAndTransformationXML
diagram openDA_diagrams/openDA_p142.png
attributes
Name  Type  Use  Default  Fixed  Annotation
value  xs:double  required      
documentation
The standard deviation value
initial  xs:double  optional  0    
documentation
Set the initial value of this parameter (optional)
transformation  openda:ParameterTransformationTypesXML  optional  identity    
documentation
Transformation of correction factor. 'identity' means that the correction will be added directly  without any transformation to the adjusted parameter. 'ln' means that the correction is transformed logarithmically before it is added to the parameter; this gives a correction, which is a fraction of the parameter value. 'set' will set the correction directly as the parameter value

attribute StandardDeviationAndTransformationXML/@value
annotation
documentation
The standard deviation value

attribute StandardDeviationAndTransformationXML/@initial
annotation
documentation
Set the initial value of this parameter (optional)

attribute StandardDeviationAndTransformationXML/@transformation
annotation
documentation
Transformation of correction factor. 'identity' means that the correction will be added directly  without any transformation to the adjusted parameter. 'ln' means that the correction is transformed logarithmically before it is added to the parameter; this gives a correction, which is a fraction of the parameter value. 'set' will set the correction directly as the parameter value

complexType StandardDeviationXML
diagram openDA_diagrams/openDA_p143.png
attributes
Name  Type  Use  Default  Fixed  Annotation
value  xs:double  required      
documentation
The standard deviation value

attribute StandardDeviationXML/@value
annotation
documentation
The standard deviation value

complexType StateNoiseAr1ModelXML
diagram openDA_diagrams/openDA_p144.png
attributes
Name  Type  Use  Default  Fixed  Annotation
operation  openda:NoiseOperationTypesXML  optional  add    
documentation
Operation type: add (default) or multiply

attribute StateNoiseAr1ModelXML/@operation
annotation
documentation
Operation type: add (default) or multiply

element StateNoiseAr1ModelXML/stdDevColouredNoised
diagram openDA_diagrams/openDA_p145.png
attributes
Name  Type  Use  Default  Fixed  Annotation
value  xs:double  required      
documentation
The standard deviation value
annotation
documentation
The standard deviation of the coloured noise to be generated by the model.

element StateNoiseAr1ModelXML/decorrelationTimeScale
diagram openDA_diagrams/openDA_p146.png
annotation
documentation
Decorrelation time.

element StateNoiseAr1ModelXML/noiseModelPeriod
diagram openDA_diagrams/openDA_p147.png

complexType StateNoiseArmaModelXML
diagram openDA_diagrams/openDA_p148.png
attributes
Name  Type  Use  Default  Fixed  Annotation
operation  openda:NoiseOperationTypesXML  optional  add    
documentation
Operation type: add (default) or multiply

attribute StateNoiseArmaModelXML/@operation
annotation
documentation
Operation type: add (default) or multiply

element StateNoiseArmaModelXML/stdDev
diagram openDA_diagrams/openDA_p149.png
attributes
Name  Type  Use  Default  Fixed  Annotation
value  xs:double  required      
documentation
The standard deviation value

element StateNoiseArmaModelXML/armaConstant
diagram openDA_diagrams/openDA_p150.png
annotation
documentation
ARMA constants, which reflects temporal correlation per timestep of the ARMA model.

complexType StateNoiseUncertainItemWithArmaConstantsXML
diagram openDA_diagrams/openDA_p151.png
attributes
Name  Type  Use  Default  Fixed  Annotation
uncertainItemId  xs:string  optional      
documentation
Identity of the uncertain item as defined in BB model configuration file.
operation  openda:NoiseOperationTypesXML  optional  add    
documentation
Operation type: add (default), multiply or set

attribute StateNoiseUncertainItemWithArmaConstantsXML/@uncertainItemId
annotation
documentation
Identity of the uncertain item as defined in BB model configuration file.

attribute StateNoiseUncertainItemWithArmaConstantsXML/@operation
annotation
documentation
Operation type: add (default), multiply or set

element StateNoiseUncertainItemWithArmaConstantsXML/armaConstant
diagram openDA_diagrams/openDA_p152.png
annotation
documentation
ARMA constants, which reflects temporal correlation per timestep of the ARMA model.

complexType StateNoiseUncertainItemXML
diagram openDA_diagrams/openDA_p153.png
attributes
Name  Type  Use  Default  Fixed  Annotation
uncertainItemId  xs:string  optional      
documentation
Identity of the uncertain item as defined in BB model configuration file.
operation  openda:NoiseOperationTypesXML  optional  add    
documentation
Operation type: add (default), multiply or set

attribute StateNoiseUncertainItemXML/@uncertainItemId
annotation
documentation
Identity of the uncertain item as defined in BB model configuration file.

attribute StateNoiseUncertainItemXML/@operation
annotation
documentation
Operation type: add (default), multiply or set

complexType StateNoiseXML
diagram openDA_diagrams/openDA_p154.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  optional      
documentation
Specify the identity of the noise model vector. It is required if the noise model contains more than one source vectors. If the noise model contains one subvector, it may be omitted. In that case the source (sub-)vector's id is used.
className  xs:string  optional      
documentation
The class that implements the noise model
workingDirectory  xs:string  optional      
documentation
The working directory where the noise model is started

attribute StateNoiseXML/@id
annotation
documentation
Specify the identity of the noise model vector. It is required if the noise model contains more than one source vectors. If the noise model contains one subvector, it may be omitted. In that case the source (sub-)vector's id is used.

attribute StateNoiseXML/@className
annotation
documentation
The class that implements the noise model

attribute StateNoiseXML/@workingDirectory
annotation
documentation
The working directory where the noise model is started

element StateNoiseXML/configFile
diagram openDA_diagrams/openDA_p155.png
annotation
documentation
Specify name of xml file containing configuration of the noise model. File format depends on class.

element StateNoiseXML/exchangeItems
diagram openDA_diagrams/openDA_p156.png
annotation
documentation
The relations between the noise model's  exchange items and the model's exchange items

element StateNoiseXML/vector
diagram openDA_diagrams/openDA_p157.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the vector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig
annotation
documentation
The model's vector that the noise will be added to.

element StateNoiseXML/subVector
diagram openDA_diagrams/openDA_p158.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the subVector
sourceVectorId  xs:string  optional      
documentation
Identity of the source vector as defined in blackBoxModelConfig
annotation
documentation
The model's vector that the noise will be added to.

element StateNoiseXML/uncertainItem
diagram openDA_diagrams/openDA_p159.png
attributes
Name  Type  Use  Default  Fixed  Annotation
uncertainItemId  xs:string  optional      
documentation
Identity of the uncertain item as defined in BB model configuration file.
operation  openda:NoiseOperationTypesXML  optional  add    
documentation
Operation type: add (default), multiply or set
annotation
documentation
The noise model is fully specified in the uncertainty module

element StateNoiseXML/uncertainItemWithArmaConstants
diagram openDA_diagrams/openDA_p160.png
attributes
Name  Type  Use  Default  Fixed  Annotation
uncertainItemId  xs:string  optional      
documentation
Identity of the uncertain item as defined in BB model configuration file.
operation  openda:NoiseOperationTypesXML  optional  add    
documentation
Operation type: add (default), multiply or set
annotation
documentation
The PDF of the noise model is specified in the uncertainty module, the ARMA constants are specified here

element StateNoiseXML/armaModel
diagram openDA_diagrams/openDA_p161.png
attributes
Name  Type  Use  Default  Fixed  Annotation
operation  openda:NoiseOperationTypesXML  optional  add    
documentation
Operation type: add (default) or multiply
annotation
documentation
Both the noise model's PDF (normal distribution) and the ARMA constants are specified here

element StateNoiseXML/ar1Model
diagram openDA_diagrams/openDA_p162.png
attributes
Name  Type  Use  Default  Fixed  Annotation
operation  openda:NoiseOperationTypesXML  optional  add    
documentation
Operation type: add (default) or multiply
annotation
documentation
The standard deviation and the decoralation time scale of the AR1 model is specified

complexType UncertaintyOrModelExchangeItemXML
diagram openDA_diagrams/openDA_p163.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Set the identity of this subVector.
sourceVectorId  xs:string  optional      
documentation
Specify the identity of the source vector as defined in blackBoxModelConfig.

attribute UncertaintyOrModelExchangeItemXML/@id
annotation
documentation
Set the identity of this subVector.

attribute UncertaintyOrModelExchangeItemXML/@sourceVectorId
annotation
documentation
Specify the identity of the source vector as defined in blackBoxModelConfig.

element UncertaintyOrModelExchangeItemXML/selection
diagram openDA_diagrams/openDA_p164.png
attributes
Name  Type  Use  Default  Fixed  Annotation
index1  openda:indexStringType  required      
documentation
Indices of the selected array elements of the first dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index2  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the second dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index3  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the third dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
base  xs:int  optional  0    
documentation
Base number, which gives the index of the vector's first element (sometimes 1 instead of 0)
annotation
documentation
Derive subvector by specifying indices of source vector.

element UncertaintyOrModelExchangeItemXML/selector
diagram openDA_diagrams/openDA_p165.png
attributes
Name  Type  Use  Default  Fixed  Annotation
className  xs:string  required      
documentation
Specify the openda:class name for performing this operation
annotation
documentation
Derive subvector by using a configuration file or string.

complexType UncertaintyOrNoiseExchangeItemsXML
diagram openDA_diagrams/openDA_p166.png

element UncertaintyOrNoiseExchangeItemsXML/exchangeItem
diagram openDA_diagrams/openDA_p167.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of this noise model's exchange item
modelExchangeItemId  xs:string  optional      
documentation
Identity of model's exchange item on which to impose this noise model's exchange item
operation  openda:NoiseOperationTypesXML  optional  add    
documentation
Deprecated, use attribute "transformation" instead. Type of operation to performed when noise is added to an (parameter or state) exchange item: 'add' the noise to the exchange item's values, 'multiply' the exchange item's values with the noise, or 'set' the values (used in those cases where the noise in fact is a realization).
transformation  openda:ParameterTransformationTypesXML  optional  identity    
documentation
Transformation of noise variable. 'identity' means that the value will be added directly  without any transformation to the adjusted parameter. 'ln' means that the value is transformed logarithmically before it is added to the parameter; this gives a correction, which is a fraction of the parameter value.
skipFirstTimeStep  xs:boolean  optional  false    
documentation
When adding noise to a time dependent exchange item for the next (e.g. EnKF) time slice, skip the first time step (because is was already modified in the previous time slice)
addOnlyNoiseDifference  xs:boolean  optional  false    
documentation
When adding noise to a state exchange time, add the difference between the current noise and the previous noise, instead of adding the full noise.
annotation
documentation
The list of relations

complexType UncertaintyOrNoiseExchangeItemXML
diagram openDA_diagrams/openDA_p168.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of this noise model's exchange item
modelExchangeItemId  xs:string  optional      
documentation
Identity of model's exchange item on which to impose this noise model's exchange item
operation  openda:NoiseOperationTypesXML  optional  add    
documentation
Deprecated, use attribute "transformation" instead. Type of operation to performed when noise is added to an (parameter or state) exchange item: 'add' the noise to the exchange item's values, 'multiply' the exchange item's values with the noise, or 'set' the values (used in those cases where the noise in fact is a realization).
transformation  openda:ParameterTransformationTypesXML  optional  identity    
documentation
Transformation of noise variable. 'identity' means that the value will be added directly  without any transformation to the adjusted parameter. 'ln' means that the value is transformed logarithmically before it is added to the parameter; this gives a correction, which is a fraction of the parameter value.
skipFirstTimeStep  xs:boolean  optional  false    
documentation
When adding noise to a time dependent exchange item for the next (e.g. EnKF) time slice, skip the first time step (because is was already modified in the previous time slice)
addOnlyNoiseDifference  xs:boolean  optional  false    
documentation
When adding noise to a state exchange time, add the difference between the current noise and the previous noise, instead of adding the full noise.

attribute UncertaintyOrNoiseExchangeItemXML/@id
annotation
documentation
Identity of this noise model's exchange item

attribute UncertaintyOrNoiseExchangeItemXML/@modelExchangeItemId
annotation
documentation
Identity of model's exchange item on which to impose this noise model's exchange item

attribute UncertaintyOrNoiseExchangeItemXML/@operation
annotation
documentation
Deprecated, use attribute "transformation" instead. Type of operation to performed when noise is added to an (parameter or state) exchange item: 'add' the noise to the exchange item's values, 'multiply' the exchange item's values with the noise, or 'set' the values (used in those cases where the noise in fact is a realization).

attribute UncertaintyOrNoiseExchangeItemXML/@transformation
annotation
documentation
Transformation of noise variable. 'identity' means that the value will be added directly  without any transformation to the adjusted parameter. 'ln' means that the value is transformed logarithmically before it is added to the parameter; this gives a correction, which is a fraction of the parameter value.

attribute UncertaintyOrNoiseExchangeItemXML/@skipFirstTimeStep
annotation
documentation
When adding noise to a time dependent exchange item for the next (e.g. EnKF) time slice, skip the first time step (because is was already modified in the previous time slice)

attribute UncertaintyOrNoiseExchangeItemXML/@addOnlyNoiseDifference
annotation
documentation
When adding noise to a state exchange time, add the difference between the current noise and the previous noise, instead of adding the full noise.

element UncertaintyOrNoiseExchangeItemXML/modelExchangeItem
diagram openDA_diagrams/openDA_p169.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of model's exchange item
annotation
documentation
Specify one or more model exchange items on which to impose noise defined by this noise model's exchange item (for a single model ExchangeItem, use modelExchangeItemId in the attributes instead of this list)

complexType UncertaintyOrNoiseModelExchangeItemXML
diagram openDA_diagrams/openDA_p170.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of model's exchange item

attribute UncertaintyOrNoiseModelExchangeItemXML/@id
annotation
documentation
Identity of model's exchange item

complexType UncertaintyOrNoiseXML
diagram openDA_diagrams/openDA_p171.png
attributes
Name  Type  Use  Default  Fixed  Annotation
className  xs:string        
documentation
The class name implementing the noise model
workingDirectory  xs:string  optional      
documentation
The noise model's working directory

attribute UncertaintyOrNoiseXML/@className
annotation
documentation
The class name implementing the noise model

attribute UncertaintyOrNoiseXML/@workingDirectory
annotation
documentation
The noise model's working directory

element UncertaintyOrNoiseXML/configFile
diagram openDA_diagrams/openDA_p172.png
annotation
documentation
Specify name of xml file containing configuration of the noise model. File format depends on class.

element UncertaintyOrNoiseXML/arg
diagram openDA_diagrams/openDA_p173.png
annotation
documentation
Specify list of input arguments for the noise model

element UncertaintyOrNoiseXML/exchangeItems
diagram openDA_diagrams/openDA_p174.png
annotation
documentation
The relations between the noise model's  exchange items and the model's exchange items

simpleType NoiseOperationTypesXML
annotation
documentation
Type of operation to performed when noise is added to an (parameter or state) exchange item: add the noise to the exchange item's values, multiply the exchange item's values with the noise, or set the values (used in those cases where the noise in fact is a realization)

simpleType ParameterTransformationTypesXML
annotation
documentation
Tranformation of correction factor. Two values are possible: 'identity' and 'ln'. The 'identity' means that the correction will be added directly  without any transformation to the adjusted parameter. On the other hand,  'ln' means that correction is transformed logarithmically before it is added to the parameter; this gives a correction, which is a fraction of the parameter value.

element blackBoxTemplateConfig
diagram openDA_diagrams/openDA_p175.png
annotation
documentation
Configuration of a black box template object. It contains of three main components: key definitions, file definitions, and valueFile definition.

complexType BlackBoxTemplateConfigXML
diagram openDA_diagrams/openDA_p176.png

element BlackBoxTemplateConfigXML/keyDefinitions
diagram openDA_diagrams/openDA_p177.png
attributes
Name  Type  Use  Default  Fixed  Annotation
defaultKeyPrefix  xs:string  optional      
documentation
Specify the default prefix for the alias keys.
defaultKeySuffix  xs:string  optional      
documentation
Specify the default suffix for the alias keys.
annotation
documentation
Define keys which need to be substituted by valiues in the template files. Specify the prefix and suffix for the keys.

element BlackBoxTemplateConfigXML/files
diagram openDA_diagrams/openDA_p178.png
annotation
documentation
Specify the files with template definitions.

element BlackBoxTemplateConfigXML/valuesFile
diagram openDA_diagrams/openDA_p179.png
annotation
documentation
Specify the file containing the KEY and VALUE pairs.

complexType BlackBoxTemplateFilesXML
diagram openDA_diagrams/openDA_p180.png

element BlackBoxTemplateFilesXML/file
diagram openDA_diagrams/openDA_p181.png
attributes
Name  Type  Use  Default  Fixed  Annotation
templateFile  xs:string  required      
documentation
Name of the template file.
targetFile  xs:string  required      
documentation
Name of the target file.
annotation
documentation
Specify the file definitions where KEY strings need to be replaced by values. Specify template file and target file.

complexType TemplateFileKeysXML
diagram openDA_diagrams/openDA_p182.png

element TemplateFileKeysXML/keyId
diagram openDA_diagrams/openDA_p183.png
annotation
documentation
Specify the id of the key defined in the keyDefinitions section.

complexType TemplateFileXML
diagram openDA_diagrams/openDA_p184.png
attributes
Name  Type  Use  Default  Fixed  Annotation
templateFile  xs:string  required      
documentation
Name of the template file.
targetFile  xs:string  required      
documentation
Name of the target file.

attribute TemplateFileXML/@templateFile
annotation
documentation
Name of the template file.

attribute TemplateFileXML/@targetFile
annotation
documentation
Name of the target file.

element TemplateFileXML/keys
diagram openDA_diagrams/openDA_p185.png
annotation
documentation
Specify list of keys to be replaced in the templateFile.

complexType TemplateKeyDefinitionsXML
diagram openDA_diagrams/openDA_p186.png
attributes
Name  Type  Use  Default  Fixed  Annotation
defaultKeyPrefix  xs:string  optional      
documentation
Specify the default prefix for the alias keys.
defaultKeySuffix  xs:string  optional      
documentation
Specify the default suffix for the alias keys.

attribute TemplateKeyDefinitionsXML/@defaultKeyPrefix
annotation
documentation
Specify the default prefix for the alias keys.

attribute TemplateKeyDefinitionsXML/@defaultKeySuffix
annotation
documentation
Specify the default suffix for the alias keys.

element TemplateKeyDefinitionsXML/key
diagram openDA_diagrams/openDA_p187.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
The id to be referred to by the alias.
name  xs:string  required      
documentation
The name to be associated with the aliased key.
targetType  xs:string  optional  org.openda.blackbox.config.KeyTypeString    
documentation
The data type to which the alias key will be replaced (default String).
keyPrefix  xs:string  optional      
documentation
Specify the prefix for the alias key.
keySuffix  xs:string  optional      
documentation
Specify the suffix for the alias key.
annotation
documentation
Create list of keys, stating their id, name and targetType. The id is to be used in the file definition section. The name is the "KEY" - string to be placed in the template file.

complexType TemplateKeyDefinitionXML
diagram openDA_diagrams/openDA_p188.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
The id to be referred to by the alias.
name  xs:string  required      
documentation
The name to be associated with the aliased key.
targetType  xs:string  optional  org.openda.blackbox.config.KeyTypeString    
documentation
The data type to which the alias key will be replaced (default String).
keyPrefix  xs:string  optional      
documentation
Specify the prefix for the alias key.
keySuffix  xs:string  optional      
documentation
Specify the suffix for the alias key.

attribute TemplateKeyDefinitionXML/@id
annotation
documentation
The id to be referred to by the alias.

attribute TemplateKeyDefinitionXML/@name
annotation
documentation
The name to be associated with the aliased key.

attribute TemplateKeyDefinitionXML/@targetType
annotation
documentation
The data type to which the alias key will be replaced (default String).

attribute TemplateKeyDefinitionXML/@keyPrefix
annotation
documentation
Specify the prefix for the alias key.

attribute TemplateKeyDefinitionXML/@keySuffix
annotation
documentation
Specify the suffix for the alias key.

simpleType BlackBoxTemplateKeyTypesXML

element rangeValidationConfig
diagram openDA_diagrams/openDA_p189.png
annotation
documentation
Contains one or more constraints that constrain the values of certain exchange items.

complexType RangeValidationConfigXML
diagram openDA_diagrams/openDA_p190.png

element RangeValidationConfigXML/constraint
diagram openDA_diagrams/openDA_p191.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Id of this constraint. This is only used to refer to this constraint in log messages.
annotation
documentation
One or more constraints that constrain the values of certain exchange items. If a constraint is applied on a given sourceExchangeItem, then a new targetExchangeIitem is created with the specified constraint and an id that is the sourceExchangeItemId with the configured suffix appended. To use the targetExchangeItem in other parts of the configuration refer to it using its own id. It is also possible to apply multiple constraints on a given exchangeItem recursively. This can be done by configuring a constraint that works on a targetExchangeItem from another constraint. If multiple constraints are applied to a given exchangeItem recursively, then the outermost constraint is applied first.

complexType RangeValidationConstantLimitsConstraintXML
diagram openDA_diagrams/openDA_p192.png

element RangeValidationConstantLimitsConstraintXML/targetExchangeItemIdSuffix
diagram openDA_diagrams/openDA_p193.png
annotation
documentation
Each sourceExchangeItem is wrapped in a new targetExchangeItem. The targetExchangeItemId is the sourceExchangeItemId with the configured suffix appended. Use that id to refer to this targetExchangeItem in other parts of the configuration.

element RangeValidationConstantLimitsConstraintXML/sourceExchangeItemId
diagram openDA_diagrams/openDA_p194.png
annotation
documentation
One or more ids of exchange items to which this constraint should be applied. This can e.g. be a modelExchangeItem or a targetExchangeItem from another constraint.

element RangeValidationConstantLimitsConstraintXML/lowerLimit
diagram openDA_diagrams/openDA_p195.png
annotation
documentation
Optional. If the value of a model exchange item is below the lower limit, then the value is changed to the lower limit.

element RangeValidationConstantLimitsConstraintXML/upperLimit
diagram openDA_diagrams/openDA_p196.png
annotation
documentation
Optional. If the value of a model exchange item is above the upper limit, then the value is changed to the upper limit.

complexType RangeValidationConstraintXML
diagram openDA_diagrams/openDA_p197.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Id of this constraint. This is only used to refer to this constraint in log messages.

attribute RangeValidationConstraintXML/@id
annotation
documentation
Id of this constraint. This is only used to refer to this constraint in log messages.

element RangeValidationConstraintXML/constantLimits
diagram openDA_diagrams/openDA_p198.png
annotation
documentation
Constraint that limits the range of the specified exchange item using the specified lower and/or upper limit. If the value of the exchange item is below the lower limit, then the value is changed to the lower limit. If the value of a model exchange item is above the upper limit, then the value is changed to the upper limit. If an exchange item has more than one value (e.g. a 2D grid), then the specified limits are applied to all values in the exchange item.

element resultSelection
diagram openDA_diagrams/openDA_p199.png

complexType ResultItemXML
diagram openDA_diagrams/openDA_p200.png
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 openDA_diagrams/openDA_p201.png
annotation
documentation
Type of message ("step", "inner", "outer", or "evaluation"). Deprecated function, will not be supported in future versions of OpenDA.

complexType ResultLoggingXML
diagram openDA_diagrams/openDA_p202.png
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 openDA_diagrams/openDA_p203.png

element ResultSelectionXML/doLog
diagram openDA_diagrams/openDA_p204.png
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 openDA_diagrams/openDA_p205.png
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

element treeVectorFile
diagram openDA_diagrams/openDA_p206.png
annotation
documentation
Costa / DATools Tree Vector File

complexType ComputationalDimensionXML
diagram openDA_diagrams/openDA_p207.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
length  xs:int  required      

attribute ComputationalDimensionXML/@id

attribute ComputationalDimensionXML/@length

complexType ComputationalSpaceXML
diagram openDA_diagrams/openDA_p208.png

element ComputationalSpaceXML/dimension
diagram openDA_diagrams/openDA_p209.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
length  xs:int  required      

complexType DateTimeXML
diagram openDA_diagrams/openDA_p210.png
attributes
Name  Type  Use  Default  Fixed  Annotation
date  openda:DateXML  required      
documentation
ISO 8601 (yyyy-mm-dd)
time  openda:TimeXML  required      
documentation
ISO 8601 (hh:mm:ss[.msec])
timeZone  openda:TimeZoneXML  optional      

attribute DateTimeXML/@date
annotation
documentation
ISO 8601 (yyyy-mm-dd)

attribute DateTimeXML/@time
annotation
documentation
ISO 8601 (hh:mm:ss[.msec])

attribute DateTimeXML/@timeZone

complexType DimensionsXML
diagram openDA_diagrams/openDA_p211.png
attributes
Name  Type  Use  Default  Fixed  Annotation
dimSize1  xs:string  required      
dimSize2  xs:string  optional      
dimSize3  xs:string  optional      

attribute DimensionsXML/@dimSize1

attribute DimensionsXML/@dimSize2

attribute DimensionsXML/@dimSize3

complexType GridXML
diagram openDA_diagrams/openDA_p212.png

element GridXML/computationalSpace
diagram openDA_diagrams/openDA_p213.png

element GridXML/physicalSpace
diagram openDA_diagrams/openDA_p214.png

complexType MetaInfoXML
diagram openDA_diagrams/openDA_p215.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        

attribute MetaInfoXML/@id

complexType PhysicalDimensionXML
diagram openDA_diagrams/openDA_p216.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
axes  xs:string  required      
ref  xs:string  required      

attribute PhysicalDimensionXML/@id

attribute PhysicalDimensionXML/@axes

attribute PhysicalDimensionXML/@ref

complexType PhysicalSpaceXML
diagram openDA_diagrams/openDA_p217.png

element PhysicalSpaceXML/dimension
diagram openDA_diagrams/openDA_p218.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
axes  xs:string  required      
ref  xs:string  required      

complexType TreeVectorFileXML
diagram openDA_diagrams/openDA_p219.png

element TreeVectorFileXML/timeStamp
diagram openDA_diagrams/openDA_p220.png
attributes
Name  Type  Use  Default  Fixed  Annotation
date  openda:DateXML  required      
documentation
ISO 8601 (yyyy-mm-dd)
time  openda:TimeXML  required      
documentation
ISO 8601 (hh:mm:ss[.msec])
timeZone  openda:TimeZoneXML  optional      

element TreeVectorFileXML/treeVector
diagram openDA_diagrams/openDA_p221.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
caption  xs:string        
excludeFromVector  xs:boolean  optional      
className  xs:string        

complexType TreeVectorLeafXML
diagram openDA_diagrams/openDA_p222.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
caption  xs:string        
excludeFromVector  xs:boolean  optional      
className  xs:string        

attribute TreeVectorLeafXML/@id

attribute TreeVectorLeafXML/@caption

attribute TreeVectorLeafXML/@excludeFromVector

attribute TreeVectorLeafXML/@className

element TreeVectorLeafXML/unit
diagram openDA_diagrams/openDA_p223.png

element TreeVectorLeafXML/missingValue
diagram openDA_diagrams/openDA_p224.png

element TreeVectorLeafXML/dimensions
diagram openDA_diagrams/openDA_p225.png
attributes
Name  Type  Use  Default  Fixed  Annotation
dimSize1  xs:string  required      
dimSize2  xs:string  optional      
dimSize3  xs:string  optional      

element TreeVectorLeafXML/grid
diagram openDA_diagrams/openDA_p226.png

element TreeVectorLeafXML/vector
diagram openDA_diagrams/openDA_p227.png

complexType TreeVectorXML
diagram openDA_diagrams/openDA_p228.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
caption  xs:string        
excludeFromVector  xs:boolean  optional      
className  xs:string        

attribute TreeVectorXML/@id

attribute TreeVectorXML/@caption

attribute TreeVectorXML/@excludeFromVector

attribute TreeVectorXML/@className

element TreeVectorXML/description
diagram openDA_diagrams/openDA_p229.png

element TreeVectorXML/treeVectorLeaf
diagram openDA_diagrams/openDA_p230.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
caption  xs:string        
excludeFromVector  xs:boolean  optional      
className  xs:string        

element TreeVectorXML/subTreeVector
diagram openDA_diagrams/openDA_p231.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
caption  xs:string        
excludeFromVector  xs:boolean  optional      
className  xs:string        

simpleType DateXML

simpleType TimeXML

simpleType TimeZoneXML

simpleType VectorXML

element blackBoxModelConfig
diagram openDA_diagrams/openDA_p232.png
annotation
documentation
Configuration for a black box model. Here the reference to a specific model configuration is made.

complexType AliasValuesXML
diagram openDA_diagrams/openDA_p233.png

element AliasValuesXML/alias
diagram openDA_diagrams/openDA_p234.png
attributes
Name  Type  Use  Default  Fixed  Annotation
key  xs:string  required      
documentation
The alias key name as defined in the black box wrapper configuration
value  xs:string        
documentation
The actual value referred to by the alias key
annotation
documentation
Specify the alias keys and (optionally) the corresponding actual values

complexType AliasValueXML
diagram openDA_diagrams/openDA_p235.png
attributes
Name  Type  Use  Default  Fixed  Annotation
key  xs:string  required      
documentation
The alias key name as defined in the black box wrapper configuration
value  xs:string        
documentation
The actual value referred to by the alias key

attribute AliasValueXML/@key
annotation
documentation
The alias key name as defined in the black box wrapper configuration

attribute AliasValueXML/@value
annotation
documentation
The actual value referred to by the alias key

element AliasValueXML/listValue
diagram openDA_diagrams/openDA_p236.png
annotation
documentation
This type of alias can only be used for BBAction arguments, where the argument must be specified by means of only naming the 'list value' alias. If the listValue element is present, it overrules the value attribute, indicating that the actual value is in fact a list of string arguments instead of one argument.

complexType BlackBoxConfigurableXML
diagram openDA_diagrams/openDA_p237.png
attributes
Name  Type  Use  Default  Fixed  Annotation
className  xs:string  required      
documentation
Specify the openda:class name for performing this operation

attribute BlackBoxConfigurableXML/@className
annotation
documentation
Specify the openda:class name for performing this operation

element BlackBoxConfigurableXML/configFile
diagram openDA_diagrams/openDA_p238.png
annotation
documentation
Specify the configuration filename

element BlackBoxConfigurableXML/configString
diagram openDA_diagrams/openDA_p239.png
annotation
documentation
Specify the configuration string

element BlackBoxConfigurableXML/arg
diagram openDA_diagrams/openDA_p240.png
annotation
documentation
Specify the input argument of this openda:class

complexType BlackBoxIoSubVectorXML
diagram openDA_diagrams/openDA_p241.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the exchange item vector to be used in the stochastic model configuration
ioObjectId  xs:string  required      
documentation
The corresponding object identity of the exchange item
elementId  xs:string  required      
documentation
The corresponding identity of the exchange item as used internally within the model
role  openda:BlackBoxModelRoleTypesXML  optional  InOut    
documentation
The corresponding role type of the exchange item, choose "Input", "Output" or "InOut"

attribute BlackBoxIoSubVectorXML/@id
annotation
documentation
Identity of the exchange item vector to be used in the stochastic model configuration

attribute BlackBoxIoSubVectorXML/@ioObjectId
annotation
documentation
The corresponding object identity of the exchange item

attribute BlackBoxIoSubVectorXML/@elementId
annotation
documentation
The corresponding identity of the exchange item as used internally within the model

attribute BlackBoxIoSubVectorXML/@role
annotation
documentation
The corresponding role type of the exchange item, choose "Input", "Output" or "InOut"

element BlackBoxIoSubVectorXML/selection
diagram openDA_diagrams/openDA_p242.png
attributes
Name  Type  Use  Default  Fixed  Annotation
index1  openda:indexStringType  required      
documentation
Indices of the selected array elements of the first dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index2  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the second dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index3  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the third dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
base  xs:int  optional  0    
documentation
Base number, which gives the index of the vector's first element (sometimes 1 instead of 0)
annotation
documentation
Select subvector using indices of the vector elements

element BlackBoxIoSubVectorXML/selector
diagram openDA_diagrams/openDA_p243.png
attributes
Name  Type  Use  Default  Fixed  Annotation
className  xs:string  required      
documentation
Specify the openda:class name for performing this operation
annotation
documentation
Define operator for deriving the subvector

complexType BlackBoxIoVectorXML
diagram openDA_diagrams/openDA_p244.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the exchange item vector to be used in the stochastic model configuration. Note: by using the reserved id "allElementsFromIoObject" all the elements in the data/io object are exposed as exchange items (with the element id in the data/io object as id)
ioObjectId  xs:string  required      
documentation
The corresponding object identity of the exchange item
elementId  xs:string  optional      
documentation
The corresponding identity of the exchange item as used internally within the model. If this is not specified, then the elementId will be equal to the specified id.
role  openda:BlackBoxModelRoleTypesXML  optional  InOut    
documentation
The corresponding role type of the exchange item, choose "Input", "Output" or "InOut"
idSuffix  xs:string        
documentation
Optional. This suffix will be appended to the specified id. If elementId not specified, then the elementId will still be equal to the specified id without this suffix. If id="allElementsFromIoObject", then this suffix will be appended to the ids of all exchangeItems of elements in the ioObject. In that case the elementIds will still be equal to the original ids of the elements in the ioObject, i.e. without this suffix.

attribute BlackBoxIoVectorXML/@id
annotation
documentation
Identity of the exchange item vector to be used in the stochastic model configuration. Note: by using the reserved id "allElementsFromIoObject" all the elements in the data/io object are exposed as exchange items (with the element id in the data/io object as id)

attribute BlackBoxIoVectorXML/@ioObjectId
annotation
documentation
The corresponding object identity of the exchange item

attribute BlackBoxIoVectorXML/@elementId
annotation
documentation
The corresponding identity of the exchange item as used internally within the model. If this is not specified, then the elementId will be equal to the specified id.

attribute BlackBoxIoVectorXML/@role
annotation
documentation
The corresponding role type of the exchange item, choose "Input", "Output" or "InOut"

attribute BlackBoxIoVectorXML/@idSuffix
annotation
documentation
Optional. This suffix will be appended to the specified id. If elementId not specified, then the elementId will still be equal to the specified id without this suffix. If id="allElementsFromIoObject", then this suffix will be appended to the ids of all exchangeItems of elements in the ioObject. In that case the elementIds will still be equal to the original ids of the elements in the ioObject, i.e. without this suffix.

complexType BlackBoxModelConfigXML
diagram openDA_diagrams/openDA_p245.png

element BlackBoxModelConfigXML/wrapperConfig
diagram openDA_diagrams/openDA_p246.png
annotation
documentation
Specify black box wrapper configuration that addresses the deterministic model

element BlackBoxModelConfigXML/aliasValues
diagram openDA_diagrams/openDA_p247.png
annotation
documentation
Specify the actual values referred to by the alias keys defined in the black box wrapper configuration

element BlackBoxModelConfigXML/timeInfo
diagram openDA_diagrams/openDA_p248.png
attributes
Name  Type  Use  Default  Fixed  Annotation
start  xs:dateTime  optional      
documentation
Specify the start time of the simulation (yyyy-mm-ddThh:mm:ss)
end  xs:dateTime  optional      
documentation
Specify the end time of the simulation (yyyy-mm-ddThh:mm:ss)
timeStepInSeconds  xs:double  optional      
documentation
Specify the time step of the simulation in seconds
annotation
documentation
Specify the time information of the simulation (optional)

element BlackBoxModelConfigXML/timeInfoExchangeItems
diagram openDA_diagrams/openDA_p249.png
attributes
Name  Type  Use  Default  Fixed  Annotation
start  xs:string  optional      
documentation
The identifier of the exchange item that contains the start time of the simulation
end  xs:string  optional      
documentation
The identifier of the exchange item that contains the end time of the simulation
timeStep  xs:string  optional      
documentation
The identifier of the exchange item that contains the model time step of the simulation
annotation
documentation
Specify the time information of the simulation in terms of ioObject exchange item id's (optional). Multiple timeInfoExchangeItems can be specified, each one with a unique id. This is needed if there are multiple ioObjects that have exchangeItems for the start and/or end time.

element BlackBoxModelConfigXML/exchangeItems
diagram openDA_diagrams/openDA_p250.png
annotation
documentation
Specify the list of items to exchange between the model and OpenDA components. An exchange item may be defined either as vector or subvector.

element BlackBoxModelConfigXML/doCleanUp
diagram openDA_diagrams/openDA_p251.png
annotation
documentation
Specify whether to remove unnecessary files upon completion of a model run (boolean, optional)

element BlackBoxModelConfigXML/skipModelActionsIfInstanceDirExists
diagram openDA_diagrams/openDA_p252.png
annotation
documentation
If set to true, no actions are executed on a model instance that already exists (boolean, optional)

element BlackBoxModelConfigXML/restartInfo
diagram openDA_diagrams/openDA_p253.png
attributes
Name  Type  Use  Default  Fixed  Annotation
dirPrefix  xs:string  optional  ./savedModelState_    
documentation
Specify the prefix of model directory name that will contain a set of restart files for a certain time stamp
(written when the stoch model level requests to store states, read when the algorithm asks to restore a state)
annotation
documentation
Restart dir./files information.

complexType BlackBoxModelRestartInfoXML
diagram openDA_diagrams/openDA_p254.png
attributes
Name  Type  Use  Default  Fixed  Annotation
dirPrefix  xs:string  optional  ./savedModelState_    
documentation
Specify the prefix of model directory name that will contain a set of restart files for a certain time stamp
(written when the stoch model level requests to store states, read when the algorithm asks to restore a state)

attribute BlackBoxModelRestartInfoXML/@dirPrefix
annotation
documentation
Specify the prefix of model directory name that will contain a set of restart files for a certain time stamp
(written when the stoch model level requests to store states, read when the algorithm asks to restore a state)

element BlackBoxModelRestartInfoXML/modelStateFile
diagram openDA_diagrams/openDA_p255.png
annotation
documentation
Specify the file name(s) containing the model state

complexType BlackBoxWrapperConfigReferenceXML
diagram openDA_diagrams/openDA_p256.png

element BlackBoxWrapperConfigReferenceXML/file
diagram openDA_diagrams/openDA_p257.png
annotation
documentation
Specify the name of the black box wrapper configuration file, relative to local directory. File format: blackBoxWrapperConfig

complexType ExchangeItemXML
diagram openDA_diagrams/openDA_p258.png

element ExchangeItemXML/vector
diagram openDA_diagrams/openDA_p259.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the exchange item vector to be used in the stochastic model configuration. Note: by using the reserved id "allElementsFromIoObject" all the elements in the data/io object are exposed as exchange items (with the element id in the data/io object as id)
ioObjectId  xs:string  required      
documentation
The corresponding object identity of the exchange item
elementId  xs:string  optional      
documentation
The corresponding identity of the exchange item as used internally within the model. If this is not specified, then the elementId will be equal to the specified id.
role  openda:BlackBoxModelRoleTypesXML  optional  InOut    
documentation
The corresponding role type of the exchange item, choose "Input", "Output" or "InOut"
idSuffix  xs:string        
documentation
Optional. This suffix will be appended to the specified id. If elementId not specified, then the elementId will still be equal to the specified id without this suffix. If id="allElementsFromIoObject", then this suffix will be appended to the ids of all exchangeItems of elements in the ioObject. In that case the elementIds will still be equal to the original ids of the elements in the ioObject, i.e. without this suffix.
annotation
documentation
Specify vector of the exchange item

element ExchangeItemXML/subVector
diagram openDA_diagrams/openDA_p260.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation
Identity of the exchange item vector to be used in the stochastic model configuration
ioObjectId  xs:string  required      
documentation
The corresponding object identity of the exchange item
elementId  xs:string  required      
documentation
The corresponding identity of the exchange item as used internally within the model
role  openda:BlackBoxModelRoleTypesXML  optional  InOut    
documentation
The corresponding role type of the exchange item, choose "Input", "Output" or "InOut"
annotation
documentation
Specify subvector of the exchange item

complexType TimeInfoExchangeItemsXML
diagram openDA_diagrams/openDA_p261.png
attributes
Name  Type  Use  Default  Fixed  Annotation
start  xs:string  optional      
documentation
The identifier of the exchange item that contains the start time of the simulation
end  xs:string  optional      
documentation
The identifier of the exchange item that contains the end time of the simulation
timeStep  xs:string  optional      
documentation
The identifier of the exchange item that contains the model time step of the simulation

attribute TimeInfoExchangeItemsXML/@start
annotation
documentation
The identifier of the exchange item that contains the start time of the simulation

attribute TimeInfoExchangeItemsXML/@end
annotation
documentation
The identifier of the exchange item that contains the end time of the simulation

attribute TimeInfoExchangeItemsXML/@timeStep
annotation
documentation
The identifier of the exchange item that contains the model time step of the simulation

complexType TimeInfoXML
diagram openDA_diagrams/openDA_p262.png
attributes
Name  Type  Use  Default  Fixed  Annotation
start  xs:dateTime  optional      
documentation
Specify the start time of the simulation (yyyy-mm-ddThh:mm:ss)
end  xs:dateTime  optional      
documentation
Specify the end time of the simulation (yyyy-mm-ddThh:mm:ss)
timeStepInSeconds  xs:double  optional      
documentation
Specify the time step of the simulation in seconds

attribute TimeInfoXML/@start
annotation
documentation
Specify the start time of the simulation (yyyy-mm-ddThh:mm:ss)

attribute TimeInfoXML/@end
annotation
documentation
Specify the end time of the simulation (yyyy-mm-ddThh:mm:ss)

attribute TimeInfoXML/@timeStepInSeconds
annotation
documentation
Specify the time step of the simulation in seconds

simpleType BlackBoxModelRoleTypesXML

element blackBoxWrapperConfig
diagram openDA_diagrams/openDA_p263.png
annotation
documentation
Configuration of a black box model wrapper. It contains of three main components: alias definitions, model run, and input-output definition.

complexType ActionsXML
diagram openDA_diagrams/openDA_p264.png

element ActionsXML/action
diagram openDA_diagrams/openDA_p265.png
attributes
Name  Type  Use  Default  Fixed  Annotation
exe  xs:string  optional      
documentation
Name and path of the executable file
windowsExe  xs:string  optional      
documentation
Name and path of the executable file for Windows operating system
linuxExe  xs:string  optional      
documentation
Name and path of the executable file for Linux operating system
macExe  xs:string  optional      
documentation
Name and path of the executable file for Mac operating system
className  xs:string  optional      
documentation
The openda:class name.
workingDirectory  xs:string  optional      
documentation
Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig.
actualWorkingDirectory  xs:string  optional      
documentation
Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory.
ignoreStatus  xs:boolean  optional  false    
documentation
Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.
annotation
documentation
Specify the consecutive actions  by model executables or classes to run, arguments to supply and fail/success checks to perform

complexType ActionXML
diagram openDA_diagrams/openDA_p266.png
attributes
Name  Type  Use  Default  Fixed  Annotation
exe  xs:string  optional      
documentation
Name and path of the executable file
windowsExe  xs:string  optional      
documentation
Name and path of the executable file for Windows operating system
linuxExe  xs:string  optional      
documentation
Name and path of the executable file for Linux operating system
macExe  xs:string  optional      
documentation
Name and path of the executable file for Mac operating system
className  xs:string  optional      
documentation
The openda:class name.
workingDirectory  xs:string  optional      
documentation
Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig.
actualWorkingDirectory  xs:string  optional      
documentation
Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory.
ignoreStatus  xs:boolean  optional  false    
documentation
Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.

attribute ActionXML/@exe
annotation
documentation
Name and path of the executable file

attribute ActionXML/@windowsExe
annotation
documentation
Name and path of the executable file for Windows operating system

attribute ActionXML/@linuxExe
annotation
documentation
Name and path of the executable file for Linux operating system

attribute ActionXML/@macExe
annotation
documentation
Name and path of the executable file for Mac operating system

attribute ActionXML/@className
annotation
documentation
The openda:class name.

attribute ActionXML/@workingDirectory
annotation
documentation
Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig.

attribute ActionXML/@actualWorkingDirectory
annotation
documentation
Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory.

attribute ActionXML/@ignoreStatus
annotation
documentation
Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.

element ActionXML/arg
diagram openDA_diagrams/openDA_p267.png
annotation
documentation
Specify list of  input arguments of the model executable

element ActionXML/checkOutput
diagram openDA_diagrams/openDA_p268.png
attributes
Name  Type  Use  Default  Fixed  Annotation
file  xs:string  required      
documentation
Name of output file
expect  xs:string  optional      
documentation
Expected content of the output file when the action is successful
annotation
documentation
Specify list of output files to be checked after the command execution has finished

element ActionXML/checkReturnStatus
diagram openDA_diagrams/openDA_p269.png
attributes
Name  Type  Use  Default  Fixed  Annotation
expect  xs:string  required      
documentation
Expected return value when the action is successful
annotation
documentation
Specify return value after the command execution has finished

complexType AliasDefinitionsXML
diagram openDA_diagrams/openDA_p270.png
attributes
Name  Type  Use  Default  Fixed  Annotation
defaultKeyPrefix  xs:string  optional      
documentation
Specify the default prefix for the alias keys
defaultKeySuffix  xs:string  optional      
documentation
Specify the default suffix for the alias keys

attribute AliasDefinitionsXML/@defaultKeyPrefix
annotation
documentation
Specify the default prefix for the alias keys

attribute AliasDefinitionsXML/@defaultKeySuffix
annotation
documentation
Specify the default suffix for the alias keys

element AliasDefinitionsXML/alias
diagram openDA_diagrams/openDA_p271.png
attributes
Name  Type  Use  Default  Fixed  Annotation
key  xs:string  required      
documentation
The alias key name
value  xs:string  optional      
documentation
Actual value referred to by the alias key
keyPrefix  xs:string  optional      
documentation
Specify the prefix for the alias key
keySuffix  xs:string  optional      
documentation
Specify the suffix for the alias key
annotation
documentation
Create list of aliases containing keys and (optional) the corresponding values

complexType AliasDefinitionXML
diagram openDA_diagrams/openDA_p272.png
attributes
Name  Type  Use  Default  Fixed  Annotation
key  xs:string  required      
documentation
The alias key name
value  xs:string  optional      
documentation
Actual value referred to by the alias key
keyPrefix  xs:string  optional      
documentation
Specify the prefix for the alias key
keySuffix  xs:string  optional      
documentation
Specify the suffix for the alias key

attribute AliasDefinitionXML/@key
annotation
documentation
The alias key name

attribute AliasDefinitionXML/@value
annotation
documentation
Actual value referred to by the alias key

attribute AliasDefinitionXML/@keyPrefix
annotation
documentation
Specify the prefix for the alias key

attribute AliasDefinitionXML/@keySuffix
annotation
documentation
Specify the suffix for the alias key

element AliasDefinitionXML/listValue
diagram openDA_diagrams/openDA_p273.png
annotation
documentation
This type of alias can only be used for BBAction arguments, where the argument must be specified by means of only naming the 'list value' alias. If the listValue element is present, it overrules the value attribute, indicating that the actual value is in fact a list of string arguments instead of one argument.

complexType BlackBoxWrapperConfigXML
diagram openDA_diagrams/openDA_p274.png

element BlackBoxWrapperConfigXML/aliasDefinitions
diagram openDA_diagrams/openDA_p275.png
attributes
Name  Type  Use  Default  Fixed  Annotation
defaultKeyPrefix  xs:string  optional      
documentation
Specify the default prefix for the alias keys
defaultKeySuffix  xs:string  optional      
documentation
Specify the default suffix for the alias keys
annotation
documentation
Define aliases for specific model information (directory names, file names etc.). Specify the prefix and suffix for the alias keys.

element BlackBoxWrapperConfigXML/run
diagram openDA_diagrams/openDA_p276.png
annotation
documentation
Specify the initialize, compute and finalize actions that direct the model

element BlackBoxWrapperConfigXML/inputOutput
diagram openDA_diagrams/openDA_p277.png
annotation
documentation
Specify the list of input/output objects

complexType BlackBoxWrapperRunXML
diagram openDA_diagrams/openDA_p278.png

element BlackBoxWrapperRunXML/initializeActions
diagram openDA_diagrams/openDA_p279.png
annotation
documentation
Generic method of initialization actions

element BlackBoxWrapperRunXML/initializeActionsUsingDirClone
diagram openDA_diagrams/openDA_p280.png
attributes
Name  Type  Use  Default  Fixed  Annotation
templateDir  xs:string        
documentation
Directory where the template files are stored
instanceDir  xs:string        
documentation
The working directory where the template directory will be copied into
annotation
documentation
The directory, in which the model executables and input files are located, will be copied to a new working directory. The actions are executed in this new working directory.

element BlackBoxWrapperRunXML/initializeActionsUsingFileClone
diagram openDA_diagrams/openDA_p281.png
attributes
Name  Type  Use  Default  Fixed  Annotation
templateFile  xs:string        
documentation
Name of the template file.
instanceFile  xs:string        
documentation
File name of the instance of the template file.
annotation
documentation
Some of the model files (template) will be copied to the working directory where the actions will be executed

element BlackBoxWrapperRunXML/computeActions
diagram openDA_diagrams/openDA_p282.png
annotation
documentation
Configure the method for model computation

element BlackBoxWrapperRunXML/additionalComputeActions
diagram openDA_diagrams/openDA_p283.png
annotation
documentation
Configure the actions that should be performed after all other computation actions (used for instance when the actual computation is sent to a queue. The additional computation action can then be used to start a script that checks the status of the queue.

element BlackBoxWrapperRunXML/finalizeActions
diagram openDA_diagrams/openDA_p284.png
annotation
documentation
Configure the method for model finalization

complexType CheckOutputXML
diagram openDA_diagrams/openDA_p285.png
attributes
Name  Type  Use  Default  Fixed  Annotation
file  xs:string  required      
documentation
Name of output file
expect  xs:string  optional      
documentation
Expected content of the output file when the action is successful

attribute CheckOutputXML/@file
annotation
documentation
Name of output file

attribute CheckOutputXML/@expect
annotation
documentation
Expected content of the output file when the action is successful

complexType CheckReturnStatusXML
diagram openDA_diagrams/openDA_p286.png
attributes
Name  Type  Use  Default  Fixed  Annotation
expect  xs:string  required      
documentation
Expected return value when the action is successful

attribute CheckReturnStatusXML/@expect
annotation
documentation
Expected return value when the action is successful

complexType CloneDirXML
diagram openDA_diagrams/openDA_p287.png
attributes
Name  Type  Use  Default  Fixed  Annotation
templateDir  xs:string  required      

attribute CloneDirXML/@templateDir

complexType CloneFileXML
diagram openDA_diagrams/openDA_p288.png
attributes
Name  Type  Use  Default  Fixed  Annotation
templateFile  xs:string  required      

attribute CloneFileXML/@templateFile

complexType InitialActionsDirCloneXML
diagram openDA_diagrams/openDA_p289.png
attributes
Name  Type  Use  Default  Fixed  Annotation
templateDir  xs:string        
documentation
Directory where the template files are stored
instanceDir  xs:string        
documentation
The working directory where the template directory will be copied into

attribute InitialActionsDirCloneXML/@templateDir
annotation
documentation
Directory where the template files are stored

attribute InitialActionsDirCloneXML/@instanceDir
annotation
documentation
The working directory where the template directory will be copied into

element InitialActionsDirCloneXML/action
diagram openDA_diagrams/openDA_p290.png
attributes
Name  Type  Use  Default  Fixed  Annotation
exe  xs:string  optional      
documentation
Name and path of the executable file
windowsExe  xs:string  optional      
documentation
Name and path of the executable file for Windows operating system
linuxExe  xs:string  optional      
documentation
Name and path of the executable file for Linux operating system
macExe  xs:string  optional      
documentation
Name and path of the executable file for Mac operating system
className  xs:string  optional      
documentation
The openda:class name.
workingDirectory  xs:string  optional      
documentation
Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig.
actualWorkingDirectory  xs:string  optional      
documentation
Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory.
ignoreStatus  xs:boolean  optional  false    
documentation
Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.
annotation
documentation
Specify the consecutive actions  by model executables or classes to run, arguments to supply and fail/success checks to perform

complexType InitialActionsFileCloneXML
diagram openDA_diagrams/openDA_p291.png
attributes
Name  Type  Use  Default  Fixed  Annotation
templateFile  xs:string        
documentation
Name of the template file.
instanceFile  xs:string        
documentation
File name of the instance of the template file.

attribute InitialActionsFileCloneXML/@templateFile
annotation
documentation
Name of the template file.

attribute InitialActionsFileCloneXML/@instanceFile
annotation
documentation
File name of the instance of the template file.

element InitialActionsFileCloneXML/action
diagram openDA_diagrams/openDA_p292.png
attributes
Name  Type  Use  Default  Fixed  Annotation
exe  xs:string  optional      
documentation
Name and path of the executable file
windowsExe  xs:string  optional      
documentation
Name and path of the executable file for Windows operating system
linuxExe  xs:string  optional      
documentation
Name and path of the executable file for Linux operating system
macExe  xs:string  optional      
documentation
Name and path of the executable file for Mac operating system
className  xs:string  optional      
documentation
The openda:class name.
workingDirectory  xs:string  optional      
documentation
Directory where executable file is run. This is usually the instance dir. This is only used in blackBoxStochModelConfig.
actualWorkingDirectory  xs:string  optional      
documentation
Subdirectory of instance dir, where executable file has to be run. To be specified as relative path to instance dir. This is only used in blackBoxWrapperConfig. This is only used for executable files, not for Java classes. For Java classes the instanceDir is used as workingDirectory.
ignoreStatus  xs:boolean  optional  false    
documentation
Flag for ignoring the status of the previous action step (ignoreStatus=true). Not yet implemented.
annotation
documentation
Specify the consecutive actions  by model executables or classes to run, arguments to supply and fail/success checks to perform

complexType InputOutputXML
diagram openDA_diagrams/openDA_p293.png

element InputOutputXML/ioObject
diagram openDA_diagrams/openDA_p294.png
attributes
Name  Type  Use  Default  Fixed  Annotation
className  xs:string  required      
documentation
The openda:class name of the input/output object
annotation
documentation
Specify the input/output object

complexType IoObjectXML
diagram openDA_diagrams/openDA_p295.png
attributes
Name  Type  Use  Default  Fixed  Annotation
className  xs:string  required      
documentation
The openda:class name of the input/output object

attribute IoObjectXML/@className
annotation
documentation
The openda:class name of the input/output object

element IoObjectXML/file
diagram openDA_diagrams/openDA_p296.png
annotation
documentation
Name of input/output file

element IoObjectXML/id
diagram openDA_diagrams/openDA_p297.png
annotation
documentation
Identity of the input/output object

element IoObjectXML/arg
diagram openDA_diagrams/openDA_p298.png
annotation
documentation
Input argument for the corresponding openda:class

complexType IndicesXML
diagram openDA_diagrams/openDA_p299.png
attributes
Name  Type  Use  Default  Fixed  Annotation
index1  openda:indexStringType  required      
documentation
Indices of the selected array elements of the first dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index2  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the second dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
index3  openda:indexStringType  optional      
documentation
Indices of the selected array elements of the third dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.
base  xs:int  optional  0    
documentation
Base number, which gives the index of the vector's first element (sometimes 1 instead of 0)

attribute IndicesXML/@index1
annotation
documentation
Indices of the selected array elements of the first dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.

attribute IndicesXML/@index2
annotation
documentation
Indices of the selected array elements of the second dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.

attribute IndicesXML/@index3
annotation
documentation
Indices of the selected array elements of the third dimension. Format:  "ind1" (single index)," ind1:" (from ind1 up to the last index), ":ind1" (from the first index up to ind1), "ind1:ind2" (from ind1 up to ind2). Example: 8, :4, 19:, 7:12.

attribute IndicesXML/@base
annotation
documentation
Base number, which gives the index of the vector's first element (sometimes 1 instead of 0)

complexType SubArrayXML
diagram openDA_diagrams/openDA_p300.png
attributes
Name  Type  Use  Default  Fixed  Annotation
sourceArray  xs:string  required      
index1  openda:indexStringType  required      
index2  openda:indexStringType  optional      
index3  openda:indexStringType  optional      

attribute SubArrayXML/@sourceArray

attribute SubArrayXML/@index1

attribute SubArrayXML/@index2

attribute SubArrayXML/@index3

complexType VariableXML
diagram openDA_diagrams/openDA_p301.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      

attribute VariableXML/@id

simpleType indexStringType
annotation
documentation
index (e.g. 12) or index line (e.g. 11:18) in an array


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