ParameterSetRecordings¶

class ParameterSetRecordings¶

AddRecordingInfos(recordingGroupName, recordingInfos)¶

Adds a recording info item to a specified recording group in the parameter set.

Parameters:

recordingGroupName : str¶

Name of the recording group to add the recording item

recordingInfos¶

The recording items to be added

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:

ParameterSetRecordings

GetRecordingInfos(recordingGroupName=None)¶

Returns recording information of the parameter set. If a recording group name is given returns only those items of the group

Parameters:

recordingGroupName : str¶

Name of the recording group to return the info items of

Returns:

recording info items

Return type:

list[RecordingInfo]

RemoveRecordingInfoByIndex(groupName, infoIndex)¶

Removes a recording info item from the parameter set by recording group name and recording info index.

Parameters:

groupName : str¶

Recording group name

infoIndex : integer¶

Index of the recording info item in the recording group to be removed

Raise:

ApiError: - When there is no group matching the given name - When the recording info index is out of range