Schema blackBoxModelConfig.xsd


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

complexType AliasValuesXML
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p2.png

element AliasValuesXML/alias
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p3.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p4.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p5.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p6.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p7.png
annotation
documentation
Specify the configuration filename

element BlackBoxConfigurableXML/configString
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p8.png
annotation
documentation
Specify the configuration string

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

complexType BlackBoxIoSubVectorXML
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p10.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p11.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p12.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p13.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p14.png

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

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

element BlackBoxModelConfigXML/timeInfo
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p17.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p18.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p19.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p20.png
annotation
documentation
Specify whether to remove unnecessary files upon completion of a model run (boolean, optional)

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

element BlackBoxModelConfigXML/restartInfo
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p22.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p23.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p24.png
annotation
documentation
Specify the file name(s) containing the model state

complexType BlackBoxWrapperConfigReferenceXML
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p25.png

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

complexType ExchangeItemXML
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p27.png

element ExchangeItemXML/vector
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p28.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p29.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p30.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p31.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p32.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p33.png

element ActionsXML/action
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p34.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p35.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p36.png
annotation
documentation
Specify list of  input arguments of the model executable

element ActionXML/checkOutput
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p37.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p38.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p39.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p40.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p41.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p42.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p43.png

element BlackBoxWrapperConfigXML/aliasDefinitions
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p44.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p45.png
annotation
documentation
Specify the initialize, compute and finalize actions that direct the model

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

complexType BlackBoxWrapperRunXML
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p47.png

element BlackBoxWrapperRunXML/initializeActions
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p48.png
annotation
documentation
Generic method of initialization actions

element BlackBoxWrapperRunXML/initializeActionsUsingDirClone
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p49.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p50.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p51.png
annotation
documentation
Configure the method for model computation

element BlackBoxWrapperRunXML/additionalComputeActions
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p52.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p53.png
annotation
documentation
Configure the method for model finalization

complexType CheckOutputXML
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p54.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p55.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p56.png
attributes
Name  Type  Use  Default  Fixed  Annotation
templateDir  xs:string  required      

attribute CloneDirXML/@templateDir

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

attribute CloneFileXML/@templateFile

complexType InitialActionsDirCloneXML
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p58.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p59.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p60.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p61.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p62.png

element InputOutputXML/ioObject
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p63.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p64.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p65.png
annotation
documentation
Name of input/output file

element IoObjectXML/id
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p66.png
annotation
documentation
Identity of the input/output object

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

complexType IndicesXML
diagram blackBoxModelConfig_diagrams/blackBoxModelConfig_p68.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p69.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 blackBoxModelConfig_diagrams/blackBoxModelConfig_p70.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