Model¶

class Model¶

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:

Model

GetAdditionalFiles()¶

Gets additional files configured for this model.

Returns:

The list of additional files

Return type:

list[str]

GetFile()¶

Returns the model file.

Returns:

Model file

Return type:

str

GetImportSource()¶

Returns the model import source.

Returns:

Model import source: 0 Automatically, 1 From Cache, 2 Disabled

Return type:

int

GetName()¶

Returns the name of the model.

Returns:

Name of the model

Return type:

str

GetPort()¶

Returns the model port.

Returns:

Model port

Return type:

str

InsertAdditionalFile(filename, index=None)¶

Adds an entry on the given index into the additional files list.

Some model tools allow e.g. *.par or *.smf files to be specified here.

Parameters:

filename : str¶

The name of the file to be added

index : int¶

The index the new entry should be placed at. If left out, the filename will be appended at the end of the list.

RemoveAdditionalFile(index)¶

Removes the entry on the given index from additional files list.

Parameters:

index : int¶

The index to be removed.

Rename(newModelKey)¶

Renames the model.

Parameters:

newModelKey : str¶

New name of the model

SetFile(modelFile)¶

Sets the model file.

Parameters:

modelFile : str¶

Model file to be set

SetImportSource(importSource)¶

Sets the model import source.

Parameters:

importSource : int¶

Model import source: 0 Automatically, 1 From Cache, 2 Disabled

SetPort(modelPort)¶

Sets the model port.

Parameters:

modelPort : str¶

Model port to be set