ReportConfig¶

class ReportConfig¶

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:

ReportConfig

GetMaxSpots()¶

Get how many spots or ranges will be reported.

Returns:

Number of spots or ranges to be reported

Return type:

int

GetMinDelta()¶

Get the minimum duration between reported spots or ranges.

Returns:

Minimum duration between reported spots or ranges

Return type:

float

GetResultDetailsVariable()¶

Get the name of the package variable result details will be written to.

Returns:

Name of the result details variable. None if not set.

Return type:

str

SetMaxSpots(maxSpots)¶

Sets how many spots or ranges will be reported.

Parameters:

maxSpots : int¶

Number of spots or ranges to be reported (defaults to 100)

SetMinDelta(minDelta)¶

Sets the minimum duration between reported spots or ranges.

Parameters:

minDelta : float¶

Minimum duration between reported spots or ranges (defaults to 0.0)

SetResultDetailsVariable(varName)¶

Sets the name of the package variable result details will be written to.

Parameters:

varName : str¶

Name of the result details variable. None to set no variable.