dSPACE: ModelDesk¶

Vendor information

Vendor	Web page	Product name	Version
dSPACE	http://www.dspace.com	ModelDesk	dSPACE Release 2014A - 2025B

Operating system	Support
Windows	✓
Linux	✓

Ports¶

Port ENVSIM

Specifics¶

ENVSIM port¶

The ENVSIM port only supports the display of parameters and aliases in the scenario tree and the reading and writing of those parameters and aliases. Parameters for ParameterSets can still only be accessed via tool jobs.

In order to be able to read and write parameters/aliases, the corresponding scenario must be loaded with a Load element step before the respective read or write steps. After a write step, the “DownloadScenario”/”DownloadRoad” tool job must be executed, analogous to the procedure for the “WriteParameter” tool job, so that the written parameters are loaded in the simulation platform.

Properties 🛈¶

Name	Default value	Type	Description
Project directory		uri	Base directory for searching ModelDesk project files (*.cdp) on the tool host (absolute or relative to the base path of the tool host)
ModelDesk project	Use prior deployed project.	uri	ModelDesk project (*.cdp) to load (relative to the project directory or absolute path)
ModelDesk experiment	‘Use prior deployed experiment.’	string	Name of the ModelDesk experiment in the specified ModelDesk project to activate.
Exit tool	☐	bool	Closes ModelDesk
“Maneuver Compatibility” mode is activated	☐	bool	Flag to indicate that “Maneuver Compatibility” mode is enabled in the selected project. This mode is only available in dSPACE releases 2018A - 2019B. In other versions, this flag is ignored.
Timeout for tool call ❲in sec.❳	‘600’	string	Timeout after which a tool call is aborted.

Jobs 🛈¶

ActivateRoad¶

Activates the specified road.

CAUTION: The active experiment is saved by the execution of this job.

Parameter

Name	Available if	Default value	Valid values	Type	Description
Road				string	Name of the road

ActivateScenario¶

Activates the specified scenario.

CAUTION: The active experiment is saved by the execution of this job.

Parameter

Name	Available if	Default value	Valid values	Type	Description
Scenario				string	Name of the scenario

DownloadManeuver¶

Saves, activates and loads the specified maneuver onto the simulation platform.

Available only up to version 2017B and in 2018A -2019B with “Maneuver Compatibility” enabled. To use the “Maneuver Compatibility” mode, it must be activated in ModelDesk and in the test bench configuration.

ATTENTION: The active experiment is saved by executing this job.

ATTENTION: The return value does not allow any conclusions about the success.

Parameter

Name	Available if	Default value	Valid values	Type	Description
Maneuver		‘keep unchanged’		string	Name of the maneuver

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

DownloadParameterSet¶

Stores, activates, and loads the specified parameter set on the simulation platform.

Note: The active experiment is stored through the execution of this job.

Returns True if successful.

ATTENTION: In some cases the result can also be None. None does not mean that an error occurred, but that the result of the job cannot be determined.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ParameterSet		‘keep unchanged’		string	Name of the parameter set

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

DownloadRoad¶

Activates and loads the specified road to the simulation platform.

CAUTION: The active experiment might be saved by the execution of this job.

Returns true if successful.

ATTENTION: In some cases the result can also be None. None does not mean that an error occurred, but that the result of the job cannot be determined.

Parameter

Name	Available if	Default value	Valid values	Type	Description
Force		True	[False, True]	bool	When this option is enabled, the road will always be downloaded; otherwise, it will only be downloaded if necessary (e.g. when changes have been made).
Road		‘keep unchanged’		string	Name of the road

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

DownloadScenario¶

Activates and Downloads the selected Scenario to the simulation platform.

Using the parameter DownloadSelection, you can select the part of the simulation platform that should be loaded.

This tool job is only available from version 2018A.

ATTENTION: By running this tool job the active experiment might be saved.

Returns True if the tool job execution is successful.

Parameter

