SyncExpectation¶
- class SyncExpectation¶
- 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:
- GetEventType()¶
Returns the event type of the signal.
- Returns:
The event type (“RAW” or “PHY”).
- Return type:
string
- GetExpectationExpression()¶
Returns the expectation expression as text.
- Returns:
The expectation expression
- Return type:
str
- GetExpectationParameters()¶
Returns the parameters of the numeric expectation expression as dictionary.
- Returns:
Dictionary with keys ‘relation’, ‘value’, ‘toleranceType’, ‘toleranceValue’
- Return type:
dict[str, str]
- GetSignalName()¶
Returns the signal name of the signal that should be evaluated.
- Returns:
The signal name
- Return type:
str
- SetEventType(eventType)¶
Set the event type of the signal.
- Parameters:
- eventType : string¶
“RAW” or “PHY”
-
SetExpectationParameters(relation, value, toleranceType=
None, toleranceValue=None)¶ Sets the parameters of the numeric expectation expression. The parameters toleranceType and toleranceValue can be passed if relation is ‘==’.
- Parameters:
- relation : str¶
The relation between the signal value and the expected value. One of: ‘<’, ‘<=’, ‘==’, ‘>=’, ‘>’, ‘!=’, ‘<>’
- value : str¶
The expected value as expression
- toleranceType : str¶
Optional, must be ‘none’ if relation is not ‘==’. Flag for the tolerance. One of: - ‘none’ (no tolerance) - ‘absolute’ (absolute) - ‘percentage’ (relative in percent) - ‘fractional digits’
- toleranceValue : str¶
Optional. The tolerance value as expression if a tolerance is used.
- SetSignalName(signalName)¶
Sets the signal name of the signal that should be evaluated.
- Parameters:
- signalName : str¶
The signal name