EnvSimData¶

class EnvSimData¶

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:

A copy of this object

Return type:

EnvSimData

GetDataSource()¶

Returns the data source.

Returns:

data source: 0 online query, 1 offline file

Return type:

int

GetName()¶

Returns the name of the enviroment simulation.

Returns:

Name of the environment simulation

Return type:

str

GetOfflineFile()¶

Returns the offline file.

Returns:

offline file

Return type:

str

GetPort()¶

Returns the enviroment simulation port.

Returns:

environment simulation port

Return type:

str

Rename(newEnvironmentSimulationKey)¶

Renames the model.

Parameters:

newEnvironmentSimulationKey : str¶

New name of the environment simulation

SetDataSource(dataSource)¶

Set the data source to switch between online query and offline file.

Parameters:

dataSource : int¶

data source: 0 online query, 1 offline file

SetOfflineFile(offlineFile)¶

Sets the offline file.

Parameters:

offlineFile : str¶

offline file to be set

SetPort(port)¶

Sets the enviroment simulation port.

Parameters:

port : str¶

environment simulation port to be set