Schema blackBoxStochModelConfig.xsd


element blackBoxStochModel

diagram

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

element BlackBoxModelConfigReferenceXML/config

diagram
annotation	documentation Specify black box model configuration directly in the blackBoxModelConfig format

element BlackBoxModelConfigReferenceXML/file

diagram
annotation	documentation Specify filename of the black box model configuration file. File format: blackBoxModelConfig

complexType BlackBoxStochModelConfigXML

diagram

element BlackBoxStochModelConfigXML/modelConfig

diagram
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
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
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
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
annotation	documentation Specify external forcings, being either boundaries, noise on boundaries or boundaries including noise.

element BlackBoxStochModelConfigXML/vectorSpecification

diagram
annotation	documentation Define stochastic model by specifying the vectors of parameters, state, and/or predictor

element BlackBoxStochModelConfigXML/restartInfo

diagram
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

element BlackBoxStochModelParametersXML/uncertaintyModule

diagram
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
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
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

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

element BlackBoxStochModelStateXML/noiseModel

diagram
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
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
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
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
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
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

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

element BlackBoxStochModelVectorSpecificationXML/parameters

diagram
annotation	documentation Specify the model parameters vectors

element BlackBoxStochModelVectorSpecificationXML/state

diagram
annotation	documentation Specify the model state vectors

element BlackBoxStochModelVectorSpecificationXML/predictor

diagram
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
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
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
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
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

element BoundaryDataObjectXML/className

diagram
annotation	documentation The openda class name of the forcing's data object.

element BoundaryDataObjectXML/file

diagram
annotation	documentation Name of the forcing's data file.

element BoundaryDataObjectXML/arg

diagram
annotation	documentation Input argument(s) for the corresponding openda:class

complexType BoundaryExchangeItemXML

diagram
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

element BoundaryMappingXML/operation

diagram
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
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

element BoundaryProviderXML/dataObject

diagram
annotation	documentation The data object containing the forcing data.

element BoundaryProviderXML/boundaryMapping

diagram
annotation	documentation Specify the operation when imposing the forcing ExchangeItems on the model ExchangeItems.

complexType CartesianToPolarXML

diagram

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
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
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
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

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
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
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
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
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

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
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
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
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
annotation	documentation Decorrelation time.

element StateNoiseAr1ModelXML/noiseModelPeriod

diagram

complexType StateNoiseArmaModelXML

diagram
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
attributes	Name   Type   Use   Default   Fixed   Annotation value   xs:double   required         documentation The standard deviation value

element StateNoiseArmaModelXML/armaConstant

diagram
annotation	documentation ARMA constants, which reflects temporal correlation per timestep of the ARMA model.

complexType StateNoiseUncertainItemWithArmaConstantsXML

diagram
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
annotation	documentation ARMA constants, which reflects temporal correlation per timestep of the ARMA model.

complexType StateNoiseUncertainItemXML

diagram
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

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
annotation	documentation Specify name of xml file containing configuration of the noise model. File format depends on class.

element StateNoiseXML/exchangeItems

diagram
annotation	documentation The relations between the noise model's  exchange items and the model's exchange items

element StateNoiseXML/vector

diagram
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
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
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
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
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
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
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
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
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

element UncertaintyOrNoiseExchangeItemsXML/exchangeItem

diagram
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. stateSizeNoiseSizeRatio   xs:integer   optional   1      documentation Integer ratio between the size of the model state and the noise model state (1 noise model value will be applied to "stateSizeNoiseSizeRatio" model values) addStateNoiseAfterCompute   xs:boolean   optional   false      documentation When true, state noise will be added after compute instead of before
annotation	documentation The list of relations

complexType UncertaintyOrNoiseExchangeItemXML

diagram

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. stateSizeNoiseSizeRatio   xs:integer   optional   1      documentation Integer ratio between the size of the model state and the noise model state (1 noise model value will be applied to "stateSizeNoiseSizeRatio" model values) addStateNoiseAfterCompute   xs:boolean   optional   false      documentation When true, state noise will be added after compute instead of before

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.

attribute UncertaintyOrNoiseExchangeItemXML/@stateSizeNoiseSizeRatio

annotation

documentation Integer ratio between the size of the model state and the noise model state (1 noise model value will be applied to "stateSizeNoiseSizeRatio" model values)