Name	Default value	Valid values	Type	Description
DownloadSelection	0		int	Selection of the scenario content that is downloaded to the simulation platform. 0 - All 1 - only Maneuver 2 - only Traffic
Force	True	[False, True]	bool	When this option is enabled, the scenario will always be downloaded; otherwise, it will only be downloaded if necessary (e.g. when changes have been made).
Scenario	‘keep unchanged’		string	Name of the scenario

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

DownloadTrafficScenario¶

Save, activates and Downloads the selected TrafficScenario to the simulation platform.

This tool job is only available till version 2017B.

ATTENTION: By running this tool job the active experiment will be saved.

Returns True if the tool job execution is successful.

ATTENTION: In some cases the result can also be None. None does not mean that an error occurred, but that the result of the job cannot be determined.

Parameter

Name	Available if	Default value	Valid values	Type	Description
TrafficScenario		‘keep unchanged’		string	Name of the traffic scenario

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

GetAliases¶

Returns all aliases for the given context.

Parameter

Name	Available if	Default value	Valid values	Type	Description
AliasContext		‘Road’	[‘Road’, ‘Maneuver’, ‘Traffic’]	string	Context for the aliases

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	List of alias names

GetManeuverPool¶

Returns a list of the maneuvers stored in the pool of the active project.

Only available up to version 2017B and in 2018A -2019B with “Maneuver Compatibility” enabled. To use the “Maneuver Compatibility” mode, it must be activated in ModelDesk and in the test bench configuration.

GetParameterSetPool¶

Returns a list of the parameter sets stored in the pool of the active project

GetRoadPool¶

Returns a list of roads, which are deposited in the pool of the active project

GetScenarioPool¶

Returns a list of the scenarios stored in the pool of the active project.

Only available from version 2018A.

GetTrafficPool¶

Returns a list of the TrafficScenarios stored in the pool of the active project.

Only available up to version 2017B.

Import¶

Imports the given file (xml or zip file) in the project pool. CAUTION: Using this job, the ModelDesk project is saved.

Parameter

Name	Available if	Default value	Valid values	Type	Description
filename				string	Filename

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

ReadAlias¶

Reads all associated values for an alias.

Each alias is associated with one or more references. Each reference has its own value.

Parameter

Name	Available if	Default value	Valid values	Type	Description
AliasContext		‘Road’	[‘Road’, ‘Maneuver’, ‘Traffic’]	string	Context for the aliases
AliasName				string	Name of the alias

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	List of tuples with reference name and read value

ReadParameter¶

Executes an arbitrary API path given as string and returns its result. Root element of the path is the active experiment.

Example call:

ApiPath: ‘Road.Roads.Item(0).Length’

-> Returns length of the first active road.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ApiPath				string	API command path

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object

ReloadActiveProject¶

Closes the currently opened project and reopens it.

Parameter

Name	Available if	Default value	Valid values	Type	Description
SaveProject		True	[False, True]	bool	If set, the previously loaded project will be saved before it is opened again.

ResetManeuver¶

Resets the model.

Returns True if successful.

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

StartManeuver¶

Starts the maneuver.

Returns True if successful.

Parameter

Name	Available if	Default value	Valid values	Type	Description
DownloadExperimentElements		True	[False, True]	bool	Loads the elements selected in the active experiment, such as road, scenario, and parameter set.

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

StopManeuver¶

Stops the maneuver.

Returns True if successful.

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

WriteAlias¶

Writes the given value for the alias and thus for all associated references.

Parameter

Name	Default value	Valid values	Type	Description
AliasContext	‘Road’	[‘Road’, ‘Maneuver’, ‘Traffic’]	string	Context for the aliases
AliasName			string	Name of the alias
AliasValue			object	Value to be written

WriteParameter¶

Executes an arbitrary API path given as string and, writes a given value and returns its new result. Root element of the path is the active experiment.

Example call:

ApiPath: ‘Road.Roads.Item(0).StartParameter.x’

Value: 20

-> Sets the x-coordinate of the start point of the first active road to value 20.

CAUTION: The written change is only transferred to the simulation by a new download of the parameter set/maneuver/road/traffic scenario.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ApiPath				string	API command path
Value				object	Value

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object