PlotSubConfig¶
- class PlotSubConfig¶
- 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:
- GetCondition()¶
Returns the condition that must be matched to create a plot. Possible return values are ‘NONE’, ‘SUCCESS’, ‘INCONCLUSIVE’, ‘FAILED’, ‘NEVER’. For plot creation the verdict of the plot’s parent must be equal to or worse than this setting. For instance ‘NONE’ means that the plot is always created whereas the setting ‘FAILED’ causes its creation only if the plot’s parent runs FAILED or ERROR.
- Returns:
The plot condition
- Return type:
str
- GetExpandXLimitsLeft()¶
Returns the expand value of the left limit as expression. The expand value will be added to automatically determined view limits of the plot.
- Returns:
The expression for the expand value of the left limit
- Return type:
str
- GetExpandXLimitsRight()¶
Returns the expand value of the right limit as expression. The expand value will be added to automatically determined view limits of the plot.
- Returns:
The expression for expand value of the right limit
- Return type:
str
- GetMaxNumberPlots()¶
Returns the maximum number of plots to be created. This number is counted for the entire execution so trigger ranges will not reset the count.
- Returns:
The maximum number of plots as expression
- Return type:
str
- SetCondition(condition)¶
Sets the condition that must be matched to create a plot. Possible parameter values are ‘ALWAYS’, ‘SUCCESS’, ‘INCONCLUSIVE’, ‘FAILED’, ‘NEVER’. For plot creation the verdict of the plot’s parent must be equal to or worse than this setting. For instance ‘ALWAYS’ means that the plot is always created whereas the setting ‘FAILED’ causes its creation only if the plot’s parent runs FAILED or ERROR.
- Parameters:
- condition : str¶
The plot condition
- SetExpandXLimitsLeft(expandXLimitsLeft)¶
Sets the expand value of the left limit as expression. The expand value will be added to automatically determined view limits of the plot. An overview plot ignores this setting entirely.
- Parameters:
- expandXLimitsLeft : str¶
The expression for the expand value of the left limit
- SetExpandXLimitsRight(expandXLimitsRight)¶
Sets the expand value of the left limit as expression. The expand value will be added to automatically determined view limits of the plot. An overview plot ignores this setting entirely.
- Parameters:
- expandXLimitsRight : str¶
The expression for the expand value of the right limit
- SetMaxNumberPlots(maxNumberPlots)¶
Sets the maximum number of plots to be created. This number is counted for the entire execution so trigger ranges will not reset the count. An overview plot ignores this setting entirely.
- Parameters:
- maxNumberPlots : str¶
The maximum number of plots as expression