attribute UncertaintyOrNoiseExchangeItemXML/@addStateNoiseAfterCompute

annotation

documentation When true, state noise will be added after compute instead of before

element UncertaintyOrNoiseExchangeItemXML/modelExchangeItem

diagram
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
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
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
annotation	documentation Specify name of xml file containing configuration of the noise model. File format depends on class.

element UncertaintyOrNoiseXML/arg

diagram
annotation	documentation Specify list of input arguments for the noise model

element UncertaintyOrNoiseXML/exchangeItems

diagram
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 blackBoxModelConfig

diagram
annotation	documentation Configuration for a black box model. Here the reference to a specific model configuration is made.

complexType AliasValuesXML

diagram

element AliasValuesXML/alias

diagram
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
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
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
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
annotation	documentation Specify the configuration filename

element BlackBoxConfigurableXML/configString

diagram
annotation	documentation Specify the configuration string

element BlackBoxConfigurableXML/arg

diagram
annotation	documentation Specify the input argument of this openda:class

complexType BlackBoxIoSubVectorXML

diagram

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
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
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

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

element BlackBoxModelConfigXML/wrapperConfig

diagram
annotation	documentation Specify black box wrapper configuration that addresses the deterministic model

element BlackBoxModelConfigXML/aliasValues

diagram
annotation	documentation Specify the actual values referred to by the alias keys defined in the black box wrapper configuration

element BlackBoxModelConfigXML/instanceNumberFormat

diagram

element BlackBoxModelConfigXML/timeInfo

diagram
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
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
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
annotation	documentation Specify whether to remove unnecessary files upon completion of a model run (boolean, optional)

element BlackBoxModelConfigXML/skipModelActionsIfInstanceDirExists

diagram
annotation	documentation If set to true, no actions are executed on a model instance that already exists (boolean, optional)

element BlackBoxModelConfigXML/restartInfo

diagram
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
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
annotation	documentation Specify the file name(s) containing the model state

complexType BlackBoxWrapperConfigReferenceXML

diagram

element BlackBoxWrapperConfigReferenceXML/file

diagram
annotation	documentation Specify the name of the black box wrapper configuration file, relative to local directory. File format: blackBoxWrapperConfig

complexType ExchangeItemXML

diagram

element ExchangeItemXML/vector

diagram
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
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

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
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

---

simpleType InstanceNumberFormatXML

annotation

documentation Specify the format for the numbering of the instance directories. Default is 0: number according the number of digits needed per instance (work0, work112, etc). 00: work02, work07, etcetera, 000: work003, work017, etc.

element blackBoxWrapperConfig

diagram
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

element ActionsXML/action

diagram
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

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
annotation	documentation Specify list of  input arguments of the model executable

element ActionXML/checkOutput

diagram
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
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
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
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
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
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

element BlackBoxWrapperConfigXML/aliasDefinitions

diagram
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
annotation	documentation Specify the initialize, compute and finalize actions that direct the model

element BlackBoxWrapperConfigXML/inputOutput

diagram
annotation	documentation Specify the list of input/output objects

complexType BlackBoxWrapperRunXML

diagram

element BlackBoxWrapperRunXML/initializeActions

diagram
annotation	documentation Generic method of initialization actions

element BlackBoxWrapperRunXML/initializeActionsUsingDirClone

diagram
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
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
annotation	documentation Configure the method for model computation

element BlackBoxWrapperRunXML/additionalComputeActions

diagram
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
annotation	documentation Configure the method for model finalization

complexType CheckOutputXML

diagram
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
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
attributes	Name   Type   Use   Default   Fixed   Annotation templateDir   xs:string   required

attribute CloneDirXML/@templateDir

---

complexType CloneFileXML

diagram
attributes	Name   Type   Use   Default   Fixed   Annotation templateFile   xs:string   required

attribute CloneFileXML/@templateFile

---

complexType InitialActionsDirCloneXML

diagram
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
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
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
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

element InputOutputXML/ioObject

diagram
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
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
annotation	documentation Name of input/output file

element IoObjectXML/id

diagram
annotation	documentation Identity of the input/output object

element IoObjectXML/arg

diagram
annotation	documentation Input argument for the corresponding openda:class

complexType IndicesXML

diagram

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
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
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